构建 Java 库示例 - Gradle 构建系统

您可以在支持 Gradle 的 IDE 中打开此示例。

本指南演示了如何使用 gradle init 命令通过 Gradle 创建 Java 库。您可以按照本指南一步一步地从零开始创建一个新项目，或使用上面的链接下载完整的示例项目。

您将构建什么

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

您将需要什么

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

创建项目文件夹

Gradle 带有一个内置任务，称为 init，用于在空文件夹中初始化新的 Gradle 项目。init 任务使用（同样内置的）wrapper 任务来创建 Gradle wrapper 脚本 gradlew。

第一步是为新项目创建一个文件夹并切换到该目录。

$ mkdir demo
$ cd demo

运行 init 任务

在新项目目录中，在终端中使用以下命令运行 init 任务：gradle init。出现提示时，选择项目类型 2: library 和实现语言 1: Java。接下来，您可以选择用于编写构建脚本的 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] 1

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

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

1	生成的 wrapper 文件目录
2	生成的版本目录
3	Gradle wrapper 启动脚本
4	定义构建名称和子项目的设置文件
5	`lib` 项目的构建脚本
6	默认 Java 源码目录
7	默认 Java 测试源码目录

您现在已经设置好了构建 Java 库的项目。

审查项目文件

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 的子项目，它代表我们正在构建的 Java 库。它在 lib/build.gradle(.kts) 文件中配置。

lib/build.gradle.kts

plugins {
    `java-library` (1)
}

repositories {
    mavenCentral() (2)
}

dependencies {
    testImplementation(libs.junit.jupiter) (3)

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

    api(libs.commons.math3) (4)

    implementation(libs.guava) (5)
}

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

lib/build.gradle

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

repositories {
    mavenCentral() (2)
}

dependencies {
    testImplementation libs.junit.jupiter (3)

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

    api libs.commons.math3 (4)

    implementation libs.guava (5)
}

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

1	应用 java-library 插件以实现 API 和实现的隔离。
2	使用 Maven Central 解析依赖。
3	使用 JUnit Jupiter 进行测试。
4	此依赖项会导出给消费者，也就是说，它会出现在消费者的编译类路径上。
5	此依赖项在内部使用，不会暴露给消费者的编译类路径。
6	使用 JUnit Platform 进行单元测试。

文件 src/main/java/demo/Library.java 内容如下

生成的 src/main/java/demo/Library.java

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

public class Library {
    public boolean someLibraryMethod() {
        return true;
    }
}

生成的测试文件 src/test/java/demo/Library.java 内容如下

生成的 src/test/java/demo/LibraryTest.java

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

import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.*;

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

生成的测试类包含一个 *JUnit Jupiter* 测试。该测试实例化 Library 类，调用其方法，并检查它是否返回预期值。

关于 java-library 插件为任何 JVM 库项目添加的功能（例如 API 和实现的隔离）的更多信息，请参阅Java 库插件文档。

组装库 JAR

要构建项目，请运行 build 任务。您可以使用常规的 gradle 命令，但当项目包含 wrapper 脚本时，建议使用它。

$ ./gradlew build

BUILD SUCCESSFUL in 0s
4 actionable tasks: 4 executed

首次运行 wrapper 脚本 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 文件 —MANIFEST.MF— 和已编译的 Library 类。

所有这些都无需在构建脚本中进行额外配置，因为 Gradle 的 java-library 插件假定您的项目源码按照约定俗成的项目布局进行组织。如果您希望自定义项目布局，可以按照用户手册中的描述进行。

恭喜，您已完成了创建 Java 库的第一步！现在您可以根据自己的项目需求进行自定义。

自定义库 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 文件如预期地包含了版本信息。

另一个常见的需求是自定义 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 中，名称使用约定俗成的 classifier -sources。

添加 API 文档

java-library 插件通过 javadoc 任务内置支持 Java 的 API 文档工具。

Build Init 插件生成的代码已经在 demo/Library.java 文件上放置了一个注释。将注释中的 /** 替换为 /*，使其成为 javadoc 标记：

src/main/java/demo/Library.java

/**
 * This java source file was generated by the Gradle 'init' task.
 */
 ...

运行 javadoc 任务。

$ ./gradlew javadoc

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

您可以通过打开位于 lib/build/docs/javadoc/index.html 的 HTML 文件来查看生成的 javadoc 文件。

您也可以为您的库生成 Javadoc JAR

build.gradle.kts

java {
    withJavadocJar()
}

build.gradle

java {
    withJavadocJar()
}

额外的 JAR 将作为 assemble 或 build 生命周期任务的一部分生成，并作为发布的一部分。生成的文件位于 lib/build/libs 中，名称使用约定俗成的 classifier -javadoc。

发布构建扫描

了解构建在后台做了什么的最好方法是发布构建扫描。为此，只需使用 --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

点击链接，探索执行了哪些任务、下载了哪些依赖项以及更多详细信息！

总结

就是这样！您现在已成功使用 Gradle 配置并构建了一个 Java 库项目。您已经学会了如何：

初始化一个生成 Java 库的项目
运行构建并查看测试报告
自定义构建生成的 Jar 文件

现在，您可以尝试编译一些使用您刚刚构建的库的 Java 代码来完成本练习。

下一步

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