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

本指南演示了如何使用 gradle init 通过 Gradle 创建 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。对于其他问题，按回车键使用默认值。

输出如下所示

$ 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 生成的 wrapper 文件文件夹
2 生成的版本目录
3 Gradle wrapper 启动脚本
4 Settings 文件，用于定义构建名称和子项目
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 应用 application 插件，以支持构建 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/AppTest.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 应用程序项目，请查阅以下用户手册章节