您可以使用 IntelliJ 原生匯入器 或 Eclipse Buildship 在 IDE 中開啟此範例。

若要讓您的軟體專案做好成長準備，您可以將 Gradle 專案整理成多個子專案，以模組化您正在建置的軟體。在本指南中，您將學習如何以 Java 應用程式的範例來建構此類專案。然而，一般概念適用於您使用 Gradle 建置的任何軟體。您可以逐步遵循指南從頭開始建立新專案，或使用上述連結下載完整的範例專案。

您將建置的內容

您將建置一個 Java 應用程式，其中包含一個應用程式和多個函式庫專案。

您需要準備的

建立專案資料夾

Gradle 內建一個名為 init 的工作，會在一個空的資料夾中初始化新的 Gradle 專案。init 工作會使用（也是內建的）wrapper 工作來建立 Gradle wrapper 腳本 gradlew。

第一步是為新專案建立一個資料夾，並切換目錄到該資料夾中。

$ mkdir demo
$ cd demo

執行 init 工作

從新的專案目錄中，使用終端機中的下列指令執行 init 工作：gradle init。在提示時，選擇 1: application 專案類型，並選擇 1: Java 作為實作語言。之後，選擇 2: Add library projects。接著您可以選擇用於撰寫建置腳本的 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

Split functionality across multiple subprojects?:
   1: no - only one application project
   2: yes - application and library projects
Enter selection (default: no - only one application project) [1..2] 2

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

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

Select test framework:
  1: JUnit 4
  2: TestNG
  3: Spock
  4: JUnit Jupiter
Enter selection (default: JUnit 4) [1..4]

Project name (default: demo):
Source package (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)
├── buildSrc
│   ├── build.gradle.kts (5)
│   ├── settings.gradle.kts (5)
│   └── src
│       └── main
│           └── kotlin (6)
│               ├── buildlogic.java-application-conventions.gradle.kts
│               ├── buildlogic.java-common-conventions.gradle.kts
│               └── buildlogic.java-library-conventions.gradle.kts
├── app
│   ├── build.gradle.kts (7)
│   └── src
│       ├── main (8)
│       │   └── java
│       │       └── demo
│       │           └── app
│       │               ├── App.java
│       │               └── MessageUtils.java
│       └── test (9)
│           └── java
│               └── demo
│                   └── app
│                       └── MessageUtilsTest.java
├── list
│   ├── build.gradle.kts (7)
│   └── src
│       ├── main (8)
│       │   └── java
│       │       └── demo
│       │           └── list
│       │               └── LinkedList.java
│       └── test (9)
│           └── java
│               └── demo
│                   └── list
│                       └── LinkedListTest.java
└── utilities
    ├── build.gradle.kts (7)
    └── src
        └── main (8)
            └── java
                └── demo
                    └── utilities
                        ├── JoinUtils.java
                        ├── SplitUtils.java
                        └── StringUtils.java
├── gradle (1)
│   ├── libs.versions.toml (2)
│   └── wrapper
│       ├── gradle-wrapper.jar
│       └── gradle-wrapper.properties
├── gradlew (3)
├── gradlew.bat (3)
├── settings.gradle (4)
├── buildSrc
│   ├── build.gradle (5)
│   ├── settings.gradle (5)
│   └── src
│       └── main
│           └── groovy (6)
│               ├── buildlogic.java-application-conventions.gradle
│               ├── buildlogic.java-common-conventions.gradle
│               └── buildlogic.java-library-conventions.gradle
├── app
│   ├── build.gradle (7)
│   └── src
│       ├── main (8)
│       │   └── java
│       │       └── demo
│       │           └── app
│       │               ├── App.java
│       │               └── MessageUtils.java
│       └── test (9)
│           └── java
│               └── demo
│                   └── app
│                       └── MessageUtilsTest.java
├── list
│   ├── build.gradle (7)
│   └── src
│       ├── main (8)
│       │   └── java
│       │       └── demo
│       │           └── list
│       │               └── LinkedList.java
│       └── test (9)
│           └── java
│               └── demo
│                   └── list
│                       └── LinkedListTest.java
└── utilities
    ├── build.gradle (7)
    └── src
        └── main (8)
            └── java
                └── demo
                    └── utilities
                        ├── JoinUtils.java
                        ├── SplitUtils.java
                        └── StringUtils.java
1 產生 wrapper 檔案的資料夾
2 產生版本目錄
3 Gradle wrapper 啟動腳本
4 設定檔，用於定義建置名稱和子專案
5 buildSrc 的建置腳本，用於設定建置邏輯的相依性
6 使用 Groovy 或 Kotlin DSL 撰寫的慣例外掛的原始碼資料夾
7 三個子專案的建置腳本 - app、list 和 utilities
8 每個子專案中的 Java 原始碼資料夾
9 子專案中的 Java 測試原始碼資料夾

現在您已經設定好專案，可以建置一個模組化為多個子專案的 Java 應用程式。

檢閱專案檔案

settings.gradle(.kts) 檔案中有兩行有趣的程式碼

settings.gradle.kts
rootProject.name = "demo"
include("app", "list", "utilities")
settings.gradle
rootProject.name = 'demo'
include('app', 'list', 'utilities')

  • rootProject.name 指定組建名稱，這會覆寫組建名稱的預設行為，也就是以其所在的目錄命名。建議設定固定名稱，因為如果專案是共用的，資料夾可能會變更，例如 Git 儲存庫的根目錄。

  • include("app", "list", "utilities") 定義組建包含對應資料夾中的三個子專案。可以透過延伸清單或新增更多 include(…​) 陳述式來新增更多子專案。

由於我們的組建包含多個子專案，我們想要在它們之間共用組建邏輯和設定。為此，我們利用位於 buildSrc 資料夾中的所謂慣例外掛程式。buildSrc 中的慣例外掛程式是利用 Gradle 的外掛程式系統撰寫可重複使用的組建設定區塊的簡易方式。

在這個範例中，我們可以找到三個這樣的慣例外掛程式，它們彼此為基礎

buildSrc/src/main/kotlin/buildlogic.java-common-conventions.gradle.kts
plugins {
    java (1)
}

repositories {
    mavenCentral() (2)
}

dependencies {
    constraints {
        implementation("org.apache.commons:commons-text:1.11.0") (3)
    }

    testImplementation("org.junit.jupiter:junit-jupiter:5.10.1") (4)

    testRuntimeOnly("org.junit.platform:junit-platform-launcher")
}

tasks.named<Test>("test") {
    useJUnitPlatform() (5)
}
buildSrc/src/main/groovy/buildlogic.java-common-conventions.gradle
plugins {
    id 'java' (1)
}

repositories {
    mavenCentral() (2)
}

dependencies {
    constraints {
        implementation 'org.apache.commons:commons-text:1.11.0' (3)
    }

    testImplementation 'org.junit.jupiter:junit-jupiter:5.10.1' (4)

    testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
}

tasks.named('test') {
    useJUnitPlatform() (5)
}

java-common-conventions 定義一些設定，這些設定應由我們所有的 Java 專案共用，不論它們表示函式庫或實際應用程式。首先，我們套用 Java 外掛程式 (1) 以使用建置 Java 專案的所有功能。接著，我們宣告一個儲存庫 — mavenCentral() — 作為外部依賴項目的來源 (2)，定義依賴項目的約束 (3) 以及所有子專案共用的標準依賴項，並將 JUnit 5 設定為測試架構 (4…​)。其他共用設定，例如編譯器旗標或 JVM 版本相容性，也可以在此設定。

buildSrc/src/main/kotlin/buildlogic.java-library-conventions.gradle.kts
plugins {
    id("buildlogic.java-common-conventions") (1)
    `java-library` (2)
}
buildSrc/src/main/groovy/buildlogic.java-library-conventions.gradle
plugins {
    id 'buildlogic.java-common-conventions' (1)
    id 'java-library' (2)
}
buildSrc/src/main/kotlin/buildlogic.java-application-conventions.gradle.kts
plugins {
    id("buildlogic.java-common-conventions") (1)
    application (2)
}
buildSrc/src/main/groovy/buildlogic.java-application-conventions.gradle
plugins {
    id 'buildlogic.java-common-conventions' (1)
    id 'application' (2)
}

java-library-conventions 和 java-application-conventions 都套用 java-common-conventions 外掛程式 (1)，因此在那裡執行的設定會由函式庫和應用程式專案共用。接下來，它們分別套用 java-library 或 application 外掛程式 (2)，因此將我們的共用設定邏輯與函式庫或應用程式的特定設定結合在一起。雖然這個範例中沒有更精細的設定，但函式庫或應用程式專案特定的組建設定可以放入其中一個慣例外掛程式指令碼中。

讓我們看看子專案中的 build.gradle(.kts) 檔案。

app/build.gradle.kts
plugins {
    id("buildlogic.java-application-conventions")
}

dependencies {
    implementation("org.apache.commons:commons-text")
    implementation(project(":utilities"))
}

application {
    mainClass = "demo.app.App" (1)
}
app/build.gradle
plugins {
    id 'buildlogic.java-application-conventions'
}

dependencies {
    implementation 'org.apache.commons:commons-text'
    implementation project(':utilities')
}

application {
    mainClass = 'demo.app.App' (1)
}
list/build.gradle.kts
plugins {
    id("buildlogic.java-library-conventions")
}
list/build.gradle
plugins {
    id 'buildlogic.java-library-conventions'
}
utilities/build.gradle.kts
plugins {
    id("buildlogic.java-library-conventions")
}

dependencies {
    api(project(":list"))
}
utilities/build.gradle
plugins {
    id 'buildlogic.java-library-conventions'
}

dependencies {
    api project(':list')
}

查看建置指令碼，我們可以看到它們包含多達三個區塊

  • 每個建置指令碼都應該有一個 plugins {} 區塊來套用外掛程式。在結構良好的建置中，它可能只套用一個 慣例外掛程式，如本範例所示。然後，慣例外掛程式將負責套用和設定 Gradle 核心外掛程式（例如 application 或 java-library）其他慣例外掛程式或來自外掛程式入口網站的社群外掛程式。

  • 其次，如果專案有相依性，則應加入 dependencies {} 區塊。相依性可以是外部的，例如我們在 java-common-conventions 中加入的 JUnit 相依性，或可以指向其他本機子專案。為此，使用 project(…​) 符號。在我們的範例中，utilities 函式庫需要 list 函式庫。而 app 使用 utilities 函式庫。如果本機專案彼此相依，則 Gradle 會在需要時（且僅在需要時）負責建置相依專案。若要深入了解，請參閱關於 Gradle 中相依性管理 的文件。

  • 第三，可能有一個或多個外掛程式的設定區塊。這些區塊僅應在建置指令碼中直接使用，如果它們為一個專案設定特定事項。否則，此類設定也屬於慣例外掛程式。在本範例中，我們使用 application {} 區塊，它專屬於 application 外掛程式，將 app 專案中的 mainClass 設定為 demo.app.App (1)。

我們擁有的最後一個建置檔案是 buildSrc 中的 build.gradle(.kts) 檔案。

buildSrc/build.gradle.kts
plugins {
    `kotlin-dsl` (1)
}

repositories {
    gradlePluginPortal() (2)
}
buildSrc/build.gradle
plugins {
    id 'groovy-gradle-plugin' (1)
}

repositories {
    gradlePluginPortal() (2)
}

此檔案設定階段以建置慣例外掛程式本身。透過套用外掛程式開發外掛程式 — groovy-gradle-plugin 或 kotlin-dsl — (1) 我們啟用支援將慣例外掛程式寫為 buildSrc 中的建置檔案。這些是我們在上面已經檢查過的慣例外掛程式。此外，我們將 Gradle 的外掛程式入口網站新增為儲存庫 (2)，這讓我們可以存取社群外掛程式。若要使用外掛程式，需要在 dependencies {} 區塊中宣告它為相依性。

除了 Gradle 建置檔案之外，您還可以在對應的資料夾中找到範例 Java 原始碼和測試原始碼。您可以隨時修改這些產生的原始碼和測試，以探索 Gradle 在執行建置時如何對變更做出反應，如下所述。

執行測試

您可以使用 ./gradlew check 來執行所有子專案中的所有測試。當您使用純粹的任務名稱（例如 check）呼叫 Gradle 時，將為提供該任務的所有子專案執行該任務。若要僅鎖定特定子專案，您可以使用任務的完整路徑。例如，:app:check 將只執行 app 專案的測試。但是，在本範例中，其他子專案仍會編譯，因為 app 宣告對它們有相依性。

$ ./gradlew check

BUILD SUCCESSFUL
9 actionable tasks: 9 executed

如果所有測試都成功通過，Gradle 就不會在主控台中列印更多輸出。您可以在 <subproject>/build/reports 資料夾中找到測試報告。您可以隨時變更部分範例程式碼或測試，並重新執行 check 以查看如果測試失敗會發生什麼事。

執行應用程式

由於有 application 外掛程式，您可以直接從命令列執行應用程式。run 任務告訴 Gradle 執行指定給 mainClass 屬性的類別中的 main 方法。

$ ./gradlew run

> Task :app:run
Hello world!

BUILD SUCCESSFUL
2 actionable tasks: 2 executed
第一次執行包裝器腳本 gradlew 時，可能會延遲，因為會下載 gradle 的版本並儲存在本機的 ~/.gradle/wrapper/dists 資料夾中。

打包應用程式

application 外掛程式也會幫你打包應用程式，連同所有相依性。封存檔也會包含一個腳本，可以用單一指令啟動應用程式。

$ ./gradlew build

BUILD SUCCESSFUL in 0s
7 actionable tasks: 7 executed

如果你執行如上所示的完整建置，Gradle 會幫你產生兩種格式的封存檔：app/build/distributions/app.tar 和 app/build/distributions/app.zip。

發佈建置掃描

進一步了解建置在幕後執行什麼的最佳方法，就是發佈 建置掃描。要這樣做，只要執行 Gradle 並加上 --scan 旗標即可。

$ ./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 設定和建置 Java 應用程式專案。你已經學會如何

  • 初始化產生 Java 應用程式的專案

  • 透過結合多個子專案來建立模組化軟體專案

  • 在 buildSrc 中使用慣例外掛程式，在子專案之間共用建置設定邏輯

  • 在所有子專案中執行名稱相似的任務

  • 在特定子專案中執行任務

  • 建置、打包和執行應用程式

後續步驟

當你的專案變大時，你可能會對如何設定 JVM 專案、建構多專案建置和相依性管理更感興趣