Google 服务 Gradle 插件

简介

在 Android 应用中启用 Google API 或 Firebase 服务的过程中，您可能需要将 google-services 插件添加到 build.gradle 文件中：

dependencies {
    classpath 'com.google.gms:google-services:4.4.0'
    // ...
}

google-services 插件有两个主要功能：

  1. 处理 google-services.json 文件并生成可在应用代码中使用的 Android 资源。如需了解详情，请参阅添加 JSON 文件。

  2. 为您已启用的服务添加所需的基本库的依赖项。此步骤要求您在 app/build.gradle 文件中应用 Google 服务 Gradle 插件，如下所示：
    apply plugin: 'com.google.gms.google-services'

    您可以运行 ./gradlew :app:dependencies 来查看此步骤的结果。

添加 JSON 文件

google-services.json 文件通常位于 app/ 目录下（位于 Android Studio 应用模块的根目录下）。从 2.2.0 版开始，该插件支持特定于 build 类型和产品变种的 JSON 文件。以下所有目录结构均有效：

// dogfood and release are build types.
app/
    google-services.json
    src/dogfood/google-services.json
    src/release/google-services.json
    ...

注意：您可以在发布目录中提供 google-services.json 文件，以便为您的正式版 APK 维护一个单独的 Firebase 项目。

在使用产品变种时，这些更复杂的目录结构同样有效。

// free and paid are product flavors.
app/
    google-services.json
    src/dogfood/paid/google-services.json
    src/release/free/google-services.json
    ...

处理 JSON 文件

google-services.json 文件具有以下基本结构：

{
  "project_info": {...},
  "client": [...],
}

project_info 对象包含有关项目的一般信息，而 client 数组的每个成员均包含您已添加到项目的客户端（Android 应用）的相关信息。

在处理 Android 应用的 JSON 文件时，该插件仅会基于以下逻辑使用与软件包名称（针对当前 build 类型）匹配的 client 对象：

  • 对于 client 数组的每个成员：
    • 检查 client_info/android_client_info/package_name 的值
    • 如果软件包名称与此值匹配，则返回成员对象。
  • 如果 client 的所有成员都与软件包名称不匹配，则会抛出异常。

在本文档的其余部分，我们将使用 {YOUR_CLIENT} 来引用由上述过程确定的 client 数组的成员。

JSON 处理的主要结果是生成两个 XML 文件，您可以在 Java 代码中将它们作为 Android 资源引用。以下是每个文件的示例：

app/build/generated/res/google-services/{build_type}/values/values.xml

<?xml version="1.0" encoding="utf-8"?>
<resources>

    <! -- Present in all applications -->
    <string name="google_app_id" translatable="false">1:1035469437089:android:73a4fb8297b2cd4f</string>

    <! -- Present in applications with the appropriate services configured -->
    <string name="gcm_defaultSenderId" translatable="false">1035469437089</string>
    <string name="default_web_client_id" translatable="false">337894902146-e4uksm38sne0bqrj6uvkbo4oiu4hvigl.apps.googleusercontent.com</string>
    <string name="ga_trackingId" translatable="false">UA-65557217-3</string>
    <string name="firebase_database_url" translatable="false">https://example-url.firebaseio.com</string>
    <string name="google_api_key" translatable="false">AIzbSyCILMsOuUKwN3qhtxrPq7FFemDJUAXTyZ8</string>
    <string name="google_crash_reporting_api_key" translatable="false">AIzbSyCILMsOuUKwN3qhtxrPq7FFemDJUAXTyZ8</string>
    <string name="project_id" translatable="false">mydemoapp</string>

</resources>

app/build/generated/res/google-services/{flavor}/{build_type}/xml/global_tracker.xml

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <string name="ga_trackingId" translatable="false">UA-65557218-3</string>
</resources>

XML 文件中的每个值都存在于 google-services.json 文件中的以下位置。如果您的 Android 项目的某些配置阻止您使用 google-services 插件，您可以使用这些值安全地手动重新创建 XML 文件：

google_app_id:

{YOUR_CLIENT}/client_info/mobilesdk_app_id

gcm_defaultSenderId：

project_info/project_number

default_web_client_id:

{YOUR_CLIENT}/oauth_client/client_id (client_type == 3)

ga_trackingId:

{YOUR_CLIENT}/services/analytics-service/analytics_property/tracking_id

firebase_database_url:

project_info/firebase_url

google_api_key:

{YOUR_CLIENT}/api_key/current_key

google_crash_reporting_api_key:

{YOUR_CLIENT}/api_key/current_key

project_id：

project_info/project_id

问题排查

问：在构建时，我收到以下错误消息：“模块根文件夹中缺少文件 google-services.json。没有它，Google 服务插件将无法运行”。

答：Firebase 控制台可帮助您下载 google-services.json。此外，大多数 API 的快速入门指南中都提供了有关生成此文件的说明。下载 google-services.json 文件后，请将其复制到 Android Studio 项目的 app/ 文件夹中；如果您使用的是多种 build 类型，请将其复制到 app/src/{build_type} 文件夹中。

问：我找不到“R.string.gcm_defaultSenderId”“R.xml.global_tracker”等符号。

答：请确保 build.gradle 文件中的软件包名称与您在创建 google-services.json 文件时输入的软件包名称匹配。如果您不确定，请再次执行入门流程，并获取新的 json 文件。