构建 Kotlin 库示例 - Gradle 中文

您可以使用 IntelliJ 原生导入器或 Eclipse Buildship 在 IDE 中打开此示例。

本指南演示了如何使用 gradle init 创建一个 Kotlin 库，该库遵循 Gradle 的约定。您可以按照指南一步一步地从头开始创建一个新项目，或者使用上面的链接下载完整的示例项目。

您将构建的内容

您将生成一个遵循 Gradle 约定的 Kotlin 库。

您需要的内容

文本编辑器或 IDE - 例如 IntelliJ IDEA
Java 开发工具包 (JDK)，版本 8 或更高 - 例如 AdoptOpenJDK
最新的 Gradle 发行版

创建项目文件夹

Gradle 带有一个内置的任务，称为 init，它可以在空文件夹中初始化一个新的 Gradle 项目。init 任务使用（也是内置的）wrapper 任务来创建一个 Gradle 包装器脚本，gradlew。

第一步是为新项目创建一个文件夹，并进入该文件夹。

$ mkdir demo
$ cd demo

运行 init 任务

在新的项目目录中，使用终端中的以下命令运行 init 任务：gradle init。当提示时，选择 2: library 项目类型和 2: Kotlin 作为实现语言。接下来，您可以选择用于编写构建脚本的 DSL - 1 : Groovy 或 2: Kotlin。对于其他问题，按回车键使用默认值。

输出将如下所示

$ 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 代码来完成此练习。

下一步

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