构建 Swift 项目 - Gradle 中文

本章中描述的插件与配置缓存不兼容。

Gradle 使用约定优于配置的方法来构建原生项目。如果您来自其他原生构建系统，这些概念可能一开始并不熟悉，但它们旨在简化构建脚本编写。

本章将详细介绍 Swift 项目，但大多数主题也适用于其他受支持的原生语言。

简介

Swift 项目最简单的构建脚本应用 Swift 应用程序插件或 Swift 库插件，并可选地设置项目版本

build.gradle.kts

plugins {
    `swift-application` // or `swift-library`
}

version = "1.2.1"

build.gradle

plugins {
    id 'swift-application' // or 'swift-library'
}

version = '1.2.1'

通过应用任一 Swift 插件，您将获得一系列功能

compileDebugSwift 和 compileReleaseSwift 任务分别编译 src/main/swift 下的 Swift 源文件，用于众所周知的调试和发布构建类型。
linkDebug 和 linkRelease 任务将编译后的 Swift 对象文件链接到应用程序的可执行文件或库的共享库中，这些库具有用于调试和发布构建类型的共享链接。
createDebug 和 createRelease 任务将编译后的 Swift 对象文件组装成用于具有静态链接的库的静态库，用于调试和发布构建类型。

对于任何非平凡的 Swift 项目，您可能都会有一些文件依赖项和特定于您的项目的额外配置。

Swift 插件还将上述任务集成到标准的生命周期任务中。生成开发二进制文件的任务附加到 assemble。默认情况下，开发二进制文件是调试变体。

本章的其余部分解释了在构建库和应用程序时自定义构建以满足您的需求的不同方法。

介绍构建变体

原生项目通常可以生成多个不同的二进制文件，例如调试或发布二进制文件，或者针对特定平台和处理器架构的二进制文件。Gradle 通过维度和变体的概念来管理这一点。

维度只是一个类别，每个类别都与其他类别正交。例如，“构建类型”维度是一个包含调试和发布的类别。“架构”维度涵盖处理器架构，如 x86-64 和 x86。

变体是这些维度值的组合，包含每个维度的一个值。您可能有一个“调试 x86-64”或“发布 x86”变体。

Gradle 内置支持多个维度和每个维度内的多个值。您可以在原生插件参考章节中找到它们的列表。

声明您的源文件

Gradle 的 Swift 支持直接从应用程序或库脚本块使用 ConfigurableFileCollection 来配置要编译的源集。

库区分私有（实现细节）和公共（导出到消费者）头文件。

您还可以为每个二进制构建配置源，用于在特定目标机器上才编译源的情况。

图 1. 源代码和 Swift 编译

管理依赖项

绝大多数项目都依赖于其他项目，因此管理项目的依赖项是构建任何项目的重要组成部分。依赖项管理是一个很大的话题，因此我们这里只关注 Swift 项目的基础知识。如果您想深入了解详细信息，请查看依赖项管理简介。

Gradle 提供了对从 Gradle 发布的 Maven 存储库中使用预构建二进制文件的支持 ^[1]。

我们将介绍如何在多构建项目中添加项目之间的依赖项。

为您的 Swift 项目指定依赖项需要两部分信息

依赖项的标识信息（项目路径、Maven GAV）
它需要什么，例如编译、链接、运行时或以上所有。

此信息在 Swift application 或 library 脚本块的 dependencies {} 块中指定。例如，要告诉 Gradle 您的项目需要库 common 来编译和链接您的生产代码，您可以使用以下代码片段

示例 2. 声明依赖项

build.gradle.kts

application {
    dependencies {
        implementation(project(":common"))
    }
}

build.gradle

application {
    dependencies {
        implementation project(':common')
    }
}

Gradle 的术语如下

配置（例如：implementation） - 依赖项的命名集合，为特定目标（例如编译或链接模块）分组在一起
项目引用（例如：project(':common')） - 由指定路径引用的项目

您可以在此处找到更全面的依赖项管理术语词汇表。

就配置而言，主要的配置是

implementation - 用于编译、链接和运行时
swiftCompileVariant - 用于编译您的生产代码所需的依赖项，但这些依赖项不应包含在链接或运行时过程中
nativeLinkVariant - 用于链接您的代码所需的依赖项，但这些依赖项不应包含在编译或运行时过程中
nativeRuntimeVariant - 用于运行您的组件所需的依赖项，但这些依赖项不应包含在编译或链接过程中

您可以在本机插件参考章节中了解有关这些配置以及它们之间的关系的更多信息。

请注意，Swift 库插件为依赖项创建了一个额外的配置 - api - 用于编译和链接模块本身以及任何依赖于它的模块。

我们这里只是触及了皮毛，因此建议您在熟悉使用 Gradle 构建 Swift 项目的基础知识后，阅读专门的依赖项管理章节。

一些需要进一步阅读的常见场景包括

定义自定义的Maven 兼容存储库
声明具有更改（例如 SNAPSHOT）和动态（范围）版本的依赖项
声明项目作为依赖项的兄弟项目
控制传递依赖项及其版本
通过复合构建（比发布到和使用Maven Local 更好的选择）测试您对第三方依赖项的修复

您会发现 Gradle 拥有一个丰富的 API 用于处理依赖项 - 需要时间才能掌握，但对于常见场景来说，使用起来很简单。

编译和链接您的代码

如果您遵循约定，编译您的代码可以非常容易

将您的源代码放在 src/main/swift 目录下
在 implementation 配置中声明您的编译依赖项（参见上一节）
运行 assemble 任务

我们建议您尽可能遵循这些约定，但您不必这样做。

正如您将在下一节中看到，有几种自定义选项。

所有SwiftCompile 任务都是增量式且可缓存的。

支持的工具链

Gradle 支持macOS 和 Linux 的官方 Swift 工具链。当您构建本机二进制文件时，Gradle 将尝试找到安装在您机器上的可以构建二进制文件的工具链。Gradle 选择第一个可以为目标操作系统、体系结构和 Swift 语言支持构建的工具链。

对于 Linux 用户，Gradle 将使用系统 PATH 发现工具链。

自定义文件和目录位置

假设您正在迁移一个遵循 Swift 包管理器布局的库项目（例如，用于生产代码的 Sources/ModuleName_ 目录）。传统的目录结构将不起作用，因此您需要告诉 Gradle 在哪里找到源文件。您可以通过 application 或 library 脚本块来实现。

每个组件脚本块以及每个二进制文件都定义了其源代码所在的位置。您可以使用以下语法覆盖约定值

示例 3. 设置 Swift 源集

build.gradle.kts

extensions.configure<SwiftLibrary> {
    source.from(file("Sources/Common"))
}

build.gradle

library {
    source.from file('src')
}

现在 Gradle 只会在 Sources/Common 中直接搜索源代码。

更改编译器和链接器选项

大多数编译器和链接器选项可以通过相应的任务访问，例如 compileVariantSwift、linkVariant 和 createVariant。这些任务分别属于 SwiftCompile、LinkSharedLibrary 和 CreateStaticLibrary 类型。阅读任务参考以获取最新的完整选项列表。

例如，如果您想更改所有变体编译器生成的警告级别，可以使用以下配置

示例 4. 为所有变体设置 Swift 编译器选项

build.gradle.kts

tasks.withType(SwiftCompile::class.java).configureEach {
    // Define a preprocessor macro for every binary
    macros.add("NDEBUG")

    // Define a compiler options
    compilerArgs.add("-O")
}

build.gradle

tasks.withType(SwiftCompile).configureEach {
    // Define a preprocessor macro for every binary
    macros.add("NDEBUG")

    // Define a compiler options
    compilerArgs.add '-O'
}

也可以通过 application 或 library 脚本块上的 BinaryCollection 找到特定变体的实例

示例 5. 按变体设置 Swift 编译器选项

build.gradle.kts

application {
    binaries.configureEach(SwiftStaticLibrary::class.java) {
        // Define a preprocessor macro for every binary
        compileTask.get().macros.add("NDEBUG")

        // Define a compiler options
        compileTask.get().compilerArgs.add("-O")
    }
}

build.gradle

application {
    binaries.configureEach(SwiftStaticLibrary) {
        // Define a preprocessor macro for every binary
        compileTask.get().macros.add("NDEBUG")

        // Define a compiler options
        compileTask.get().compilerArgs.add '-O'
    }
}

选择目标机器

默认情况下，Gradle 会尝试为主机操作系统和架构创建 Swift 二进制变体。可以通过在 application 或 library 脚本块上指定 TargetMachine 集合来覆盖此行为

示例 6. 设置目标机器

build.gradle.kts

application {
    targetMachines = listOf(machines.linux.x86_64, machines.macOS.x86_64)
}

build.gradle

application {
    targetMachines = [
        machines.linux.x86_64,
        machines.macOS.x86_64
    ]
}

打包和发布

在原生世界中，打包和发布 Swift 项目的方式差异很大。Gradle 提供了默认设置，但可以轻松实现自定义打包。

可执行文件直接发布到 Maven 仓库。
共享库和静态库文件直接发布到 Maven 仓库，以及包含公共头文件的 zip 文件。
对于应用程序，Gradle 还支持在已知位置安装和运行可执行文件及其所有共享库依赖项。

清理构建

Swift 应用程序和库插件使用基础插件为您的项目添加 clean 任务。此任务只是简单地删除 layout.buildDirectory 目录中的所有内容，因此您应该始终将构建生成的的文件放在该目录中。该任务是 Delete 的一个实例，您可以通过设置其 dir 属性来更改它删除的目录。

构建 Swift 库

库项目的独特之处在于它们被其他 Swift 项目使用（或“消费”）。这意味着与二进制文件和头文件一起发布的依赖项元数据（以 Gradle 模块元数据形式）至关重要。特别是，您的库的使用者应该能够区分两种不同类型的依赖项：仅在编译您的库时需要的依赖项，以及在编译使用者时也需要的依赖项。

Gradle 通过 Swift 库插件管理这种区别，该插件除了本章中介绍的 implementation 之外，还引入了 api 配置。如果依赖项中的类型作为静态库的未解析符号或公共头文件中的未解析符号出现，那么该依赖项将通过您的库的公共 API 公开，因此应将其添加到 api 配置中。否则，该依赖项是内部实现细节，应将其添加到 implementation 中。

如果您不确定 API 和实现依赖项之间的区别，Swift 库插件章提供了详细的解释。此外，您可以在相应的示例中看到构建 Swift 库的基本、实用的示例。

构建 Swift 应用程序

有关更多详细信息，请参阅 Swift 应用程序插件章，但以下是您获得内容的快速摘要

install 创建一个包含运行所需所有内容的目录
用于启动应用程序的 Shell 和 Windows 批处理脚本

您可以在相应的示例中看到构建 Swift 应用程序的基本示例。

1. 不幸的是，Cocoapods 存储库尚未作为核心功能支持

此页面是否有帮助？