您可以使用 IntelliJ 原生导入器 或 Eclipse Buildship 在 IDE 中打开此示例。 |
本指南演示了如何使用 gradle init
使用 Gradle 创建 C++ 库。您可以按照指南逐步操作从头开始创建新项目,也可以使用上面的链接下载完整的示例项目。
C++ 库插件与 配置缓存 不兼容。 |
您将构建什么
您将生成一个遵循 Gradle 约定的 C++ 库。
您需要什么
-
文本编辑器或 IDE - 例如 IntelliJ IDEA
-
Java 开发工具包 (JDK),版本 8 或更高版本 - 例如 AdoptOpenJDK
-
最新 Gradle 发行版
-
已安装的 C++ 编译器。查看 Gradle 支持的 C++ 工具链。
创建项目文件夹
Gradle 带有一个内置的任务,称为 init
,它在空文件夹中初始化一个新的 Gradle 项目。init
任务使用(也是内置的)wrapper
任务来创建一个 Gradle 包装器脚本,gradlew
。
第一步是为新项目创建一个文件夹,并更改到该文件夹。
$ mkdir demo $ cd demo
运行 init 任务
在新的项目目录中,使用以下命令在终端中运行 init
任务:gradle init
。当提示时,选择 2: library
项目类型和 5: C++
作为实现语言。接下来,您可以选择用于编写构建脚本的 DSL - 1 : Groovy
或 2: Kotlin
。对于其他问题,按回车键使用默认值。
输出将如下所示
$ gradle init Select type of project to generate: 1: basic 2: application 3: library 4: Gradle plugin Enter selection (default: basic) [1..4] 2 Select implementation language: 1: C++ 2: Groovy 3: Java 4: Kotlin 5: Scala 6: Swift Enter selection (default: Java) [1..6] 5 Select build script DSL: 1: Groovy 2: Kotlin Enter selection (default: Groovy) [1..2] 1 Project name (default: demo): BUILD SUCCESSFUL 2 actionable tasks: 2 executed
init
任务使用以下结构生成新项目
├── gradle (1)
│ ├── libs.versions.toml (2)
│ └── wrapper
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── gradlew (3)
├── gradlew.bat (3)
├── settings.gradle.kts (4)
└── lib
├── build.gradle.kts (5)
└── src
├── main
│ └── cpp (6)
│ │ └── hello.cpp
│ └── headers
│ └── app.h
└── test
└── cpp (7)
└── hello_test.cpp
├── gradle (1)
│ ├── libs.versions.toml (2)
│ └── wrapper
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── gradlew (3)
├── gradlew.bat (3)
├── settings.gradle (4)
└── lib
├── build.gradle (5)
└── src
├── main
│ └── cpp (6)
│ │ └── hello.cpp
│ └── headers
│ └── app.h
└── test
└── cpp (7)
└── hello_test.cpp
1 | 为包装器文件生成的文件夹 |
2 | 生成的版本目录 |
3 | Gradle 包装器启动脚本 |
4 | 设置文件以定义构建名称和子项目 |
5 | lib 项目的构建脚本 |
6 | 默认 C++ 源代码文件夹 |
7 | 默认 C++ 测试源代码文件夹 |
您现在已将项目设置为构建 C++ 库。
查看项目文件
settings.gradle(.kts)
文件有两行有趣的代码
rootProject.name = "demo"
include("lib")
rootProject.name = 'demo'
include('lib')
-
rootProject.name
为构建分配一个名称,这将覆盖将构建命名为其所在目录的默认行为。建议设置一个固定名称,因为如果项目共享(例如作为 Git 存储库的根目录),文件夹可能会更改。 -
include("lib")
定义构建包含一个名为lib
的子项目,该子项目包含实际代码和构建逻辑。可以通过其他include(…)
语句添加更多子项目。
我们的构建包含一个名为 lib
的子项目,它代表我们正在构建的 C++ 库。它在 lib/build.gradle(.kts)
文件中配置
plugins {
`cpp-library` (1)
`cpp-unit-test` (2)
}
library {
targetMachines.add(machines.linux.x86_64) (3)
}
plugins {
id 'cpp-library' (1)
id 'cpp-unit-test' (2)
}
library {
targetMachines.add(machines.linux.x86_64) (3)
}
1 | 应用 cpp-library 插件以添加对构建 C++ 库的支持 |
2 | 应用 cpp-unit-test 插件以添加对构建和运行 C++ 测试可执行文件支持 |
3 | 为该库设置目标操作系统和架构 |
以下是文件src/main/cpp/hello.cpp
/*
* This source file was generated by the Gradle 'init' task
*/
#include <iostream>
#include <stdlib.h>
#include "demo.h"
std::string demo::Greeter::greeting() {
return std::string("Hello, World!");
}
接下来显示生成的测试,src/test/cpp/hello.cpp
/*
* This source file was generated by the Gradle 'init' task
*/
#include "demo.h"
#include <cassert>
int main() {
demo::Greeter greeter;
assert(greeter.greeting().compare("Hello, World!") == 0);
return 0;
}
生成的测试类包含一个C++ 可执行文件测试。该测试实例化了Hello
类,调用其方法,并检查其是否返回预期值。
构建库
$ ./gradlew build BUILD SUCCESSFUL in 0s 4 actionable tasks: 4 executed
第一次运行包装器脚本gradlew 时,可能会延迟一段时间,因为该版本的gradle 需要下载并存储在本地~/.gradle/wrapper/dists 文件夹中。
|
build
任务编译 C++ 源代码,将目标文件链接到共享库,并运行测试。要构建静态库,请参考静态库示例。
本指南不涵盖对其他项目的依赖关系。要详细了解此主题,请查看传递依赖关系示例以进行演示。 |
将库发布到 Maven 存储库不在本指南的范围内。要详细了解此主题,请查看简单库示例以进行演示。 |
Gradle 与多个 IDE 集成:Visual Studio、Xcode 和 Clion。要详细了解,请查看其各自的链接文档以配置项目中的 IDE 集成。 |
发布构建扫描
了解构建在幕后执行情况的最佳方法是发布构建扫描。为此,只需使用--scan
标志运行 Gradle。
$ ./gradlew build --scan BUILD SUCCESSFUL in 0s 4 actionable tasks: 4 executed Publishing a build scan to scans.gradle.com requires accepting the Gradle Terms of Service defined at https://gradle.com/terms-of-service. Do you accept these terms? [yes, no] yes Gradle Terms of Service accepted. Publishing build scan... https://gradle.com/s/5u4w3gxeurtd2
单击链接并探索执行了哪些任务、下载了哪些依赖项以及更多详细信息!
总结
就是这样!您现在已成功使用 Gradle 配置和构建 C++ 库项目。您已经了解了如何
-
初始化一个生成 C++ 库的项目
-
构建库,包括运行其测试