建立 Kotlin 應用程式範例 - Gradle 繁體中文

您可以使用 IntelliJ 原生匯入器或 Eclipse Buildship 在 IDE 中開啟這個範例。

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

您將組建的內容

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

您將需要的內容

文字編輯器或 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 專案類型和 2: Kotlin 作為實作語言。接著，您可以選擇用於撰寫建置指令碼的 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] 2

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

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
        │   └── 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	產生包裝檔案的資料夾
2	產生版本目錄
3	Gradle 包裝程式啟動指令碼
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.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.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	定義應用程式的 main 類別。
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

您第一次執行包裝器指令碼 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。

發佈建置掃描

進一步瞭解您的建置在幕後執行的最佳方法，就是發佈建置掃描。為此，只要執行 Gradle 並加上 --scan 旗標即可。

$ ./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 應用程式專案，請查看下列使用者手冊章節