您可以在支援 Gradle 的 IDE 中開啟此範例。

本指南示範如何使用 Gradle 和 gradle init 建立 Kotlin 函式庫。您可以逐步按照本指南從頭建立新專案，或使用上方連結下載完整的範例專案。

您將建置的內容

您將產生一個遵循 Gradle 慣例的 Kotlin 函式庫。

您需要的項目

建立專案資料夾

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

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

$ mkdir demo
$ cd demo

執行 init 工作

從新專案目錄內，使用終端機中的以下命令執行 init 工作：gradle init。當出現提示時，選取 2: library 專案類型和 2: Kotlin 作為實作語言。接下來，您可以選擇用於撰寫建置腳本的 DSL - 1 : Kotlin 或 2: Groovy。對於其他問題，請按 Enter 鍵使用預設值。

輸出結果會如下所示

$ gradle init

Select type of build to generate:
  1: Application
  2: Library
  3: Gradle plugin
  4: Basic (build structure only)
Enter selection (default: Application) [1..4] 2

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

Enter target Java version (min: 7, default: 21):

Project name (default: demo):

Select application structure:
  1: Single application project
  2: Application and library project
Enter selection (default: Single application project) [1..2] 1

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

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

Generate build using new APIs and behavior (some features may change in the next minor release)? (default: no) [yes, no]

BUILD SUCCESSFUL
1 actionable task: 1 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 為 Wrapper 檔案產生的資料夾
2 產生的版本目錄
3 Gradle Wrapper 啟動腳本
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.kotlin.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.kotlin.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 命令，但當專案包含 Wrapper 腳本時，最好改用它。

$ ./gradlew build

BUILD SUCCESSFUL in 0s
5 actionable tasks: 5 executed
第一次執行 Wrapper 腳本 gradlew 時，可能會有一段延遲，因為該版本的 gradle 會被下載並儲存在您本機的 ~/.gradle/wrapper/dists 資料夾中。

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

您可以透過開啟 HTML 輸出檔案來檢視測試報告，該檔案位於 lib/build/reports/tests/test/index.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 檔案 —MANIFEST.MF— 和編譯後的 Library 類別。

所有這些都在建置腳本中沒有任何額外配置的情況下發生，因為 Gradle 的 java-library 外掛程式假設您的專案原始碼是以 慣例專案版面配置排列的。如果您願意，可以自訂專案版面配置，如使用者手冊中所述。

恭喜，您剛剛完成了建立 Kotlin 函式庫的第一步！現在您可以根據自己的專案需求進行自訂。

自訂函式庫 JAR

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

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

除了版本之外，函式庫的其他重要身分屬性是它的名稱和 group。名稱直接從代表函式庫的子專案名稱衍生而來。在範例中是 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 檔案包含預期的版本。

另一個常見需求是自訂 manifest 檔案，通常是透過新增一個或多個屬性。讓我們透過配置 jar 工作，將函式庫名稱和版本包含在 manifest 檔案中。將以下內容新增至建置腳本的結尾

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 解壓縮 manifest 檔案

$ ./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 程式碼，來完成此練習。

後續步驟

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