工具和库的相互依存关系

构建依赖项是成功构建项目所需的外部组件。构建可能依赖于库、插件、子项目、Android SDK、Kotlin 和 Java 编译器等工具、Android Studio 等开发环境以及 Gradle 本身。

每个依赖项本身可能需要其他依赖项。我们称之为传递依赖项,它们可以快速增加应用使用的总体依赖项。当您想要升级某个依赖项(无论是库、工具还是 Android SDK)时,该升级可能会级联,从而升级许多其他依赖项。

通常,这不会造成任何问题,因为许多库都遵循一种称为语义版本控制的方案。这些库会限制其所做的更改类型,以便与较低版本兼容。

语义版本控制采用 major.minor.patch 格式。例如,在版本号 4.8.3 中,4 是 major 版本,8 是 minor 版本,3 是 patch 编号。当 major 部分发生更改时,库可能会在 API 或行为方面发生破坏性更改。这可能会影响您的 build 或应用行为。

当 minor(新功能)或 patch(bug 修复)部分发生变化时,库开发者会告知您该库仍然兼容,不应影响您的应用。

构建中的关系

Android build 包含以下各项之间的关系:

  • 源代码 - 您可以控制的代码和资源
  • 库依赖项 - 项目和子项目在构建时包含的外部库或模块
  • 工具 - 编译器、插件和 SDK,用于将源代码转换为应用或库
构建依赖项及其关系
图 1. 建立联结

源代码

源代码是您在应用或库中编写的 Kotlin 或 Java 代码。(如需详细了解如何使用 C++,请参阅 Android NDK。)

源代码依赖于库(包括 Kotlin 和 Java 运行时库)和 Android SDK,并且需要其对应的 Kotlin 或 Java 编译器。

部分源代码包含需要额外处理的注解。例如,如果您正在编写 Jetpack Compose 代码,则需要添加 @Composable 等注解,这些注解需要由 Compose Kotlin 编译器插件进行处理。其他注解可能由 Kotlin 符号处理器 (KSP) 或单独的注解处理工具处理。

库依赖项

库包含作为应用的一部分拉取的字节码。这可以是 Java JAR、Android 库 (AAR) 或 build 中的子项目。许多库都遵循语义版本控制,这有助于您了解这些库在升级后是否仍保持兼容。

库通常对其他库具有传递依赖项。这样可以减少您必须明确管理的内容;您只需指定直接依赖项,Gradle 会将它们与传递依赖项一起拉取。升级直接依赖项也可能会升级其传递依赖项。

有时,库可能要求在运行时 (minSdk) 或编译时间 (compileSdk) 使用最低版本的 Android SDK。当库使用 Android SDK 或其提供的 JDK API 中包含的函数时,这是必要的。应用的有效 minSdk 是应用及其所有直接和传递库依赖项请求的最高 minSdk。

使用某些库可能需要使用特定的 Gradle 插件。这些辅助插件通常会安装 Kotlin 符号处理器或其他注解处理器,这些处理器会生成代码或修改源代码的编译,以支持您使用库功能。例如,Jetpack Room 包含注解和 KSP,可将注解转换为生成的代码,以便检索和修改数据库中的数据。Jetpack Compose 需要使用 Compose 编译器插件来修改带注解的函数,以管理该函数的重新运行方式和时间。

工具

Gradle

Gradle 是一种构建工具,可读取构建文件并生成应用或库,同时还提供了一个 API,供插件扩展其功能。Gradle 在一个或多个 Java 虚拟机上运行多个进程,其 Java 插件会调用 JDK 中的 Java 工具。

Gradle 插件

Gradle 插件通过定义新任务和配置来扩展 Gradle。将插件应用于 build 可启用特定的 build 功能,这些功能在 build 脚本中配置为数据。对于 Android build,最重要的 Gradle 插件是 Android Gradle 插件 (AGP)。

编译器

Kotlin 或 Java 编译器会将您的源代码转换为可执行的字节码。Kotlin 编译器会公开一个插件 API,以便直接在编译器内运行外部分析和代码生成,从而访问解析后的代码结构。

编译器插件

编译器插件在 Kotlin 编译器分析代码时,在 Kotlin 编译器内部执行分析和代码生成,并在您将 Gradle 插件应用于 build 时安装。

Android SDK

Android SDK 包含特定 Android 版本的 Android 平台和 Java API,以及相应的工具。这些工具有助于您管理 SDK、构建应用以及与 Android 设备通信和模拟 Android 设备。

每个版本的 Android SDK 都提供了可供源代码访问的特定 Java API,并提供脱糖支持,以便在较低版本的 Android 上使用这些 API。

JDK

Java 开发套件,包含用于编译 Java 源代码和运行 Java 应用的 Java 库和可执行文件。Android build 中有多个 JDK 在发挥作用。如需了解详情,请参阅 Android build 中的 Java 版本。

Gradle 范围

Gradle 会将库依赖项分组到不同的范围(在 Gradle API 中称为“配置”),以便您指定要在 build 的不同部分中使用的不同库依赖项集。例如,您可能不希望在已发布的应用或库中包含 JUnit 等测试库,但您确实希望在构建和执行单元测试时包含这些库。您还可以使用作用域添加符号或注解处理器来分析代码。

例如,AGP 定义了 implementation 和 api 作用域,您可以通过它们指定是否应向子项目的用户公开依赖项。如需了解这些范围以及 Android build 中使用的其他范围,请参阅配置依赖项。

在 build 文件的 dependencies 代码块中添加库依赖项,可以采用 group:artifact:version 字符串形式:

Kotlin

// In a module-level build script
// explicit dependency strings ("group:artifact:version")
dependencies {
    implementation("com.example:library1:1.2.3")
    api("com.example:library2:1.1.1")
}

Groovy

// In a module-level build script
// explicit dependency strings ("group:artifact:version")
dependencies {
    implementation 'com.example:library1:1.2.3'
    api 'com.example:library2:1.1.1'
}

或在版本目录中:

# Version catalog - gradle/libs.versions.toml
[versions]
exampleLib = "1.2.3"
examplePlugin = "2.3.4"

[libraries]
example-library = { group = "com.example", name = "library", version.ref = "exampleLib" }

[plugins]
example-plugin = { id = "com.example.plugin", version.ref = "examplePlugin" }

并在 build 文件中指定生成的变量:

Kotlin

// In a module-level build script
// Using a version catalog
plugins {
    alias(libs.plugins.example.plugin)
}

dependencies {
    implementation(libs.example.library)
}

Groovy

// In a module-level build script
// Using a version catalog
plugins {
    alias(libs.plugins.example.plugin)
}

dependencies {
    implementation libs.example.library
}