建立 Groovy 函式庫範例 - Gradle 繁體中文

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

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

您將建置的內容

您將產生遵循 Gradle 約定的 Groovy 函式庫。

您需要準備的內容

文字編輯器或 IDE - 例如 IntelliJ IDEA
Java 開發套件 (JDK)，版本 8 或更高 - 例如 AdoptOpenJDK
最新的 Gradle distribution

建立專案資料夾

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

第一步是為新專案建立一個資料夾，並將目錄變更為該資料夾。

$ mkdir demo
$ cd demo

執行 init 任務

在新的專案目錄中，使用終端機中的下列指令執行 init 任務：gradle init。當提示時，選取 2: library 專案類型，以及 3: Groovy 作為實作語言。接下來，你可以選擇用於撰寫建置指令碼的 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] 3

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

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
        │   └── groovy (6)
        │       └── demo
        │           └── Library.groovy
        └── test
            └── groovy (7)
                └── demo
                    └── LibraryTest.groovy

├── 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
        │   └── groovy (6)
        │       └── demo
        │           └── Library.groovy
        └── test
            └── groovy (7)
                └── demo
                    └── LibraryTest.groovy

1	產生包裝器檔案的資料夾
2	產生版本目錄
3	Gradle 包裝器啟動指令碼
4	定義建置名稱和子專案的設定檔
5	`lib` 專案的建置指令碼
6	預設 Groovy 原始碼資料夾
7	預設 Groovy 測試原始碼資料夾

現在你已經設定好專案，可以建置 Groovy 函式庫。

檢閱專案檔案

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 的子專案，代表我們正在建置的 Groovy 函式庫。它在 lib/build.gradle(.kts) 檔案中進行設定

lib/build.gradle.kts

plugins {
    groovy (1)
    `java-library` (2)
}

repositories {
    mavenCentral() (3)
}

dependencies {
    implementation(libs.groovy.all) (4)

    implementation(libs.guava) (5)

    testImplementation(libs.spock.core) (6)
    testImplementation(libs.junit)

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

    api(libs.commons.math3) (7)
}

tasks.named<Test>("test") {
    useJUnitPlatform() (8)
}

lib/build.gradle

plugins {
    id 'groovy' (1)
    id 'java-library' (2)
}

repositories {
    mavenCentral() (3)
}

dependencies {
    implementation libs.groovy.all (4)

    implementation libs.guava (5)

    testImplementation libs.spock.core (6)
    testImplementation libs.junit

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

    api libs.commons.math3 (7)
}

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

1	套用 groovy 外掛程式來新增對 Groovy 的支援。
2	套用 java-library 外掛程式來區分 API 和實作。
3	使用 Maven Central 來解析相依性。
4	使用最新的 Groovy 版本來建置此函式庫
5	此相依性會在內部使用，並不會顯示給使用者在他們自己的編譯類別路徑上。
6	即使使用 Java 也要使用很棒的 Spock 測試和規範架構
7	此相依性會匯出至消費者，亦即在他們的編譯類別路徑中找到。
8	使用 JUnit Platform 進行單元測試。

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

產生的 src/main/groovy/demo/Library.groovy

/*
 * This source file was generated by the Gradle 'init' task
 */
package demo

class Library {
    boolean someLibraryMethod() {
        true
    }
}

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

產生的 src/test/groovy/demo/LibraryTest.groovy

/*
 * This source file was generated by the Gradle 'init' task
 */
package demo

import spock.lang.Specification

class LibraryTest extends Specification {
    def "someLibraryMethod returns true"() {
        setup:
        def lib = new Library()

        when:
        def result = lib.someLibraryMethod()

        then:
        result == true
    }
}

產生的測試類別有一個單一的 Spock 測試。測試會實例化 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 外掛程式假設您的專案來源已安排在慣例專案配置中。如果您願意，可以自訂專案配置如使用者手冊中所述。

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

自訂函式庫 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。

發佈建置掃描

深入了解建置在幕後執行作業的最佳方式，是發佈建置掃描。為此，只要使用 --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

按一下連結，探索已執行的哪些工作、下載了哪些相依性，以及更多詳細資訊！

摘要

完成！您現在已成功設定並建置 Groovy 函式庫專案，並使用 Gradle。您已學會如何

初始化產生 Groovy 函式庫的專案
執行建置並檢視測試報告
自訂建置產生的 Jar 檔案

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

後續步驟

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