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 构建分三个阶段运行。每个阶段都执行您在构建文件中定义的代码的不同部分。

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

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

配置 DSL

Gradle 使用 领域特定语言 (DSL) 来配置构建。这种声明式方法专注于指定你的数据，而不是编写逐步（命令式）指令。

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 构建结构。