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

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

您將建置什麼

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

您需要什麼

建立專案資料夾

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

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

$ mkdir demo
$ cd demo

執行 init task

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

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]

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 task 會使用以下結構產生新專案

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

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

檢閱專案檔案

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

app/build.gradle.kts
plugins {
    scala (1)
    application (2)
}

repositories {
    mavenCentral() (3)
}

dependencies {
    implementation(libs.scala.library) (4)

    implementation(libs.guava) (5)

    testImplementation(libs.junit) (6)
    testImplementation(libs.scalatest.v2.v13)
    testImplementation(libs.junit.v4.v13.v2.v13)

    testRuntimeOnly(libs.scala.xml.v2.v13) (7)
}

application {
    mainClass = "demo.App" (8)
}
app/build.gradle
plugins {
    id 'scala' (1)
    id 'application' (2)
}

repositories {
    mavenCentral() (3)
}

dependencies {
    implementation libs.scala.library (4)

    implementation libs.guava (5)

    testImplementation libs.junit (6)
    testImplementation libs.scalatest.v2.v13
    testImplementation libs.junit.v4.v13.v2.v13

    testRuntimeOnly libs.scala.xml.v2.v13 (7)
}

application {
    mainClass = 'demo.App' (8)
}
1 套用 scala 外掛程式以新增對 Scala 的支援。
2 套用 application 外掛程式以新增對在 Java 中建置 CLI 應用程式的支援。
3 使用 Maven Central 來解析依賴關係。
4 在我們的函式庫專案中使用 Scala 2.13
5 應用程式會使用此依賴關係。
6 使用 Scalatest 來測試我們的函式庫
7 在測試執行階段需要 scala-xml
8 定義應用程式的主要類別。

檔案 src/main/scala/demo/App.scala 顯示如下

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

object App {
  def main(args: Array[String]): Unit = {
    println(greeting())
  }

  def greeting(): String = "Hello, world!"
}

產生的測試 src/test/scala/demo/App.scala 顯示如下

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

import org.scalatest.funsuite.AnyFunSuite
import org.junit.runner.RunWith
import org.scalatestplus.junit.JUnitRunner

@RunWith(classOf[JUnitRunner])
class AppSuite extends AnyFunSuite {
  test("App has a greeting") {
    assert(App.greeting() != null)
  }
}

產生的測試類別具有單一 ScalaTest 測試。此測試實例化 App 類別，在其上調用方法，並檢查它是否傳回預期的值。

執行應用程式

由於有 application 外掛程式，您可以直接從命令列執行應用程式。run task 指示 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。

發布 Build Scan

了解更多關於您的建置在幕後執行什麼的最佳方法，是發布 build scan。若要執行此操作，只需使用 --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

點擊連結並探索執行了哪些 task、下載了哪些依賴關係以及更多詳細資訊！

摘要

就是這樣！您現在已使用 Gradle 成功配置和建置 Scala 應用程式專案。您已學會如何

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

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

  • 使用來自 application 外掛程式的 run task 執行 Scala 應用程式

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

下一步

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