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

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

你将构建什么

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

你需要什么

创建项目文件夹

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

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

$ mkdir demo
$ cd demo

运行 init 任务

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

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]

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
        │   └── groovy (6)
        │       └── demo
        │           └── Library.groovy
        └── test
            └── groovy (7)
                └── demo
                    └── LibraryTest.groovy
├── 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
        │   └── groovy (6)
        │       └── demo
        │           └── Library.groovy
        └── test
            └── groovy (7)
                └── demo
                    └── LibraryTest.groovy
1 生成的 wrapper 文件文件夹
2 生成的版本目录
3 Gradle wrapper 启动脚本
4 用于定义构建名称和子项目的 Settings 文件
5 lib 项目的构建脚本
6 默认 Groovy 源文件文件夹
7 默认 Groovy 测试源文件文件夹

你现在已经设置好构建 Groovy 库的项目了。

查看项目文件

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

lib/build.gradle.kts
plugins {
    groovy (1)
    `java-library` (2)
}

repositories {
    mavenCentral() (3)
}

dependencies {
    implementation(libs.groovy.all) (4)

    implementation(libs.guava) (5)

    testImplementation(libs.spock.core) (6)
    testImplementation(libs.junit)

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

    api(libs.commons.math3) (7)
}

tasks.named<Test>("test") {
    useJUnitPlatform() (8)
}
lib/build.gradle
plugins {
    id 'groovy' (1)
    id 'java-library' (2)
}

repositories {
    mavenCentral() (3)
}

dependencies {
    implementation libs.groovy.all (4)

    implementation libs.guava (5)

    testImplementation libs.spock.core (6)
    testImplementation libs.junit

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

    api libs.commons.math3 (7)
}

tasks.named('test') {
    useJUnitPlatform() (8)
}
1 应用 groovy 插件以添加对 Groovy 的支持。
2 应用 java-library 插件用于 API 和实现分离。
3 使用 Maven Central 解析依赖项。
4 使用最新的 Groovy 版本构建此库
5 此依赖项用于内部使用，不会暴露给消费者的编译类路径。
6 使用出色的 Spock 测试和规范框架，即使与 Java 一起使用
7 此依赖项会导出给消费者，即可以在其编译类路径中找到。
8 使用 JUnit Platform 进行单元测试。

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

生成的 src/main/groovy/demo/Library.groovy
/*
 * This source file was generated by the Gradle 'init' task
 */
package demo

class Library {
    boolean someLibraryMethod() {
        true
    }
}

生成的测试文件 src/test/groovy/demo/Library.groovy 如下所示

生成的 src/test/groovy/demo/LibraryTest.groovy
/*
 * This source file was generated by the Gradle 'init' task
 */
package demo

import spock.lang.Specification

class LibraryTest extends Specification {
    def "someLibraryMethod returns true"() {
        setup:
        def lib = new Library()

        when:
        def result = lib.someLibraryMethod()

        then:
        result == true
    }
}

生成的测试类有一个 Spock 测试。该测试实例化 Library 类，调用其上的方法，并检查它是否返回期望的值。

关于 java-library 插件添加到任何 JVM 库项目的特性（如 API 和实现分离）的更多信息，可以在 Java Library Plugin 文档中找到。

组装库 JAR

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

$ ./gradlew build

BUILD SUCCESSFUL in 0s
4 actionable tasks: 4 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 插件假定你的项目源文件按照常规项目布局排列。如果你愿意，可以按照用户手册中的描述自定义项目布局。

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

自定义库 JAR

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

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

除了版本之外，库的其他重要标识属性是其名称和组 (group)。名称直接来源于代表库的子项目名称。在示例中它是 lib，因此你可能需要通过更改 lib 文件夹的名称以及 settings.gradle(.kts) 文件中相应的 include(…​) 语句来调整它。组 (group) 用于在发布库时为其提供完整的坐标。你可以通过在构建脚本中设置 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。

发布构建扫描

了解构建在幕后执行了哪些操作的最佳方式是发布一个构建扫描。为此，只需运行 Gradle 时带上 --scan 标志。

$ ./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 构建了一个 Groovy 库项目。你已经学会了如何：

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

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

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

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

下一步

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