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

本指南演示了如何使用 Gradle 和 gradle init 创建 Java 库。你可以按照指南逐步从头开始创建新项目，或者使用上面的链接下载完整的示例项目。

你将构建什么

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

你需要什么

  • 文本编辑器或 IDE - 例如 IntelliJ IDEA

  • Java 开发工具包 (JDK)，版本 8 或更高版本 - 例如 AdoptOpenJDK

  • 最新的 Gradle 发行版

创建项目文件夹

Gradle 自带一个内置的 task，称为 init，它在空文件夹中初始化一个新的 Gradle 项目。init task 使用（也是内置的）wrapper task 来创建 Gradle wrapper 脚本 gradlew。

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

$ mkdir demo
$ cd demo

运行 init task

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

├── 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 用于定义构建名称和子项目的 Settings 文件
5 lib 项目的 Build 脚本
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 此依赖项导出给使用者，也就是说在他们的编译 classpath 中可以找到。
5 此依赖项在内部使用，不会暴露给使用者自己的编译 classpath。
6 使用 JUnit Platform 进行单元测试。

文件 src/main/java/demo/Library.java 如下所示

Generated 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 接下来显示

Generated 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 Library Plugin 文档。

组装库 JAR

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

$ ./gradlew build

BUILD SUCCESSFUL in 0s
4 actionable tasks: 4 executed
首次运行 wrapper 脚本 gradlew 时，可能会有延迟，因为该版本的 gradle 需要下载并本地存储在你的 ~/.gradle/wrapper/dists 文件夹中。

首次运行构建时，Gradle 将检查你的 ~/.gradle 目录下缓存中是否已有所需的依赖项。如果没有，将下载库并存储在那里。下次运行构建时，将使用缓存的版本。build task 编译类、运行测试并生成测试报告。

你可以通过打开 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 类。

所有这些操作都不需要在 build 脚本中进行任何额外配置，因为 Gradle 的 java-library 插件假定你的项目源文件按照 约定俗成的项目布局 进行组织。如果你愿意，可以自定义项目布局，具体方法请参考 用户手册中的描述。

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

自定义库 JAR

你通常会希望 JAR 文件的名称包含库*版本*。这可以通过在 build 脚本中设置顶层 version 属性来实现

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

除了版本之外，库的其他重要标识属性是*名称*和*组*。名称直接从代表库的子项目名称派生而来。在示例中它是 lib，因此你可能需要通过更改 lib 文件夹的名称以及 settings.gradle(.kts) 文件中相应的 include(…​) 语句来调整它。*group* 用于在发布时为你的库提供完整的坐标。你可以通过在 build 脚本中设置 group 属性（类似于你设置版本的方式，如上所示）直接定义它。

现在运行 jar task

$ ./gradlew jar

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

你会注意到 lib/build/libs/lib-0.1.0.jar 中生成的 JAR 文件包含预期的版本。

另一个常见的要求是自定义 manifest 文件，通常是通过添加一个或多个属性。让我们通过 配置 jar task 将库名称和版本包含在 manifest 文件中。将以下内容添加到你的 build 脚本末尾

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 task，这次还要从 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 生命周期 task 的一部分生成，并将成为发布的一部分。生成的文件位于 lib/build/libs 中，名称使用约定俗成的分类器 -sources。

添加 API 文档

java-library 插件通过 javadoc task 内置了对 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 task。

$ ./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 生命周期 task 的一部分生成，并将成为发布的一部分。生成的文件位于 lib/build/libs 中，名称使用约定俗成的分类器 -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

点击链接，探索执行了哪些 task，下载了哪些依赖项以及更多细节！

总结

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

  • 初始化一个生成 Java 库的项目

  • 运行构建并查看测试报告

  • 自定义构建生成的 Jar 文件

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

下一步

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