构建 C++ 应用程序示例 - Gradle 构建系统

您可以在支持 Gradle 的 IDE 中打开此示例。

本指南演示了如何使用 gradle init 通过 Gradle 创建 C++ 应用程序。您可以按照本指南的步骤从头开始创建新项目，或者使用上面的链接下载完整的示例项目。

您将构建什么

您将生成一个遵循 Gradle 约定的 C++ 应用程序。

您将需要什么

文本编辑器或 IDE - 例如 IntelliJ IDEA
Java Development Kit (JDK)，版本 8 或更高 - 例如 AdoptOpenJDK
最新的 Gradle 发行版
已安装的 C++ 编译器。请参阅 Gradle 支持的C++ 工具链。

创建项目文件夹

Gradle 带有一个内置任务，称为 init，用于在空文件夹中初始化新的 Gradle 项目。init 任务使用（也是内置的）wrapper 任务创建 Gradle wrapper 脚本 gradlew。

第一步是为新项目创建一个文件夹并进入该目录。

$ mkdir demo
$ cd demo

运行 init 任务

在新项目目录内，使用终端中的以下命令运行 init 任务：gradle init。当提示时，选择项目类型 1: application 和实现语言 5: C++。接下来，您可以选择用于编写构建脚本的 DSL - 1 : Kotlin 或 2: Groovy。对于其他问题，按 Enter 键使用默认值。

输出将如下所示

$ gradle init

Select type of build to generate:
  1: Application
  2: Library
  3: Gradle plugin
  4: Basic (build structure only)
Enter selection (default: Application) [1..4] 1

Select implementation language:
  1: Java
  2: Kotlin
  3: Groovy
  4: Scala
  5: C++
  6: Swift
Enter selection (default: Java) [1..6] 5

Project name (default: demo):

Select build script DSL:
  1: Kotlin
  2: Groovy
Enter selection (default: Kotlin) [1..2]

Generate build using new APIs and behavior (some features may change in the next minor release)? (default: no) [yes, no]

BUILD SUCCESSFUL
1 actionable task: 1 executed

init 任务生成的新项目结构如下

├── gradle (1)
│   ├── libs.versions.toml (2)
│   └── wrapper
│       ├── gradle-wrapper.jar
│       └── gradle-wrapper.properties
├── gradlew (3)
├── gradlew.bat (3)
├── settings.gradle.kts (4)
└── app
    ├── build.gradle.kts (5)
    └── src
        ├── main
        │   └── cpp (6)
        │   │   └── app.cpp
        │   └── headers
        │       └── app.h
        └── test
            └── cpp (7)
                └── app_test.cpp

├── gradle (1)
│   ├── libs.versions.toml (2)
│   └── wrapper
│       ├── gradle-wrapper.jar
│       └── gradle-wrapper.properties
├── gradlew (3)
├── gradlew.bat (3)
├── settings.gradle (4)
└── app
    ├── build.gradle (5)
    └── src
        ├── main
        │   └── cpp (6)
        │   │   └── app.cpp
        │   └── headers
        │       └── app.h
        └── test
            └── cpp (7)
                └── app_test.cpp

1	生成的 wrapper 文件目录
2	生成的版本目录
3	Gradle wrapper 启动脚本
4	定义构建名称和子项目的 Settings 文件
5	`app` 项目的构建脚本
6	默认 C++ 源代码文件夹
7	默认 C++ 测试源代码文件夹

您现在已经设置好了项目来构建 C++ 应用程序。

检查项目文件

settings.gradle(.kts) 文件中有两行比较重要

settings.gradle.kts

rootProject.name = "demo"
include("app")

settings.gradle

rootProject.name = 'demo'
include('app')

rootProject.name 为构建分配一个名称，这会覆盖根据所在目录命名构建的默认行为。建议设置一个固定名称，因为如果项目被共享（例如作为 Git 仓库的根目录），文件夹可能会更改。
include("app") 定义构建包含一个名为 app 的子项目，该子项目包含实际代码和构建逻辑。可以通过额外的 include(…) 语句添加更多子项目。

我们的构建包含一个名为 app 的子项目，它代表我们正在构建的 C++ 应用程序。它在 app/build.gradle(.kts) 文件中进行配置

app/build.gradle.kts

plugins {
    `cpp-application` (1)
    `cpp-unit-test` (2)
}

application { (3)
    targetMachines.add(machines.linux.x86_64)
}

app/build.gradle

plugins {
    id 'cpp-application' (1)
    id 'cpp-unit-test' (2)
}

application { (3)
    targetMachines.add(machines.linux.x86_64)
}

1	应用 cpp-application 插件以添加对构建 C++ 可执行文件的支持
2	应用 cpp-unit-test 插件以添加对构建和运行 C++ 测试可执行文件的支持

文件 src/main/cpp/app.cpp 在这里显示

生成的 src/main/cpp/app.cpp

/*
 * This source file was generated by the Gradle 'init' task
 */

#include <iostream>
#include <stdlib.h>
#include "app.h"

std::string demo::Greeter::greeting() {
    return std::string("Hello, World!");
}

int main () {
    demo::Greeter greeter;
    std::cout << greeter.greeting() << std::endl;
    return 0;
}

生成的测试文件 src/test/cpp/app.cpp 接下来显示

生成的 src/test/cpp/app_test.cpp

/*
 * This source file was generated by the Gradle 'init' task
 */

#include "app.h"
#include <cassert>

int main() {
    demo::Greeter greeter;
    assert(greeter.greeting().compare("Hello, World!") == 0);
    return 0;
}

生成的测试类包含一个单一的 C++ 可执行 测试。该测试实例化 Greeter 类，调用其上的方法，并检查它是否返回预期值。

构建应用程序

$ ./gradlew build

BUILD SUCCESSFUL in 0s
7 actionable tasks: 7 executed

第一次运行 wrapper 脚本 gradlew 时，可能会有延迟，因为该版本的 gradle 会被下载并本地存储在您的 ~/.gradle/wrapper/dists 文件夹中。

build 任务会编译 C++ 源代码，链接目标文件，并运行测试。它还会打包主应用程序和测试应用程序，以便在其他系统上分发。installDebug 和 installTest 任务（它们都作为 build 的一部分运行）会复制可执行文件并生成用于执行应用程序的 shell 脚本。以下显示了 build/install 文件夹的内容

./app/build/install
├── main
│   └── debug
│       ├── app      (1)
│       └── lib
│           └── app  (2)
└── test
    ├── appTest      (1)
    └── lib
        └── appTest  (3)

1	执行应用程序变体的脚本
2	主可执行二进制文件（debug 变体）
3	测试可执行二进制文件

当构建有依赖项时，相关的库也会被复制到安装文件夹中。shell 脚本会正确配置库路径，以便可以重新定位包。

本指南未涵盖对其他项目的依赖项。要了解有关此主题的更多信息，请查看传递性依赖项示例以获取演示。

Gradle 集成了多种 IDE：Visual Studio、Xcode 和 Clion。要了解更多信息，请查看其各自的链接文档以在您的项目中配置这些 IDE 集成。

运行应用程序

查看 build 文件夹内部，您会注意到出现了一个 exe 文件夹。按照约定，Gradle 会将所有应用程序放置在根据组件名称命名的子文件夹中。在这种情况下，您会在 build/exe/main/debug 中找到您的组装好的可执行文件，它将被命名为 app（在 Windows 下为 app.exe）。

现在运行您新构建的可执行文件。

$ ./app/build/exe/main/debug/app
Hello, World!

发布构建扫描

了解您的构建在幕后执行了什么的最佳方式是发布一个构建扫描。为此，只需使用 --scan 标志运行 Gradle。

$ ./gradlew build --scan

BUILD SUCCESSFUL in 0s
7 actionable tasks: 7 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++ 应用程序的项目
构建、捆绑和运行应用程序

后续步骤

要了解如何进一步自定义 C++ 应用程序项目，请查阅用户手册中关于构建 C++ 项目的章节。