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

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

您將建置什麼

您將產生一個遵循 Gradle 慣例的 Swift 函式庫。

您需要什麼

建立專案資料夾

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

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

$ mkdir demo
$ cd demo

執行 init 任務

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

Select implementation language:
  1: Java
  2: Kotlin
  3: Groovy
  4: Scala
  5: C++
  6: Swift
Enter selection (default: Java) [1..6] 6

Project name (default: demo):

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

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

您現在已設定好專案以建置 Swift 函式庫。

檢閱專案檔案

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 的子專案，代表我們正在建置的 Swift 函式庫。它在 lib/build.gradle(.kts) 檔案中配置

lib/build.gradle.kts
plugins {
    `swift-library` (1)
    xctest (2)
}

library {
    targetMachines.add(machines.linux.x86_64) (3)
}
lib/build.gradle
plugins {
    id 'swift-library' (1)
    id 'xctest' (2)
}

library {
    targetMachines.add(machines.linux.x86_64) (3)
}
1 套用 swift-library 外掛程式以新增對建置 Swift 函式庫的支援
2 套用 xctest 外掛程式以新增對建置和執行 Swift 測試執行檔 (Linux) 或套件 (macOS) 的支援
3 設定此函式庫的目標作業系統和架構

檔案 src/main/swift/Hello.swift 如下所示

產生的 src/main/swift/Hello.swift
/*
 * This source file was generated by the Gradle 'init' task
 */

class Hello {
    public func greeting() -> String {
        return "Hello, World!"
    }
}

產生的測試 src/test/swift/Hello.swift 如下所示

產生的 src/test/swift/HelloTests.swift
/*
 * This source file was generated by the Gradle 'init' task
 */

import XCTest
@testable import Lib

class HelloTests: XCTestCase {
    public static let allTests = [
        ("testGreeting", testGreeting),
    ]

    func testGreeting() {
        XCTAssertEqual("Hello, World!", Hello().greeting())
    }
}

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

建置函式庫

$ ./gradlew build

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

build 任務編譯 Swift 原始碼，將物件檔案連結到共享函式庫中，並執行測試。若要建置靜態函式庫，請參閱靜態函式庫範例。

本指南未涵蓋對其他專案的相依性。若要深入了解此主題，請查看 transitive dependency sample 以取得示範。
將函式庫發布到 Maven 儲存庫超出本指南的範圍。若要深入了解此主題，請查看 simple library sample 以取得示範。
Gradle 與多個 IDE 整合：Visual Studio、Xcode 和 Clion。若要深入了解，請查看它們各自連結的文件，以在您的專案中配置這些 IDE 整合。

發布建置掃描

若要深入了解您的建置在幕後執行的操作，最好的方法是發布建置掃描。若要執行此操作，只需使用 --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 配置並建置了 Swift 函式庫專案。您已學會如何

  • 初始化產生 Swift 函式庫的專案

  • 建置函式庫，包括執行其測試

後續步驟