Google 服务 Gradle 插件和 JSON 配置文件

在将 Firebase 添加到您的 Android 项目时，您需要将 google-services Gradle 插件和 google-services.json 配置文件添加到您的项目。

如果您使用 Firebase 控制台、Management REST API 或 Firebase CLI 将 Firebase 添加到您的 Android 项目，则必须手动将 Gradle 插件和 JSON 配置文件添加到您的项目。 不过，如果您使用 Firebase Assistant for Android Studio，则系统会在设置过程中自动为您完成这些任务。

添加 Gradle 插件

将 Google 服务 Gradle 插件 (google-services) 添加到 build.gradle 文件中：

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

Google 服务 Gradle 插件有两项主要功能：

  • 处理 google-services.json 配置文件，并生成可在应用代码中使用的 Android 资源。

  • 为已启用的服务添加所需的基本库的依赖项。此步骤要求您在 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
    ...

如果使用 build variant，这些更复杂的目录结构也有效。

// 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 数组的成员。

生成 XML 文件

JSON 处理的主要结果是生成两个 XML 文件，您可以在代码中将这两个文件作为 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 文件中的值

XML 文件中的每个值都位于 google-services.json 配置文件中的以下位置。如果您的 Android 项目的某些配置导致您无法使用 google-services Gradle 插件，您可以放心地使用这些值手动重新创建 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

问题排查

在构建时，我收到以下错误消息：File google-services.json is missing from module root folder. The Google Services Plugin cannot function without it。

Firebase 控制台将帮助您下载 google-services.json 配置文件。

下载 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 文件。