您可以在支援 Gradle 的 IDE中開啟此範例。

本指南示範如何使用 gradle init 與 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 : Kotlin2: 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 設定檔,用於定義建置名稱和子專案
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++ 原始碼、連結物件檔案並執行測試。它還封裝主要和測試應用程式,以便在其他系統上發佈。installDebuginstallTest 任務(兩者都作為 build 的一部分執行)會複製可執行檔並產生一個用於執行應用程式的 Shell 腳本。以下顯示 build/install 資料夾的內容

./app/build/install
├── main
│   └── debug
│       ├── app      (1)
│       └── lib
│           └── app  (2)
└── test
    ├── appTest      (1)
    └── lib
        └── appTest  (3)
1 用於執行應用程式變體的腳本
2 主要可執行二進制檔案(偵錯變體)
3 測試可執行二進制檔案
當建置具有相依性時,相依的函式庫也會複製到安裝資料夾中。Shell 腳本會正確配置函式庫路徑,以便可以重新定位套件。
本指南未涵蓋對其他專案的相依性。若要了解有關此主題的更多資訊,請查看過渡相依性範例以進行示範。
Gradle 與多個 IDE 整合:Visual StudioXcodeClion。若要了解更多資訊,請查看其各自連結的文件,以在您的專案中配置這些 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++ 專案」的章節。