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

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

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

您将构建什么

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

您需要什么

一个文本编辑器或 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` 项目类型和 `4: Scala` 作为实现语言。接下来，您可以选择用于编写构建脚本的 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] 4

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

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

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

您现在已经设置好项目以构建 Scala 库。

审查项目文件

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

lib/build.gradle.kts

plugins {
    scala (1)
    `java-library` (2)
}

repositories {
    mavenCentral() (3)
}

dependencies {
    implementation(libs.scala.library) (4)

    implementation(libs.guava) (5)

    testImplementation(libs.junit) (6)
    testImplementation(libs.scalatest.v2.v13)
    testImplementation(libs.junit.v4.v13.v2.v13)

    testRuntimeOnly(libs.scala.xml.v2.v13) (7)

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

lib/build.gradle

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

repositories {
    mavenCentral() (3)
}

dependencies {
    implementation libs.scala.library (4)

    implementation libs.guava (5)

    testImplementation libs.junit (6)
    testImplementation libs.scalatest.v2.v13
    testImplementation libs.junit.v4.v13.v2.v13

    testRuntimeOnly libs.scala.xml.v2.v13 (7)

    api libs.commons.math3 (8)
}

1	应用 Scala 插件以添加对 Scala 的支持。
2	应用 `java-library` 插件以实现 API 和实现分离。
3	使用 Maven Central 解析依赖项。
4	在我们的库项目中使用 Scala 2.13
5	此依赖项在内部使用，不会向消费者自己的编译类路径公开。
6	使用 Scalatest 测试我们的库
7	测试运行时需要 scala-xml
8	此依赖项导出给消费者，即在其编译类路径中找到。

文件 `src/main/scala/demo/Library.scala` 显示如下

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

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

class Library {
  def someLibraryMethod(): Boolean = true
}

生成的测试文件 `src/test/scala/demo/Library.scala` 显示如下

生成的 src/test/scala/demo/LibrarySuite.scala

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

import org.scalatest.funsuite.AnyFunSuite
import org.junit.runner.RunWith
import org.scalatestplus.junit.JUnitRunner

@RunWith(classOf[JUnitRunner])
class LibrarySuite extends AnyFunSuite {
  test("someLibraryMethod is always true") {
    def library = new Library()
    assert(library.someLibraryMethod())
  }
}

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

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

组装库 JAR

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

$ ./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.MF`— 和已编译的 `Library` 类。

所有这些都无需在构建脚本中进行任何额外配置，因为 Gradle 的 `java-library` 插件假定您的项目源文件按照常规项目布局进行组织。如果您愿意，可以按照用户手册中的描述自定义项目布局。

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

自定义库 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
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 配置和构建了一个 Scala 库项目。您已学会如何

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

现在您可以通过尝试编译使用您刚刚构建的库的 Scala 代码来完成此练习。

后续步骤

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