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

本指南示範如何使用 gradle init 來建立 Java 程式庫。您可以逐步按照指南從頭開始建立新專案，或使用上述連結下載完整的範例專案。

您將建置的內容

您將產生一個遵循 Gradle 約定的 Java 程式庫。

您需要準備的內容

建立專案資料夾

Gradle 附帶一個內建的任務，稱為 init，用於在空資料夾中初始化新的 Gradle 專案。init 任務使用（也內建的）wrapper 任務建立 Gradle wrapper 腳本 gradlew。

第一步是為新專案建立資料夾並切換目錄。

$ mkdir demo
$ cd demo

執行 init 任務

從新專案目錄內，在終端機使用下列指令執行 init 任務：gradle init。當提示時，選取 2: library 專案類型和 1: Java 作為實作語言。接下來，您可以選擇用於撰寫建置腳本的 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] 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)
└── lib
    ├── build.gradle.kts (5)
    └── src
        ├── main
        │   └── java (6)
        │       └── demo
        │           └── Library.java
        └── test
            └── java (7)
                └── demo
                    └── LibraryTest.java
├── 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
        │   └── java (6)
        │       └── demo
        │           └── Library.java
        └── test
            └── java (7)
                └── demo
                    └── LibraryTest.java
1 為 wrapper 檔案產生的資料夾
2 產生的版本目錄
3 Gradle wrapper 啟動腳本
4 定義建置名稱和子專案的設定檔
5 lib 專案的建置腳本
6 預設 Java 原始碼資料夾
7 預設 Java 測試原始碼資料夾

您現在已設定專案以建置 Java 函式庫。

檢閱專案檔案

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

settings.gradle.kts
rootProject.name = "demo"
include("lib")
settings.gradle
rootProject.name = 'demo'
include('lib')

  • rootProject.name 為建置指定名稱，覆寫根據資料夾名稱命名建置的預設行為。建議設定固定名稱，因為如果專案是共用的，資料夾可能會變更 - 例如作為 Git 儲存庫的根目錄。

  • include("lib") 定義建置包含一個稱為 lib 的子專案，其中包含實際程式碼和建置邏輯。可以透過額外的 include(…​) 陳述式新增更多子專案。

我們的建置包含一個稱為 lib 的子專案，代表我們正在建置的 Java 函式庫。它在 lib/build.gradle(.kts) 檔案中設定

lib/build.gradle.kts
plugins {
    `java-library` (1)
}

repositories {
    mavenCentral() (2)
}

dependencies {
    testImplementation(libs.junit.jupiter) (3)

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

    api(libs.commons.math3) (4)

    implementation(libs.guava) (5)
}

tasks.named<Test>("test") {
    useJUnitPlatform() (6)
}
lib/build.gradle
plugins {
    id 'java-library' (1)
}

repositories {
    mavenCentral() (2)
}

dependencies {
    testImplementation libs.junit.jupiter (3)

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

    api libs.commons.math3 (4)

    implementation libs.guava (5)
}

tasks.named('test') {
    useJUnitPlatform() (6)
}
1 套用 java-library 外掛，用於 API 和實作分離。
2 使用 Maven Central 來解析相依性。
3 使用 JUnit Jupiter 進行測試。
4 此相依性會匯出給使用者，也就是說會在他們的編譯類別路徑中找到。
5 此相依性供內部使用，不會公開給消費者使用於其自己的編譯類別路徑。
6 使用 JUnit Platform 進行單元測試。

檔案 src/main/java/demo/Library.java 如下所示

產生 src/main/java/demo/Library.java
/*
 * This source file was generated by the Gradle 'init' task
 */
package demo;

public class Library {
    public boolean someLibraryMethod() {
        return true;
    }
}

產生的測試 src/test/java/demo/Library.java 如下所示

產生 src/test/java/demo/LibraryTest.java
/*
 * This source file was generated by the Gradle 'init' task
 */
package demo;

import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.*;

class LibraryTest {
    @Test void someLibraryMethodReturnsTrue() {
        Library classUnderTest = new Library();
        assertTrue(classUnderTest.someLibraryMethod(), "someLibraryMethod should return 'true'");
    }
}

產生的測試類別只有一個 JUnit Jupiter 測試。測試會實例化 Library 類別，呼叫其方法，並檢查它是否傳回預期的值。

有關 java-library 外掛程式新增至任何 JVM 函式庫專案的功能（例如 API 和實作分離）的更多資訊，請參閱 Java 函式庫外掛程式文件。

組建函式庫 JAR

若要建置專案，請執行 build 任務。您可以使用一般的 gradle 指令，但當專案包含包裝指令碼時，建議使用包裝指令碼。

$ ./gradlew build

BUILD SUCCESSFUL in 0s
4 actionable tasks: 4 executed
第一次執行包裝指令碼 gradlew 時，可能會延遲一段時間，因為會下載該版本的 gradle 並將其儲存在本機的 ~/.gradle/wrapper/dists 資料夾中。

第一次執行建置時，Gradle 會檢查您在 ~/.gradle 目錄下的快取中是否已有必要的相依性。如果沒有，系統會下載函式庫並將其儲存在快取中。下次執行建置時，系統會使用快取版本。build 任務會編譯類別、執行測試並產生測試報告。

您可以開啟位於 lib/build/reports/tests/test/index.html 的 HTML 輸出檔案來檢視測試報告。

您可以在 lib/build/libs 目錄中找到新封裝的 JAR 檔案，其名稱為 lib.jar。執行下列指令驗證封存檔是否有效

$ jar tf lib/build/libs/lib.jar
META-INF/
META-INF/MANIFEST.MF
lib/
lib/Library.class

您應該會看到必要的清單檔案 —MANIFEST.MF— 和已編譯的 Library 類別。

所有這些動作都不需要在建置指令碼中進行任何額外的設定，因為 Gradle 的 java-library 外掛程式假設您的專案來源已安排在 慣例專案配置 中。如果您願意，可以 依照使用手冊說明 自訂專案配置。

恭喜您，您剛剛完成建立 Java 函式庫的第一步！現在您可以自訂此函式庫以符合您的專案需求。

自訂函式庫 JAR

您經常會希望 JAR 檔案的名稱包含函式庫版本。這可透過在建置指令碼中設定頂層 version 屬性來達成

build.gradle.kts
version = "0.1.0"
build.gradle
version = '0.1.0'

除了版本之外，函式庫的其他重要識別屬性還有名稱和群組。名稱直接來自代表函式庫的子專案名稱。在範例中為 lib，因此您可能想要透過變更 lib 資料夾的名稱和 settings.gradle(.kts) 檔案中對應的 include(…​) 陳述式來調整它。群組用於在發布時為您的函式庫提供完整的座標。您可以透過設定 group 屬性（類似於您設定版本的方式，如上所示）在建置指令碼中直接定義它。

現在執行 jar 工作

$ ./gradlew jar

BUILD SUCCESSFUL
2 actionable tasks: 1 executed, 1 up-to-date

您會注意到位於 lib/build/libs/lib-0.1.0.jar 的結果 JAR 檔案包含預期的版本。

另一個常見需求是自訂清單檔案，通常是透過新增一個或多個屬性來完成。讓我們透過設定 jar 工作將函式庫名稱和版本包含在清單檔案中。將下列內容新增到建置指令碼的結尾

build.gradle.kts
tasks.jar {
    manifest {
        attributes(mapOf("Implementation-Title" to project.name,
                         "Implementation-Version" to project.version))
    }
}
build.gradle
tasks.named('jar') {
    manifest {
        attributes('Implementation-Title': project.name,
                   'Implementation-Version': project.version)
    }
}

若要確認這些變更是否如預期般運作，請再次執行 jar 工作，並在此同時也從 JAR 解壓縮清單檔案

$ ./gradlew jar
$ jar xf lib/build/libs/lib-0.1.0.jar META-INF/MANIFEST.MF

現在檢視 META-INF/MANIFEST.MF 檔案的內容，您應該會看到下列內容

META-INF/MANIFEST.MF
Manifest-Version: 1.0
Implementation-Title: lib
Implementation-Version: 0.1.0

產生來源 JAR

您可以輕鬆為您的函式庫產生來源 JAR

build.gradle.kts
java {
    withSourcesJar()
}
build.gradle
java {
    withSourcesJar()
}

額外的 JAR 將作為 assemble 或 build 生命週期工作的其中一部分產生，並將成為發布的一部分。結果檔案會出現在 lib/build/libs 中，名稱使用慣例分類器 -sources。

新增 API 文件

java-library 外掛程式透過 javadoc 工作內建支援 Java 的 API 文件工具。

由 Build Init 外掛程式產生的程式碼已在 demo/Library.java 檔案中放置註解。將註解中的 / 改為 /*，使其成為 javadoc 標記

src/main/java/demo/Library.java
/**
 * This java source file was generated by the Gradle 'init' task.
 */
 ...

執行 javadoc 工作。

$ ./gradlew javadoc

BUILD SUCCESSFUL
2 actionable tasks: 1 executed, 1 up-to-date

您可以透過開啟位於 lib/build/docs/javadoc/index.html 的 HTML 檔案來檢視產生的 javadoc 檔案。

您也可以為您的函式庫產生 Javadoc JAR

build.gradle.kts
java {
    withJavadocJar()
}
build.gradle
java {
    withJavadocJar()
}

額外的 JAR 將作為 assemble 或 build 生命週期任務的一部分產生，並將成為發布的一部分。產生的檔案位於 lib/build/libs 中，名稱使用慣例分類器 -javadoc。

發布建置掃描

深入了解建置在幕後執行的最佳方式，是發布 建置掃描。為此，只需使用 --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 成功設定並建置 Java 函式庫專案。您已學會如何

  • 初始化產生 Java 函式庫的專案

  • 執行建置並檢視測試報告

  • 自訂建置產生的 Jar 檔案

現在，您可以嘗試編譯使用您剛建置的函式庫的 Java 程式碼，以完成此練習。

後續步驟

建置函式庫只是跨專案界線重複使用程式碼的一個面向。從這裡，您可能對以下內容感興趣