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

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

您將建置的內容

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

您需要的內容

建立專案資料夾

Gradle 隨附一個內建任務，稱為 init，可在空的資料夾中初始化新的 Gradle 專案。init 任務使用（也是內建的）wrapper 任務來建立 Gradle Wrapper 腳本 gradlew。

第一步是為新專案建立資料夾，並將目錄變更為該資料夾。

$ mkdir demo
$ cd demo

執行 init 任務

從新專案目錄內，在終端機中使用以下命令執行 init 任務：gradle init。出現提示時，選取 1: application 專案類型和 2: Kotlin 作為實作語言。接下來，您可以選擇用於編寫建置腳本的 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] 2

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
        │   └── kotlin (6)
        │       └── demo
        │           └── App.kt
        └── test
            └── kotlin (7)
                └── demo
                    └── AppTest.kt
├── 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
        │   └── kotlin (6)
        │       └── demo
        │           └── App.kt
        └── test
            └── kotlin (7)
                └── demo
                    └── AppTest.kt
1 為 Wrapper 檔案產生的資料夾
2 產生的版本目錄
3 Gradle Wrapper 啟動腳本
4 用於定義建置名稱和子專案的設定檔
5 app 專案的建置腳本
6 預設 Kotlin 原始碼資料夾
7 預設 Kotlin 測試原始碼資料夾

您現在已設定專案以建置 Kotlin 應用程式。

檢閱專案檔案

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 的子專案，代表我們正在建置的 Kotlin 應用程式。它在 app/build.gradle(.kts) 檔案中配置

app/build.gradle.kts
plugins {
    alias(libs.plugins.kotlin.jvm) (1)
    application (2)
}

repositories {
    mavenCentral() (3)
}

dependencies {
    testImplementation("org.jetbrains.kotlin:kotlin-test-junit5") (4)

    testImplementation(libs.junit.jupiter.engine) (5)

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

    implementation(libs.guava) (6)
}

application {
    mainClass = "demo.AppKt" (7)
}

tasks.named<Test>("test") {
    useJUnitPlatform() (8)
}
app/build.gradle
plugins {
    alias(libs.plugins.kotlin.jvm) (1)
    id 'application' (2)
}

repositories {
    mavenCentral() (3)
}

dependencies {
    testImplementation 'org.jetbrains.kotlin:kotlin-test-junit5' (4)

    testImplementation libs.junit.jupiter.engine (5)

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

    implementation libs.guava (6)
}

application {
    mainClass = 'demo.AppKt' (7)
}

tasks.named('test') {
    useJUnitPlatform() (8)
}
1 套用 org.jetbrains.kotlin.jvm 外掛程式以新增對 Kotlin 的支援。
2 套用 application 外掛程式以新增對在 Java 中建置 CLI 應用程式的支援。
3 使用 Maven Central 解析依賴項目。
4 使用 Kotlin JUnit 5 整合。
5 使用 JUnit 5 整合。
6 此依賴項目由應用程式使用。
7 定義應用程式的主要類別。
8 使用 JUnit Platform 進行單元測試。

檔案 src/main/kotlin/demo/App.kt 如下所示

產生的 src/main/kotlin/demo/App.kt
/*
 * This source file was generated by the Gradle 'init' task
 */
package demo

class App {
    val greeting: String
        get() {
            return "Hello World!"
        }
}

fun main() {
    println(App().greeting)
}

產生的測試 src/test/kotlin/demo/App.kt 如下所示

產生的 src/test/kotlin/demo/AppTest.kt
/*
 * This source file was generated by the Gradle 'init' task
 */
package demo

import kotlin.test.Test
import kotlin.test.assertNotNull

class AppTest {
    @Test fun appHasAGreeting() {
        val classUnderTest = App()
        assertNotNull(classUnderTest.greeting, "app should have a greeting")
    }
}

產生的測試類別具有單一 kotlin.test 測試。此測試會實例化 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
8 actionable tasks: 8 executed

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

發布建置掃描

要深入了解您的建置在幕後執行的操作，最好的方法是發布建置掃描。若要執行此操作，只需使用 --scan 旗標執行 Gradle 即可。

$ ./gradlew build --scan

BUILD SUCCESSFUL in 0s
8 actionable tasks: 8 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 成功配置和建置 Kotlin 應用程式專案。您已學習如何

  • 初始化產生 Kotlin 應用程式的專案

  • 執行建置並檢視測試報告

  • 使用來自 application 外掛程式的 run 任務執行 Kotlin 應用程式

  • 將應用程式捆綁在封存檔中

後續步驟

若要深入了解如何進一步自訂 Kotlin 應用程式專案，請查看以下使用者手冊章節