您可以在支持 Gradle 的 IDE中打开此样本项目。

本指南演示了如何使用 gradle init 通过 Gradle 创建一个 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。对于其他问题，按回车键使用默认值。

输出将如下所示

$ 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 用于定义构建名称和子项目的 settings 文件
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 Library Plugin 文档中找到。

组装库 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'

除了版本之外，库的其他重要身份属性是其名称和组。名称直接来源于表示该库的子项目名称。在本例中是 lib，所以您可能需要通过更改 lib 文件夹的名称以及 settings.gradle(.kts) 文件中对应的 include(…​) 语句来调整它。发布时，组用于为您的库提供完整的坐标。您可以直接在构建脚本中设置 group 属性，就像设置版本一样（如上所示）。

现在运行 jar 任务

$ ./gradlew jar

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

您会注意到生成的 JAR 文件位于 lib/build/libs/lib-0.1.0.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

生成 Sources JAR

您可以轻松地为您的库生成 Sources 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 代码来完成此练习。

下一步

构建库只是跨项目边界重用代码的一个方面。接下来，您可能会对以下内容感兴趣