Google 服务 Gradle 插件

简介

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

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

google-services 插件有两个主要函数：

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

  2. 为您拥有的服务所需的基本库添加依赖项 。此步骤要求您将 Google 服务 Gradle 在 app/build.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 文件时，该插件仅使用 与您的软件包名称匹配的 client 对象（针对当前 build） 类型）相关联：

  • 对于 client 数组的每个成员： <ph type="x-smartling-placeholder">
      </ph>
    • 查看 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

问题排查

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

答：Firebase 控制台可为您提供帮助 请下载google-services.json。 此外，大多数 API 的快速入门指南都提供了有关 生成此文件。 下载 google-services.json 文件后，将其复制 进入 Android Studio 项目的 app/ 文件夹，或进入 app/src/{build_type} 文件夹中。

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

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