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

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

您将构建什么

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

您需要什么

创建项目文件夹

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

第一步是为新项目创建一个文件夹并进入该文件夹。

$ mkdir demo
$ cd demo

运行 init 任务

在新项目目录中，在终端中使用以下命令运行 init 任务：gradle init。当提示时，选择 1: application 项目类型和 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] 1

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)
└── app
    ├── build.gradle.kts (5)
    └── src
        ├── main
        │   └── java (6)
        │       └── demo
        │           └── App.java
        └── test
            └── java (7)
                └── demo
                    └── AppTest.java
├── 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
        │   └── java (6)
        │       └── demo
        │           └── App.java
        └── test
            └── java (7)
                └── demo
                    └── AppTest.java
1 为包装器文件生成的文件夹
2 生成的版本目录
3 Gradle 包装器启动脚本
4 定义构建名称和子项目的设置文件
5 app 项目的构建脚本
6 默认 Java 源文件夹
7 默认 Java 测试源文件夹

您现在已经设置好项目来构建一个 Java 应用程序。

审查项目文件

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

app/build.gradle.kts
plugins {
    application (1)
}

repositories {
    mavenCentral() (2)
}

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

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

    implementation(libs.guava) (4)
}

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

tasks.named<Test>("test") {
    useJUnitPlatform() (6)
}
app/build.gradle
plugins {
    id 'application' (1)
}

repositories {
    mavenCentral() (2)
}

dependencies {
    testImplementation libs.junit.jupiter (3)

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

    implementation libs.guava (4)
}

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

tasks.named('test') {
    useJUnitPlatform() (6)
}
1 应用应用程序插件以添加对在 Java 中构建 CLI 应用程序的支持。
2 使用 Maven Central 解析依赖项。
3 使用 JUnit Jupiter 进行测试。
4 此依赖项由应用程序使用。
5 定义应用程序的主类。
6 使用 JUnit Platform 进行单元测试。

文件 src/main/java/demo/App.java 显示如下

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

public class App {
    public String getGreeting() {
        return "Hello World!";
    }

    public static void main(String[] args) {
        System.out.println(new App().getGreeting());
    }
}

生成的测试 src/test/java/demo/App.java 显示如下

生成的 src/test/java/demo/AppTest.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 AppTest {
    @Test void appHasAGreeting() {
        App classUnderTest = new App();
        assertNotNull(classUnderTest.getGreeting(), "app should have a greeting");
    }
}

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

运行应用程序

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

$ ./gradlew run

> Task :app:run
Hello world!

BUILD SUCCESSFUL
2 actionable tasks: 2 executed
首次运行 wrapper 脚本 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 配置并构建了一个 Java 应用程序项目。您已经学会了如何

  • 初始化生成 Java 应用程序的项目

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

  • 使用 application 插件的 run 任务执行 Java 应用程序

  • 将应用程序打包成存档

后续步骤

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