您可以使用 IntelliJ 原生匯入器 或 Eclipse Buildship 在 IDE 內開啟此範例。 |
本指南示範如何使用 gradle init
以 Gradle 建立 C++ 應用程式。您可以逐步遵循本指南從頭建立新專案,或使用上述連結下載完整的範例專案。
C++ 應用程式外掛程式與 組態快取 不相容。 |
您將組建的內容
您將產生一個遵循 Gradle 約定的 C++ 應用程式。
您將需要的內容
-
文字編輯器或 IDE - 例如 IntelliJ IDEA
-
Java 開發套件 (JDK),版本 8 或更高 - 例如 AdoptOpenJDK
-
最新的 Gradle 發行版
-
已安裝的 C++ 編譯器。請參閱 C++ 工具鏈,了解 Gradle 支援哪些工具鏈。
建立專案資料夾
Gradle 附有一個內建任務,稱為 init
,可在空的資料夾中初始化新的 Gradle 專案。init
任務使用(也是內建的)wrapper
任務建立 Gradle wrapper 腳本 gradlew
。
第一步是為新專案建立資料夾,並變更目錄到該資料夾。
$ mkdir demo $ cd demo
執行 init 任務
從新專案目錄中,在終端機中使用下列指令執行 init
任務:gradle init
。當系統提示時,選取 1: application
專案類型,並選取 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] 1 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)
└── 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)
檔案中有兩行有趣的程式碼
rootProject.name = "demo"
include("app")
rootProject.name = 'demo'
include('app')
-
rootProject.name
會將名稱指定給建置,這會覆寫根據資料夾名稱命名建置的預設行為。建議設定固定名稱,因為如果專案是共用的,資料夾可能會變更 - 例如,作為 Git 存放庫的根目錄。 -
include("app")
定義建置包含一個名為app
的子專案,其中包含實際程式碼和建置邏輯。可以透過其他include(…)
陳述式新增更多子專案。
我們的建置包含一個名為 app
的子專案,代表我們正在建置的 C++ 應用程式。它是在 app/build.gradle(.kts)
檔案中設定的
plugins {
`cpp-application` (1)
`cpp-unit-test` (2)
}
application { (3)
targetMachines.add(machines.linux.x86_64)
}
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
如下所示
/*
* 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
如下所示
/*
* 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
第一次執行包裝腳本 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 | 主要可執行二進位檔(偵錯變體) |
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++ 應用程式的專案
-
建置、打包並執行應用程式