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

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

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

您將建置的內容

您將產生一個遵循 Gradle 約定的 Kotlin 函式庫。

您需要準備的內容

一個文字編輯器或 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` 專案類型，並選擇 `2: Kotlin` 作為實作語言。接著，你可以選擇用於撰寫建置指令碼的 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] 2

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

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

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

現在，你的專案已設定好建置 Kotlin 函式庫。

檢閱專案檔案

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

lib/build.gradle.kts

plugins {
    alias(libs.plugins.jvm) (1)
    `java-library` (2)
}

repositories {
    mavenCentral() (3)
}

dependencies {
    testImplementation("org.jetbrains.kotlin:kotlin-test-junit5") (4)

    testImplementation(libs.junit.jupiter.engine) (5)

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

    api(libs.commons.math3) (6)

    implementation(libs.guava) (7)
}

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

lib/build.gradle

plugins {
    alias(libs.plugins.jvm) (1)
    id 'java-library' (2)
}

repositories {
    mavenCentral() (3)
}

dependencies {
    testImplementation 'org.jetbrains.kotlin:kotlin-test-junit5' (4)

    testImplementation libs.junit.jupiter.engine (5)

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

    api libs.commons.math3 (6)

    implementation libs.guava (7)
}

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

1	套用 org.jetbrains.kotlin.jvm 外掛程式，以新增對 Kotlin 的支援。
2	套用 java-library 外掛程式，以區分 API 和實作。
3	使用 Maven Central 來解析相依性。
4	使用 Kotlin JUnit 5 整合。
5	使用 JUnit 5 整合。
6	此相依性會匯出給使用者，也就是說會在他們的編譯類別路徑中找到。
7	此相依性會在內部使用，不會在使用者自己的編譯類別路徑中公開。
8	使用 JUnit Platform 進行單元測試。

檔案 `src/main/kotlin/demo/Library.kt` 如下所示

產生的 src/main/kotlin/demo/Library.kt

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

class Library {
    fun someLibraryMethod(): Boolean {
        return true
    }
}

產生的測試 `src/test/kotlin/demo/Library.kt` 如下所示

產生的 src/test/kotlin/demo/LibraryTest.kt

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

import kotlin.test.Test
import kotlin.test.assertTrue

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

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

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

組建函式庫 JAR

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

$ ./gradlew build

BUILD SUCCESSFUL in 0s
5 actionable tasks: 5 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 外掛程式假設您的專案來源會以慣例專案配置排列。如果您願意，可以自訂專案配置，如使用者手冊中所述。

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

自訂函式庫 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
5 actionable tasks: 5 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 成功設定並建置 Kotlin 函式庫專案。您已學會如何

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

現在您可以透過嘗試編譯使用您剛建置的函式庫的一些 Kotlin 程式碼來完成這項練習。

後續步驟

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