建立 Swift 應用程式範例 - Gradle 繁體中文

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

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

Swift 應用程式外掛與組態快取不相容。

您將建立的內容

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

您需要的內容

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

建立專案資料夾

Gradle 內建一個名為 init 的任務，用於在空資料夾中初始化新的 Gradle 專案。init 任務使用（同樣內建的）wrapper 任務來建立 Gradle wrapper 腳本 gradlew。

第一步是為新專案建立一個資料夾並切換目錄到該資料夾。

$ mkdir demo
$ cd demo

執行 init 任務

從新專案目錄中，使用終端機中的下列指令執行 init 任務：gradle init。在提示時，選取 1: application 專案類型和 6: Swift 作為實作語言。接著，您可以選擇用於撰寫 buildscript 的 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] 6

Select build script DSL:
  1: Groovy
  2: Kotlin
Enter selection (default: Groovy) [1..2] 1

Project name (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
        │   └── 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 var allTests = [
        ("testGreeting", testGreeting),
    ]

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

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

建置應用程式

$ ./gradlew build

BUILD SUCCESSFUL in 0s
7 actionable tasks: 7 executed

第一次執行包裝指令碼 gradlew 時，可能會延遲，因為 gradle 的版本會下載並儲存在本機的 ~/.gradle/wrapper/dists 資料夾中。

build 任務會編譯 Swift 來源、連結物件檔案，並執行測試。它也會封裝主要和測試應用程式，以便在其他系統上散佈。installDebug 和 installTest 任務（兩者都作為 build 的一部分執行）會複製可執行檔，並產生用於執行應用程式的殼層指令碼。以下顯示 build/install 資料夾的內容

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

1	執行應用程式變體的指令碼
2	主要可執行二進位檔（偵錯變體）
3	測試可執行二進位檔

當建置有相依性時，相依的函式庫也會複製到安裝資料夾中。殼層指令碼適當地設定函式庫路徑，以便可以重新配置套件。

本指南未涵蓋對其他專案的相依性。如需深入了解此主題，請查看傳遞相依性範例以取得示範。

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 專案。