您可以使用 IntelliJ 原生匯入程式 或 Eclipse Buildship 在 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 : 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] 1

Select build script DSL:
  1: Groovy
  2: Kotlin
Enter selection (default: Groovy) [1..2] 1

Select test framework:
  1: JUnit 4
  2: TestNG
  3: Spock
  4: JUnit Jupiter
Enter selection (default: JUnit 4) [1..4]

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
        │   └── 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 定義應用程式的 main 類別。
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 應用程式專案，請查看下列使用者手冊章節