Gradle 构建概览

Android 应用通常使用 Gradle 构建系统进行构建。在深入探讨如何配置构建的细节之前，我们将先探索构建背后的概念，以便您能够从整体上了解该系统。

什么是构建？

构建系统将您的源代码转换为可执行应用程序。构建通常涉及多个工具，用于分析、编译、链接和打包您的应用或库。Gradle 使用基于任务的方法来组织和运行这些命令。

任务封装了将其输入转换为输出的命令。插件定义任务及其配置。将插件应用于您的构建会注册其任务，并使用它们的输入和输出将它们连接起来。例如，将 Android Gradle 插件 (AGP) 应用于您的构建文件将注册构建 APK 或 Android 库所需的所有任务。java-library 插件允许您从 Java 源代码构建 jar。Kotlin 和其他语言也有类似的插件，但其他插件旨在扩展现有插件。例如，protobuf 插件旨在为 AGP 或 java-library 等现有插件添加 protobuf 支持。

Gradle 倾向于约定优于配置，因此插件开箱即用，带有良好的默认值，但您可以通过声明式领域特定语言 (DSL) 进一步配置构建。DSL 的设计宗旨是让您可以指定构建什么，而不是如何构建。插件中的逻辑管理着“如何”构建。该配置在您的项目（和子项目）中的多个构建文件中指定。

任务输入可以是文件和目录，也可以是编码为 Java 类型（整数、字符串或自定义类）的其他信息。输出只能是目录或文件，因为它们必须写入磁盘。将一个任务的输出连接到另一个任务的输入，可以将任务链接在一起，以便一个任务必须在另一个任务之前运行。

虽然 Gradle 支持在您的构建文件中编写任意代码和任务声明，但这会使工具更难理解您的构建，也更难维护。例如，您可以为插件内的代码编写测试，但不能为构建文件中的代码编写测试。相反，您应该将构建逻辑和任务声明限制在插件（您或其他人定义）中，并在您的构建文件中声明如何使用该逻辑。

Gradle 构建运行时会发生什么？

Gradle 构建分三个阶段运行。每个阶段都会执行您在构建文件中定义的不同的代码部分。

  • 初始化阶段确定构建中包含哪些项目和子项目，并设置包含您的构建文件和已应用插件的类路径。此阶段侧重于一个设置文件，您在该文件中声明要构建的项目以及从中获取插件和库的位置。
  • 配置阶段为每个项目注册任务，并执行构建文件以应用用户的构建规范。重要的是要理解，您的配置代码将无法访问在执行期间生成的数据或文件。
  • 执行阶段实际执行应用的“构建”操作。配置的输出是一个有向无环图 (DAG) 的任务集合，代表用户请求的所有必需构建步骤（在命令行上提供或作为构建文件中的默认值提供的任务）。此图表示任务之间的关系，无论是任务声明中明确的，还是基于其输入和输出的。如果一个任务的输入是另一个任务的输出，那么它必须在另一个任务之后运行。此阶段按照图中定义的顺序运行过时的任务；如果一个任务的输入自上次执行以来没有更改，Gradle 将跳过它。

更多信息请参阅 Gradle 构建生命周期。

配置 DSL

Gradle 使用领域特定语言 (DSL) 来配置构建。这种声明式方法侧重于指定您的数据，而不是编写分步（命令式）指令。您可以使用 Kotlin 或 Groovy 编写构建文件，但我们强烈建议使用 Kotlin。

DSL 旨在让所有人（领域专家和程序员）更容易为项目做出贡献，它定义了一种小语言，以更自然的方式表示数据。Gradle 插件可以扩展 DSL 以配置其任务所需的数据。

例如，配置构建的 Android 部分可能如下所示：

Kotlin

android {
    namespace = "com.example.app"
    compileSdk = 34
    // ...

    defaultConfig {
        applicationId = "com.example.app"
        minSdk = 34
        // ...
    }
}

Groovy

android {
    namespace 'com.example.myapplication'
    compileSdk 34
    // ...

    defaultConfig {
        applicationId "com.example.myapplication"
        minSdk 24
        // ...
    }
}

在幕后，DSL 代码类似于

fun Project.android(configure: ApplicationExtension.() -> Unit) {
    ...
}

interface ApplicationExtension {
    var compileSdk: Int
    var namespace: String?

    val defaultConfig: DefaultConfig

    fun defaultConfig(configure: DefaultConfig.() -> Unit) {
        ...
    }
}

DSL 中的每个块都由一个函数表示，该函数接受一个 lambda 来配置它，以及一个同名属性来访问它。这使得您的构建文件中的代码更像是数据规范。

外部依赖项

Maven 构建系统引入了依赖项规范、存储和管理系统。库存储在仓库（服务器或目录）中，包含其版本和其他库依赖项的元数据。您指定要搜索的仓库、要使用的依赖项版本，构建系统会在构建期间下载它们。

Maven 工件通过组名（公司、开发者等）、工件名（库的名称）和该工件的版本来标识。这通常表示为 group:artifact:version。

这种方法显著改善了构建管理。您经常会听到这类仓库被称为“Maven 仓库”，但这都与工件的打包和发布方式有关。这些仓库和元数据已在多个构建系统中重复使用，包括 Gradle（Gradle 也可以发布到这些仓库）。公共仓库允许所有人共享使用，公司内部仓库则保留内部依赖项。

您还可以将项目模块化为子项目（在 Android Studio 中也称为“模块”），这些子项目也可以用作依赖项。每个子项目都会生成可供子项目或您的顶级项目使用的输出（例如 jar）。这可以通过隔离需要重新构建的部分来缩短构建时间，并更好地分离应用中的职责。

我们将在添加构建依赖项中更详细地介绍如何指定依赖项。

构建变体

当您创建 Android 应用时，通常会希望构建多个变体。变体包含不同的代码或使用不同的选项构建，并由构建类型和产品变种组成。

构建类型会改变声明的构建选项。默认情况下，AGP 会设置“release”和“debug”构建类型，但您可以调整它们并添加更多类型（例如用于预演或内部测试）。

调试构建不会缩小或混淆您的应用，从而加快构建速度并保留所有符号。它还会将应用标记为“可调试”，使用通用调试密钥对其进行签名，并允许访问设备上已安装的应用文件。这使得在运行应用时可以探索文件和数据库中保存的数据。

发布构建会优化应用，使用您的发布密钥对其进行签名，并保护已安装的应用文件。

使用产品变种，您可以更改应用包含的源代码和依赖项变体。例如，您可能希望为您的应用创建“demo”和“full”变种，或者“free”和“paid”变种。您将公共源代码写入“main”源集目录中，并在以变种命名的源集中覆盖或添加源代码。

AGP 会为构建类型和产品变种的每个组合创建变体。如果您未定义变种，则变体将以构建类型命名。如果您同时定义了两者，则变体将命名为 <flavor><Buildtype>。例如，对于构建类型 release 和 debug，以及变种 demo 和 full，AGP 将创建以下变体：

  • demoRelease
  • demoDebug
  • fullRelease
  • fullDebug

后续步骤

现在您已经了解了构建概念，请查看项目中的Android 构建结构。