构建 Groovy 应用程序示例

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

本指南演示了如何使用 gradle init 创建一个使用 Gradle 的 Groovy 应用程序。您可以按照指南逐步操作，从头开始创建一个新项目，也可以使用上面的链接下载完整的示例项目。

您将构建的内容

您将生成一个遵循 Gradle 约定的 Groovy 应用程序。

您需要的内容

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

创建项目文件夹

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

第一步是为新项目创建一个文件夹，并更改到该文件夹。

$ mkdir demo
$ cd demo

运行 init 任务

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

输出将如下所示

$ gradle init

Select type of project to generate:
  1: basic
  2: application
  3: library
  4: Gradle plugin
Enter selection (default: basic) [1..4] 1

Select implementation language:
  1: C++
  2: Groovy
  3: Java
  4: Kotlin
  5: Scala
  6: Swift
Enter selection (default: Java) [1..6] 3

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)
└── app
    ├── build.gradle.kts (5)
    └── src
        ├── main
        │   └── groovy (6)
        │       └── demo
        │           └── App.groovy
        └── test
            └── groovy (7)
                └── demo
                    └── AppTest.groovy

├── gradle (1)
│   ├── libs.versions.toml (2)
│   └── wrapper
│       ├── gradle-wrapper.jar
│       └── gradle-wrapper.properties
├── gradlew (3)
├── gradlew.bat (3)
├── settings.gradle (4)
└── app
    ├── build.gradle (5)
    └── src
        ├── main
        │   └── groovy (6)
        │       └── demo
        │           └── App.groovy
        └── test
            └── groovy (7)
                └── demo
                    └── AppTest.groovy

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

现在您已设置好项目，可以构建 Groovy 应用程序。

查看项目文件

settings.gradle(.kts) 文件有两行有趣的代码

settings.gradle.kts

rootProject.name = "demo"
include("app")

settings.gradle

rootProject.name = 'demo'
include('app')

rootProject.name 为构建分配一个名称，这会覆盖将构建命名为其所在目录的默认行为。建议设置一个固定名称，因为如果项目是共享的（例如作为 Git 存储库的根目录），文件夹可能会更改。
include("app") 定义构建包含一个名为 app 的子项目，该子项目包含实际代码和构建逻辑。可以通过添加其他 include(…) 语句来添加更多子项目。

我们的构建包含一个名为 app 的子项目，它代表我们正在构建的 Groovy 应用程序。它在 app/build.gradle(.kts) 文件中配置

app/build.gradle.kts

plugins {
    groovy (1)
    application (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")
}

application {
    mainClass = "demo.App" (7)
}

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

app/build.gradle

plugins {
    id 'groovy' (1)
    id 'application' (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'
}

application {
    mainClass = 'demo.App' (7)
}

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

1	应用 groovy 插件以添加对 Groovy 的支持。
2	应用 application 插件以添加对在 Java 中构建 CLI 应用程序的支持。
3	使用 Maven Central 来解析依赖项。
4	使用最新的 Groovy 版本来构建此库
5	应用程序使用此依赖项。
6	即使使用 Java，也要使用出色的 Spock 测试和规范框架
7	定义应用程序的主类。
8	使用 JUnit Platform 进行单元测试。

此处显示文件 src/main/groovy/demo/App.groovy

生成的 src/main/groovy/demo/App.groovy

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

class App {
    String getGreeting() {
        return 'Hello World!'
    }

    static void main(String[] args) {
        println new App().greeting
    }
}

接下来显示生成的测试 src/test/groovy/demo/App.groovy

生成的 src/test/groovy/demo/AppTest.groovy

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

import spock.lang.Specification

class AppTest extends Specification {
    def "application has a greeting"() {
        setup:
        def app = new App()

        when:
        def result = app.greeting

        then:
        result != null
    }
}

生成的测试类包含一个 Spock 测试。该测试实例化 App 类，在该类上调用一个方法，并检查它是否返回预期值。

运行应用程序

由于 application 插件，您可以直接从命令行运行应用程序。run 任务告诉 Gradle 执行分配给 mainClass 属性的类中的 main 方法。

$ ./gradlew run

> Task :app:run
Hello world!

BUILD SUCCESSFUL
2 actionable tasks: 2 executed

第一次运行包装器脚本 gradlew 时，可能会延迟一段时间，因为该版本的 gradle 将被下载并存储在本地 ~/.gradle/wrapper/dists 文件夹中。

打包应用程序

application 插件还会将应用程序及其所有依赖项打包在一起。归档文件还将包含一个脚本，用于使用单个命令启动应用程序。

$ ./gradlew build

BUILD SUCCESSFUL in 0s
7 actionable tasks: 7 executed

如果您运行如上所示的完整构建，Gradle 将为您生成两种格式的归档文件：app/build/distributions/app.tar 和 app/build/distributions/app.zip。

发布构建扫描

了解构建在幕后执行情况的最佳方法是发布一个构建扫描。为此，只需使用 --scan 标志运行 Gradle。

$ ./gradlew build --scan

BUILD SUCCESSFUL in 0s
7 actionable tasks: 7 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 应用程序的项目
运行构建并查看测试报告
使用 application 插件中的 run 任务执行 Groovy 应用程序
将应用程序打包到归档文件中

下一步

要了解有关如何进一步自定义 Groovy 应用程序项目的更多信息，请查看以下用户手册章节