第 1 部分：初始化專案 - Gradle 繁體中文

先使用 Gradle init 建立 Java app，了解撰寫 Gradle 的基礎知識。

在本節中，您將

初始化 Java 專案
檢閱目錄配置
執行 Java 應用程式
產生 Build Scan
將應用程式彙整到封存檔中

步驟 0. 開始前

請確定您已安裝 Gradle。
安裝IntelliJ IDEA。Community Edition 是 IntelliJ IDEA 的免費版本。

步驟 1. 初始化專案

建立一個名為 authoring-tutorial 的新目錄，並使用 cd 進入該目錄

$ mkdir authoring-tutorial

$ cd authoring-tutorial

執行 gradle init 並使用參數來產生 Java 應用程式

$ gradle init --type java-application  --dsl kotlin

$ gradle init --type java-application  --dsl groovy

對於任何其他提示，請選擇預設值。

在本教學課程中，所有範例都以 macOS 為基礎。

步驟 2. 了解目錄配置

專案根目錄包含專案中的所有原始檔。

當您完成 Gradle init 時，目錄應如下所示

.
├── gradle                              (1)
    ├── libs.version.toml               (2)
│   └── wrapper
├── 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

1	Wrapper 檔案的已產生資料夾
2	相依性的版本目錄
3	Gradle wrapper 啟動指令碼
4	定義建置名稱和子專案的設定檔
5	`app` 子專案的建置指令碼
6	`app` 子專案的預設 Java 原始碼資料夾
7	`app` 子專案的預設 Java 測試原始碼資料夾

.
├── gradle                              (1)
    ├── libs.version.toml               (2)
│   └── wrapper
├── 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	`app` 子專案的預設 Java 原始碼資料夾
7	`app` 子專案的預設 Java 測試原始碼資料夾

authoring-tutorial 資料夾是根專案目錄。在根專案目錄內有一個或多個子專案、建置指令碼和 Gradle wrapper。

雖然 Gradle Wrapper 是根專案的區域性，但 Gradle 可執行檔位於 GRADLE_USER_HOME 中。

GRADLE_USER_HOME 預設為 USER_HOME/.gradle，Gradle 也會將其全球組態屬性、初始化指令碼、快取、記錄檔等儲存在此處。

步驟 3. 檢閱 Gradle 檔案

settings.gradle(.kts) 檔案中有兩行有趣的程式碼

settings.gradle.kts

rootProject.name = "authoring-tutorial"
include("app")

settings.gradle

rootProject.name = 'authoring-tutorial'
include('app')

rootProject.name 為建置指定名稱，覆寫以其目錄名稱命名建置的預設行為。
include("app") 定義建置包含一個稱為 app 的子專案，其中包含其自己的原始碼和建置邏輯。

可透過其他 include() 陳述式新增更多子專案。

我們的建置包含一個稱為 app 的子專案，代表我們正在建置的 Java 應用程式。它在 app/build.gradle(.kts) 檔案中設定。

build.gradle.kts

plugins {
    id("application")                                               (1)
}

repositories {
    mavenCentral()                                                  (2)
}

dependencies {
    testImplementation(libs.junit.jupiter)                          (3)
    testRuntimeOnly("org.junit.platform:junit-platform-launcher")
    implementation(libs.guava)                                      (4)
}

java {
    toolchain {
        languageVersion = JavaLanguageVersion.of(11)                (5)
    }
}

application {
    mainClass = "org.example.App"                                   (6)
}

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

1	套用應用程式外掛程式，以新增支援在 Java 中建置 CLI 應用程式。
2	使用 Maven Central 來解析依賴項。
3	使用 JUnit Jupiter 進行測試（使用版本目錄）。
4	此依賴項由應用程式使用（使用版本目錄參照）。
5	定義工具鏈版本。
6	定義應用程式的 main 類別。
7	使用 JUnit Platform 進行單元測試。

plugins {
    id 'application'                                                (1)
}

repositories {
    mavenCentral()                                                  (2)
}

dependencies {
    testImplementation libs.junit.jupiter                           (3)
    testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
    implementation libs.guava                                       (4)
}

java {
    toolchain {
        languageVersion = JavaLanguageVersion.of(11)                (5)
    }
}

application {
    mainClass = 'org.example.App'                                   (6)
}

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

1	套用應用程式外掛程式，以新增支援在 Java 中建置 CLI 應用程式。
2	使用 Maven Central 來解析依賴項。
3	使用 JUnit Jupiter 進行測試（使用版本目錄）。
4	此依賴項由應用程式使用（使用版本目錄參照）。
5	定義工具鏈版本。
6	定義應用程式的 main 類別。
7	使用 JUnit Platform 進行單元測試。

app 子專案目錄中的建置指令碼宣告 app 程式碼組裝和測試所需的依賴項。

步驟 4. 檢閱程式碼

檔案 app/src/main/java/authoring/tutorial/App.java 包含專案的 main 類別

App.java

package authoring.tutorial;

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

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

程式碼會在螢幕上列印出一個簡單的「Hello World」問候語。

測試類別可在 app/src/test/java/authoring/tutorial/AppTest.java 找到

AppTest.java

package authoring.tutorial;

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 類別，呼叫其上的一個方法，並檢查它是否傳回預期的值。

步驟 5. 執行應用程式

應用程式外掛程式（由 gradle init 自動新增）有助於建立可執行的 JVM 應用程式

plugins {
    id("application")
}

plugins {
    id 'application'
}

套用應用程式外掛程式會隱含套用 Java 外掛程式，並將任務（如 assemble、build 和 run）新增至我們的專案。

多虧了 application 外掛程式，您可以直接從命令列執行應用程式。run 任務會指示 Gradle 執行指定給 mainClass 屬性的類別中的 main 方法。

$ ./gradlew run

> Task :app:run
Hello World!

BUILD SUCCESSFUL in 998ms
2 actionable tasks: 2 executed

步驟 6. 捆綁應用程式

application 外掛程式會為您封裝應用程式及其所有依賴項。封存檔中也會包含一個指令碼，可使用單一指令啟動應用程式。

執行 ./gradlew build

$ ./gradlew build

> Task :app:compileJava
> Task :app:processResources NO-SOURCE
> Task :app:classes
> Task :app:jar
> Task :app:startScripts
> Task :app:distTar
> Task :app:distZip
> Task :app:assemble
> Task :app:compileTestJava
> Task :app:processTestResources NO-SOURCE
> Task :app:testClasses
> Task :app:test
> Task :app:check
> Task :app:build

BUILD SUCCESSFUL in 5s

如果您執行如上所示的完整建置，Gradle 會產生兩種格式的封存檔：app/build/distributions/app.tar 和 app/build/distributions/app.zip。

步驟 6. 發布建置掃描

深入了解建置在幕後執行作業的最佳方式，是發布建置掃描。為此，請再次執行 build 任務，並加上 --scan 旗標。

$ ./gradlew build --scan
> Task :app:compileJava UP-TO-DATE
> Task :app:processResources NO-SOURCE
> Task :app:classes UP-TO-DATE
> Task :app:jar UP-TO-DATE
> Task :app:startScripts UP-TO-DATE
> Task :app:distTar UP-TO-DATE
> Task :app:distZip UP-TO-DATE
> Task :app:assemble UP-TO-DATE
> Task :app:compileTestJava UP-TO-DATE
> Task :app:processTestResources NO-SOURCE
> Task :app:testClasses UP-TO-DATE
> Task :app:test UP-TO-DATE
> Task :app:check UP-TO-DATE
> Task :app:build UP-TO-DATE

BUILD SUCCESSFUL in 1s
7 actionable tasks: 7 up-to-date
Resolving local hostname is slow, see https://gradle.com/help/gradle-slow-host-name

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/link

按一下連結，探索執行哪些任務、下載哪些相依性，以及更多詳細資訊

下一步： 建置生命週期 >>

此頁面有幫助嗎？