你可以在支援 Gradle 的 IDE 中開啟此範例。

本指南示範如何使用 gradle init 和 Gradle 建立 Java 應用程式。你可以按照指南逐步從頭開始建立新專案，或使用上方連結下載完整的範例專案。

你將建置什麼

你將產生一個遵循 Gradle 慣例的 Java 應用程式。

你需要什麼

  • 文字編輯器或 IDE - 例如 IntelliJ IDEA

  • Java 開發工具包 (JDK)，版本 8 或更高版本 - 例如 AdoptOpenJDK

  • 最新的 Gradle 發行版本

建立專案資料夾

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 產生用於 Wrapper 檔案的資料夾
2 產生版本目錄
3 Gradle Wrapper 啟動腳本
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 應用 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/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 應用程式專案，請查看以下使用者手冊章節