您可以在支持Gradle的IDE中打开此示例。 |
本指南演示了如何使用 gradle init
通过 Gradle 创建 Swift 库。您可以按照本指南的步骤从头开始创建一个新项目,或者使用上面的链接下载完整的示例项目。
您将构建什么
您将生成一个遵循 Gradle 约定的 Swift 库。
您需要什么
-
一个文本编辑器或 IDE - 例如 IntelliJ IDEA
-
Java Development Kit (JDK),版本 8 或更高版本 - 例如 AdoptOpenJDK
-
最新 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 | 为包装器文件生成的文件夹 |
2 | 生成的版本目录 |
3 | Gradle 包装器启动脚本 |
4 | 定义构建名称和子项目的设置文件 |
5 | `lib` 项目的构建脚本 |
6 | 默认 Swift 源文件夹 |
7 | 默认 Swift 测试源文件夹 |
您现在已设置好项目来构建 Swift 库。
审查项目文件
settings.gradle(.kts)
文件有两行值得注意
rootProject.name = "demo"
include("lib")
rootProject.name = 'demo'
include('lib')
-
rootProject.name
为构建分配一个名称,这会覆盖根据其所在目录命名构建的默认行为。建议设置一个固定名称,因为如果项目被共享(例如,作为 Git 存储库的根目录),文件夹可能会更改。 -
`include("lib")` 定义构建由一个名为 `lib` 的子项目组成,该子项目包含实际代码和构建逻辑。可以通过额外的 `include(…)` 语句添加更多子项目。
我们的构建包含一个名为 lib
的子项目,它代表我们正在构建的 Swift 库。它在 lib/build.gradle(.kts)
文件中配置
plugins {
`swift-library` (1)
xctest (2)
}
library {
targetMachines.add(machines.linux.x86_64) (3)
}
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
显示在此处
/*
* This source file was generated by the Gradle 'init' task
*/
class Hello {
public func greeting() -> String {
return "Hello, World!"
}
}
生成的测试 src/test/swift/Hello.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 库的项目
-
构建库,包括运行其测试