| 您可以使用 IntelliJ 原生匯入器 或 Eclipse Buildship 在 IDE 內開啟此範例。 |
本指南示範如何使用 gradle init 來建立 C++ 程式庫。您可以逐步遵循本指南從頭開始建立新專案，或使用上述連結下載完整的範例專案。
| C++ 程式庫外掛與 組態快取 不相容。 |
您將建置的內容
您將產生遵循 Gradle 約定的 C++ 程式庫。
您將需要的內容
-
文字編輯器或 IDE - 例如 IntelliJ IDEA
-
Java 開發套件 (JDK)，版本 8 或更高 - 例如 AdoptOpenJDK
-
最新的 Gradle 發行版
-
已安裝的 C++ 編譯器。請參閱 Gradle 支援哪些 C++ 工具鏈。
建立專案資料夾
Gradle 附帶一個內建的工作，稱為 init，用於在空資料夾中初始化新的 Gradle 專案。init 工作使用（也內建）wrapper 工作來建立 Gradle wrapper 腳本 gradlew。
第一步是為新專案建立一個資料夾，並將目錄變更到該資料夾。
$ mkdir demo $ cd demo
執行 init 任務
在新的專案目錄內，使用終端機中的下列指令執行 init 任務：gradle init。在提示時，選取 2: library 專案類型和 5: C++ 作為實作語言。接著，您可以選擇用於撰寫建置指令碼的 DSL - 1 : Groovy 或 2: Kotlin。對於其他問題，請按 Enter 使用預設值。
輸出結果會如下所示
$ 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
第一次執行 wrapper 腳本 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++ 函式庫的專案
-
建置函式庫，包括執行其測試