你可以在支持 Gradle 的 IDE 中打开此示例。

本指南演示了如何使用 gradle init 命令通过 Gradle 创建一个 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 用于定义构建名称和子项目的 Settings 文件
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) 或 bundle (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/HelloTests.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 源代码，将目标文件链接到共享库中，并运行测试。要构建静态库，请参阅静态库示例。

本指南未涵盖对其他项目的依赖关系。要了解更多相关信息，请查看传递性依赖示例以获取演示。
将库发布到 Maven 仓库超出了本指南的范围。要了解更多相关信息，请查看简单库示例以获取演示。
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 库的项目

  • 构建库，包括运行其测试

下一步