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

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

您將建置的內容

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

您將需要的內容

建立專案資料夾

Gradle 內建一個名為 init 的工作，會在空的資料夾中初始化新的 Gradle 專案。init 工作會使用（也內建）wrapper 工作建立 Gradle wrapper 腳本 gradlew。

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

$ mkdir demo
$ cd demo

執行 init 工作

從新專案目錄內，在終端機中使用下列指令執行 init 任務：gradle init。在提示時，選擇 1: application 專案類型，並選擇 4: Scala 作為實作語言。接著，你可以選擇用於撰寫建置腳本的 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] 4

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
        │   └── 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 產生包裝檔案的資料夾
2 產生版本目錄
3 Gradle 包裝啟動腳本
4 定義建置名稱和子專案的設定檔
5 app 專案的建置腳本
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 定義應用程式的 main 類別。

檔案 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 任務指示 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
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 設定和建置 Scala 應用程式專案。您已學會如何

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

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

  • 使用 application 外掛程式的 run 任務執行 Scala 應用程式

  • 在封存檔中打包應用程式

後續步驟

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