添加构建依赖项

Android Studio 中的 Gradle 构建系统允许您将外部二进制文件或其他库模块作为依赖项包含到构建中。这些依赖项可以位于您的机器上或远程仓库中，它们声明的任何传递依赖项也会自动包含在内。本页面介绍了如何在 Android 项目中使用依赖项，包括特定于 Android Gradle 插件 (AGP) 的行为和配置的详细信息。如需了解关于 Gradle 依赖项的更深入概念指南，请参阅Gradle 依赖项管理指南，但请记住，您的 Android 项目只能使用本页中定义的依赖项配置。

添加库或插件依赖项

添加和管理构建依赖项的最佳方法是使用版本目录，这是新项目默认使用的方法。本部分介绍了 Android 项目中最常用的几种配置类型；如需了解更多选项，请参阅Gradle 文档。有关使用版本目录的应用示例，请参阅Now in Android。如果您在没有版本目录的情况下已经设置了构建依赖项，并且拥有一个多模块项目，我们建议您进行迁移。

有关添加和管理原生依赖项（不常用）的指南，请参阅原生依赖项。

在以下示例中，我们向项目添加了远程二进制依赖项 (Jetpack Macrobenchmark 库)、本地库模块依赖项 (myLibrary) 和插件依赖项 (Android Gradle 插件)。以下是将这些依赖项添加到项目的通用步骤

1. 在版本目录文件 libs.versions.toml 的 [versions] 部分（在 Project 视图的 gradle 目录或 Android 视图的 Gradle Scripts 中）中，为您想要的依赖项版本添加一个别名

   [versions]
   agp = "8.3.0"
   androidx-macro-benchmark = "1.2.2"
   my-library = "1.4"
   
   [libraries]
   ...
   
   [plugins]
   ...
   

   别名可以包含连字符或下划线。这些别名会生成嵌套值，您可以在构建脚本中引用它们。引用以目录名称开头，即 libs.versions.toml 的 libs 部分。使用单个版本目录时，我们建议保留默认值“libs”。

2. 在 libs.versions.toml 文件的 [libraries]（用于远程二进制文件或本地库模块）或 [plugins]（用于插件）部分中添加依赖项别名。

   [versions]
   ...
   
   [libraries]
   androidx-benchmark-macro = { group = "androidx.benchmark", name = "benchmark-macro-junit4", version.ref = "androidx-macro-benchmark" }
   my-library = { group = "com.myapplication", name = "mylibrary", version.ref = "my-library" }
   
   [plugins]
   androidApplication = { id = "com.android.application", version.ref = "agp" }
   

   有些库以已发布的材料清单 (BOM) 形式提供，这些清单将库族及其版本组合在一起。您可以在版本目录和构建文件中包含 BOM，让它为您管理这些版本。详情请参阅使用材料清单。

3. 在需要依赖项的模块的构建脚本中添加对依赖项别名的引用。从构建脚本引用别名时，将其下划线和连字符转换为点号。我们的模块级构建脚本示例如下

   Kotlin

   plugins {
     alias(libs.plugins.androidApplication)
   }
   
   dependencies {
     implementation(libs.androidx.benchmark.macro)
     implementation(libs.my.library)
   }

   Groovy

   plugins {
     alias 'libs.plugins.androidApplication'
   }
   
   dependencies {
     implementation libs.androidx.benchmark.macro
     implementation libs.my.library
   }

   插件引用在目录名称后包含 plugins，版本引用在目录名称后包含 versions（版本引用不常用；请参阅版本号相同的依赖项以获取版本引用示例）。库引用不包含 libraries 限定符，因此您不能在库别名的开头使用 versions 或 plugins。

配置依赖项

在 dependencies 块中，您可以使用几种不同的 依赖项配置（例如前面显示的 implementation）之一声明库依赖项。每种依赖项配置都会向 Gradle 提供有关如何使用依赖项的不同说明。下表描述了您可以在 Android 项目中的依赖项使用的每种配置。

dependencies {
  // Executes lint checks from the ":checks" project at build time.
  lintChecks(project(":checks"))
  // Compiles lint checks from the ":checks-to-publish" into a
  // lint.jar file and publishes it to your Android library.
  lintPublish(project(":checks-to-publish"))
}

dependencies {
  // Executes lint checks from the ':checks' project at build time.
  lintChecks project(':checks')
  // Compiles lint checks from the ':checks-to-publish' into a
  // lint.jar file and publishes it to your Android library.
  lintPublish project(':checks-to-publish')
}

为特定构建变体配置依赖项

上述所有配置都将依赖项应用于所有构建变体。如果您只想为特定的构建变体源集或测试源集声明依赖项，则必须将配置名称大写，并在其前面加上构建变体或测试源集的名称。

例如，要仅使用 implementation 配置向您的“free”产品变种添加远程二进制依赖项，请使用

dependencies {
    freeImplementation("com.google.firebase:firebase-ads:21.5.1")
}

dependencies {
    freeImplementation 'com.google.firebase:firebase-ads:21.5.1'
}

但是，如果您想为结合了产品变种和构建类型的变体添加依赖项，则必须初始化配置名称

// Initializes a placeholder for the freeDebugImplementation dependency configuration.
val freeDebugImplementation by configurations.creating

dependencies {
    freeDebugImplementation(project(":free-support"))
}

configurations {
    // Initializes a placeholder for the freeDebugImplementation dependency configuration.
    freeDebugImplementation {}
}

dependencies {
    freeDebugImplementation project(":free-support")
}

要为本地测试和仪器化测试添加 implementation 依赖项，它看起来像这样

dependencies {
    // Adds a remote binary dependency only for local tests.
    testImplementation("junit:junit:4.12")

    // Adds a remote binary dependency only for the instrumented test APK.
    androidTestImplementation("androidx.test.espresso:espresso-core:3.6.1")
}

dependencies {
    // Adds a remote binary dependency only for local tests.
    testImplementation 'junit:junit:4.12'

    // Adds a remote binary dependency only for the instrumented test APK.
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.6.1'
}

但是，某些配置在这种情况下没有意义。例如，由于其他模块不能依赖于 androidTest，如果您使用 androidTestApi 配置，则会收到以下警告

WARNING: Configuration 'androidTestApi' is obsolete and has been replaced with
'androidTestImplementation'.

依赖项顺序

您列出依赖项的顺序表示了它们的优先级：第一个库的优先级高于第二个，第二个高于第三个，依此类推。当需要将库中的资源合并或清单元素合并到您的应用中时，此顺序很重要。

例如，如果您的项目声明了以下内容

• 依赖于 LIB_A 和 LIB_B（按此顺序）
• 而 LIB_A 依赖于 LIB_C 和 LIB_D（按此顺序）
• 而 LIB_B 也依赖于 LIB_C

那么，平面依赖项顺序将如下所示

1. LIB_A
2. LIB_D
3. LIB_B
4. LIB_C

这确保了 LIB_A 和 LIB_B 都可以覆盖 LIB_C；并且 LIB_D 的优先级仍然高于 LIB_B，因为依赖于它的 LIB_A 的优先级高于 LIB_B。

有关来自不同项目源/依赖项的清单如何合并的更多信息，请参阅合并多个清单文件。

用于 Play 管理中心的依赖项信息

构建应用时，AGP 会包含描述编译到应用中的库依赖项的元数据。上传应用时，Play 管理中心会检查此元数据，以针对应用使用的 SDK 和依赖项的已知问题发出提醒，并在某些情况下提供可操作的反馈以解决这些问题。

数据经过压缩，由 Google Play 签名密钥加密，并存储在发布应用的签名块中。我们建议保留此依赖项文件，以确保安全和积极的用户体验。您可以通过在模块的 build.gradle.kts 文件中包含以下 dependenciesInfo 块来选择退出。

android {
    dependenciesInfo {
        // Disables dependency metadata when building APKs.
        includeInApk = false
        // Disables dependency metadata when building Android App Bundles.
        includeInBundle = false
    }
}

有关我们的政策和依赖项潜在问题的更多信息，请参阅我们关于在应用中使用第三方 SDK 的支持页面。

SDK 洞察

当出现以下问题时，Android Studio 会在版本目录文件和 Project Structure Dialog（项目结构对话框）中针对Google Play SDK 索引中的公共 SDK 显示 lint 警告

• SDK 被其作者标记为已过时。
• SDK 违反了 Play 政策。
• SDK 存在已知的安全漏洞。
• SDK 已被其作者弃用。

这些警告表明您应该更新这些依赖项，因为使用过时版本可能会导致您将来无法发布到 Google Play 管理中心。

在不使用版本目录的情况下添加构建依赖项

我们建议使用版本目录来添加和管理依赖项，但简单的项目可能不需要它们。以下是一个不使用版本目录的构建文件的示例

plugins {
    id("com.android.application")
}

android { ... }

dependencies {
    // Dependency on a remote binary
    implementation("com.example.android:app-magic:12.3")
    // Dependency on a local library module
    implementation(project(":mylibrary"))
}

plugins {
    id 'com.android.application'
}

android { ... }

dependencies {
    // Dependency on a remote binary
    implementation 'com.example.android:app-magic:12.3'
    // Dependency on a local library module
    implementation project(':mylibrary')
}

此构建文件在“com.example.android”命名空间组中声明了对“app-magic”库版本 12.3 的依赖项。远程二进制依赖项声明是以下内容的简写

implementation(group = "com.example.android", name = "app-magic", version = "12.3")

implementation group: 'com.example.android', name: 'app-magic', version: '12.3'

构建文件还声明了对名为“mylibrary”的Android 库模块的依赖项；此名称必须与在 settings.gradle.kts 文件中使用 include: 定义的库名称相匹配。构建应用时，构建系统会编译该库模块并将生成的编译内容打包到应用中。

构建文件还声明了对 Android Gradle 插件 (com.application.android) 的依赖项。如果您有多个模块使用同一个插件，则所有模块的构建类路径上只能有一个版本的插件。您应该将插件依赖项包含在根构建脚本中并指定版本，而不是在每个模块构建脚本中指定版本，并指明不应用它。添加 apply false 会告诉 Gradle 记录插件版本但不将其用于根构建。通常，根构建脚本除了这个 plugins 块外是空的。

plugins {
    id("org.jetbrains.kotlin.android") version "1.9.0" apply false
}

plugins {
    id ‘com.android.application’ version ‘8.3.0-rc02’ apply false
}

如果您有一个单模块项目，则可以在模块级构建脚本中明确指定版本，并使项目级构建脚本为空

plugins {
    id("com.android.application") version "8.3.0"
}

plugins {
    id 'com.android.application' version '8.3.0-rc02'
}