您可以使用 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。當系統提示時，選取 2: library 專案類型，並選取 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] 2

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)
└── lib
    ├── build.gradle.kts (5)
    └── src
        ├── main
        │   └── scala (6)
        │       └── demo
        │           └── Library.scala
        └── test
            └── scala (7)
                └── demo
                    └── LibrarySuite.scala
├── gradle (1)
│   ├── libs.versions.toml (2)
│   └── wrapper
│       ├── gradle-wrapper.jar
│       └── gradle-wrapper.properties
├── gradlew (3)
├── gradlew.bat (3)
├── settings.gradle (4)
└── lib
    ├── build.gradle (5)
    └── src
        ├── main
        │   └── scala (6)
        │       └── demo
        │           └── Library.scala
        └── test
            └── scala (7)
                └── demo
                    └── LibrarySuite.scala
1 為 wrapper 檔案產生的資料夾
2 產生的版本目錄
3 Gradle wrapper 啟動腳本
4 用於定義建置名稱和子專案的設定檔
5 lib 專案的建置腳本
6 預設的 Scala 原始碼資料夾
7 預設的 Scala 測試原始碼資料夾

現在您已設定好專案來建置 Scala 函式庫。

檢閱專案檔案

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

settings.gradle.kts
rootProject.name = "demo"
include("lib")
settings.gradle
rootProject.name = 'demo'
include('lib')

  • rootProject.name 會將名稱指定給建置，這會覆寫根據資料夾名稱來命名建置的預設行為。建議設定一個固定的名稱，因為如果專案是共用的話，資料夾可能會變更 - 例如，作為 Git 儲存庫的根目錄。

  • include("lib") 定義建置包含一個稱為 lib 的子專案，其中包含實際的程式碼和建置邏輯。可以透過其他 include(…​) 陳述式來新增更多子專案。

我們的建置包含一個稱為 lib 的子專案，用於表示我們正在建置的 Scala 函式庫。它是在 lib/build.gradle(.kts) 檔案中設定的

lib/build.gradle.kts
plugins {
    scala (1)
    `java-library` (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)

    api(libs.commons.math3) (8)
}
lib/build.gradle
plugins {
    id 'scala' (1)
    id 'java-library' (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)

    api libs.commons.math3 (8)
}
1 套用 Scala 外掛程式以新增對 Scala 的支援。
2 套用 java-library 外掛程式以區分 API 和實作。
3 使用 Maven Central 來解析相依性。
4 在我們的函式庫專案中使用 Scala 2.13
5 此相依性在內部使用，且不會在使用者自己的編譯類別路徑中公開。
6 使用 Scalatest 來測試我們的函式庫
7 在測試執行期間需要 scala-xml
8 此相依性會匯出給使用者，也就是說會在他們的編譯類別路徑中找到。

檔案 src/main/scala/demo/Library.scala 顯示於此

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

class Library {
  def someLibraryMethod(): Boolean = true
}

已產生測試 src/test/scala/demo/Library.scala，如下所示

已產生 src/test/scala/demo/LibrarySuite.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 LibrarySuite extends AnyFunSuite {
  test("someLibraryMethod is always true") {
    def library = new Library()
    assert(library.someLibraryMethod())
  }
}

已產生的測試類別只有一個 ScalaTest 測試。測試會實例化 Library 類別，呼叫其方法，並檢查其是否傳回預期的值。

可以在 Java 函式庫外掛程式文件 中找到 java-library 外掛程式新增至任何 JVM 函式庫專案的功能（例如 API 和實作區分）的更多資訊。

組裝函式庫 JAR

若要建置專案，請執行 build 工作。您可以使用一般的 gradle 指令，但當專案包含包裝指令碼時，建議使用包裝指令碼。

$ ./gradlew build

BUILD SUCCESSFUL in 0s
4 actionable tasks: 4 executed
您第一次執行包裝指令碼 gradlew 時，可能會延遲一段時間，因為系統正在下載該版本的 gradle 並將其儲存在本機的 ~/.gradle/wrapper/dists 資料夾中。

您第一次執行建置時，Gradle 會檢查 ~/.gradle 目錄中的快取中是否已存在必要的相依性。如果沒有，系統會下載函式庫並將其儲存在快取中。下次執行建置時，系統會使用快取中的版本。build 工作會編譯類別、執行測試並產生測試報告。

您可以開啟位於 lib/build/reports/tests/test/index.html 的 HTML 輸出檔案來檢視測試報告。

您可以在 lib/build/libs 目錄中找到新封裝的 JAR 檔案，檔案名稱為 lib.jar。執行下列指令來驗證封存檔案是否有效

$ jar tf lib/build/libs/lib.jar
META-INF/
META-INF/MANIFEST.MF
lib/
lib/Library.class

您應該會看到必要的清單檔案 —MANIFEST.MF— 和已編譯的 Library 類別。

所有這些都會在建置指令碼中發生，而不需要任何其他設定，因為 Gradle 的 java-library 外掛程式假設您的專案來源已安排在 慣例專案配置 中。如果您希望的話，可以自訂專案配置 如使用者手冊中所述。

恭喜，您剛剛完成了建立 Scala 函式庫的第一步！您現在可以自訂這項內容以符合您自己的專案需求。

自訂函式庫 JAR

您通常會希望 JAR 檔案的名稱包含函式庫版本。這可透過在建置指令碼中設定頂層 version 屬性來達成

build.gradle.kts
version = "0.1.0"
build.gradle
version = '0.1.0'

除了版本之外，函式庫的其他重要識別屬性為其名稱和群組。名稱直接從代表函式庫的子專案名稱衍生而來。在範例中為 lib，所以您可能會想要調整它，方法是變更 lib 資料夾的名稱和 settings.gradle(.kts) 檔案中對應的 include(…​) 陳述式。群組用於在發布時提供函式庫完整的座標。您可以透過設定 group 屬性（類似於您設定版本的方式，如上所示）來直接在建置指令碼中定義它。

現在執行 jar 工作

$ ./gradlew jar

BUILD SUCCESSFUL
2 actionable tasks: 1 executed, 1 up-to-date

您會注意到，在 lib/build/libs/lib-0.1.0.jar 中產生的 JAR 檔案包含預期的版本。

另一個常見需求是自訂清單檔案，通常是透過新增一個或多個屬性。讓我們透過 設定 jar 工作，在清單檔案中包含函式庫名稱和版本。將下列內容新增到建置指令碼的結尾

build.gradle.kts
tasks.jar {
    manifest {
        attributes(mapOf("Implementation-Title" to project.name,
                         "Implementation-Version" to project.version))
    }
}
build.gradle
tasks.named('jar') {
    manifest {
        attributes('Implementation-Title': project.name,
                   'Implementation-Version': project.version)
    }
}

為確認這些變更如預期般運作，請再次執行 jar 工作，並在這次同時從 JAR 中解壓縮清單檔案

$ ./gradlew jar
$ jar xf lib/build/libs/lib-0.1.0.jar META-INF/MANIFEST.MF

現在檢視 META-INF/MANIFEST.MF 檔案的內容，您應該會看到下列內容

META-INF/MANIFEST.MF
Manifest-Version: 1.0
Implementation-Title: lib
Implementation-Version: 0.1.0

產生 Sources JAR

您可以輕鬆為您的程式庫產生 Sources JAR

build.gradle.kts
java {
    withSourcesJar()
}
build.gradle
java {
    withSourcesJar()
}

額外的 JAR 將會在 assemble 或 build 生命週期任務的一部分中產生，並會成為出版的一部分。產生的檔案會在 lib/build/libs 中找到，名稱使用傳統分類器 -sources。

發布 Build Scan

進一步了解您的建置在幕後執行的最佳方式，是發布 build scan。為此，只需使用 --scan 標記執行 Gradle 即可。

$ ./gradlew build --scan

BUILD SUCCESSFUL in 0s
4 actionable tasks: 4 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 程式庫的專案

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

  • 自訂建置產生的 Jar 檔案

現在，您可以嘗試編譯使用您剛建置的程式庫的 Scala 程式碼，來完成此練習。

後續步驟

建置程式庫只是在專案邊界間重複使用程式碼的一個面向。在此，您可能對下列事項感興趣