建構 Swift 應用程式範例 - Gradle 建構系統

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

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

您將建構的內容

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

您需要的東西

文字編輯器或 IDE - 例如 IntelliJ IDEA
Java 開發套件 (JDK)，版本 8 或更高版本 - 例如 AdoptOpenJDK
最新的 Gradle 發行版本
已安裝的 Swift 編譯器。請參閱 Gradle 支援哪些 Swift 工具鏈。

建立專案資料夾

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

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

$ mkdir demo
$ cd demo

執行 init 任務

從新專案目錄內部，在終端機中使用以下命令執行 init 任務：gradle init。當出現提示時，選取 1: application 專案類型和 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] 1

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)
└── app
    ├── build.gradle.kts (5)
    └── src
        ├── main
        │   └── swift (6)
        │       └── main.swift
        └── test
            └── swift (7)
                └── GreeterTests.swift
                └── LinuxMain.swift

├── 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
        │   └── swift (6)
        │       └── main.swift
        └── test
            └── swift (7)
                └── GreeterTests.swift
                └── LinuxMain.swift

1	為 Wrapper 檔案產生的資料夾
2	產生的版本目錄
3	Gradle Wrapper 啟動腳本
4	設定檔以定義建置名稱和子專案
5	`app` 專案的建置腳本
6	預設 Swift 原始碼資料夾
7	預設 Swift 測試原始碼資料夾

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

檢閱專案檔案

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

app/build.gradle.kts

plugins {
    `swift-application` (1)
    xctest (2)
}

application { (3)
    targetMachines.add(machines.linux.x86_64) (4)
}

app/build.gradle

plugins {
    id 'swift-application' (1)
    id 'xctest' (2)
}

application { (3)
    targetMachines.add(machines.linux.x86_64) (4)
}

1	套用 swift-application 外掛程式以新增對建置 Swift 可執行檔的支援
2	套用 xctest 外掛程式以新增對建置和執行 Swift 測試可執行檔 (Linux) 或套件 (macOS) 的支援
3	設定此程式庫的目標作業系統和架構

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

產生的 src/main/swift/main.swift

/*
 * This source file was generated by the Gradle 'init' task
 */

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

let greeter = Greeter()
print(greeter.greeting())

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

產生的 src/test/swift/GreeterTests.swift

/*
 * This source file was generated by the Gradle 'init' task
 */

import XCTest
@testable import App

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

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

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

建置應用程式

$ ./gradlew build

BUILD SUCCESSFUL in 0s
7 actionable tasks: 7 executed

第一次執行 Wrapper 腳本 gradlew 時，可能會有一些延遲，因為該版本的 gradle 正在下載並在本機儲存在您的 ~/.gradle/wrapper/dists 資料夾中。

build 任務編譯 Swift 原始碼、連結物件檔案，並執行測試。它還封裝主要和測試應用程式，以便在其他系統上發布。installDebug 和 installTest 任務（兩者都作為 build 的一部分執行）複製可執行檔並產生一個 shell 腳本，用於執行應用程式。以下顯示 build/install 資料夾的內容

./app/build/install
├── main
│   └── debug
│       ├── app      (1)
│       └── lib
│           └── app  (2)
└── test
    ├── appTest      (1)
    └── lib
        └── appTest  (3)

1	用於執行應用程式變體的腳本
2	主要可執行二進制檔（debug 變體）
3	測試可執行二進制檔

當建置具有相依性時，相依的程式庫也會複製到安裝資料夾中。Shell 腳本會正確配置程式庫路徑，以便可以重新定位套件。

本指南未涵蓋對其他專案的相依性。若要瞭解有關此主題的更多資訊，請查看 transitive dependency sample 以進行示範。

Gradle 與多個 IDE 整合：Visual Studio、Xcode 和 Clion。若要瞭解更多資訊，請查看其各自連結的文件，以在您的專案中配置這些 IDE 整合。

執行應用程式

查看 build 資料夾內部，您會注意到 exe 資料夾的出現。依照慣例，Gradle 會將所有應用程式放在根據組件名稱命名的子資料夾中。在這種情況下，您會在 build/exe/main/debug 中找到您組裝的可執行檔，它將被稱為 app（或 Windows 下的 app.exe）。

現在執行您新建立的可執行檔。

$ ./app/build/exe/main/debug/app
Hello, World!

發布建置掃描

瞭解您的建置在幕後執行哪些操作的最佳方法是發布建置掃描。若要執行此操作，只需使用 --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 成功配置和建置 Swift 應用程式專案。您已學習如何

初始化一個產生 Swift 應用程式的專案
建置、捆綁和執行應用程式

下一步

若要瞭解有關如何進一步自訂 Swift 應用程式專案的更多資訊，請查看使用者手冊中關於建置 Swift 專案的章節。