将 Firebase 添加到您的 Android 项目

前提条件

• 安装 Android Studio 或将其更新为最新版本。

• 确保您的 Android 应用符合以下条件：

  • 目标为 API 级别 16 (Jelly Bean) 或更高版本
  • 使用 Gradle 4.1 或更高版本

• 设置可用于运行应用的设备或模拟器。

  • 模拟器必须使用具有 Google Play 的模拟器映像。

• 使用您的 Google 帐号登录 Firebase。

如果您还没有 Android 应用项目，只是想试用某项 Firebase 产品，则可以下载我们的快速入门示例。

您可以使用以下选项之一将 Android 应用关联到 Firebase：

• 选项 1：（推荐）使用 Firebase 控制台设置工作流。
• 选项 2：使用 Android Studio Firebase Assistant（需要额外配置）。

选项 1：使用 Firebase 控制台添加 Firebase

将 Firebase 添加到您的应用需要在 Firebase 控制台中和打开的 Android 项目中执行若干任务（例如，从控制台下载 Firebase 配置文件，然后将配置文件移动到 Android 项目中）。

第 1 步：创建 Firebase 项目

您必须先创建一个 Firebase 项目，并将其关联到您的 Android 应用，然后才能将 Firebase 添加到您的 Android 应用。访问了解 Firebase 项目以详细了解 Firebase 项目。

创建 Firebase 项目

1. 在 Firebase 控制台中，点击添加项目，然后选择或输入项目名称。

   如果您已经拥有一个 Google Cloud Platform (GCP) 项目，则可以从项目名称下拉菜单中选择该项目。否则，请输入新的项目名称。

2. （可选）修改项目 ID。

   Firebase 会自动为您的 Firebase 项目分配一个唯一 ID。访问了解 Firebase 项目以了解 Firebase 如何使用该项目 ID。

   Firebase 为您的 Firebase 项目预配好资源后，您就无法再更改项目 ID。
   因此，若要使用特定标识符，您必须在此设置步骤修改项目 ID。

3. 在 Firebase 控制台中完成剩下的设置步骤，然后点击创建项目（如果您使用的是现有 Google 项目，则点击添加 Firebase）。

Firebase 会自动为您的 Firebase 项目预配资源。完成此过程后，您将进入 Firebase 控制台中 Firebase 项目的概览页面。

第 2 步：在 Firebase 中注册您的应用

拥有 Firebase 项目后，您就可以向其中添加 Android 应用了。

访问了解 Firebase 项目以详细了解将应用添加到 Firebase 项目的最佳做法和注意事项，包括如何处理多个应用版本。

1. 在 Firebase 控制台的项目概览页面的中心位置，点击 Android 图标以启动设置工作流。

   如果您已向 Firebase 项目添加了应用，请点击添加应用以显示平台选项。

2. 在 Android 软件包名称字段中输入您的应用 ID。

   确保输入应用实际使用的 ID。在向 Firebase 项目注册应用后，将无法添加或修改此值。

   • “应用 ID”有时被称为“软件包名称”。

   • 在您的模块（应用级）Gradle 文件（通常是 app/build.gradle）中找到此应用 ID（如 ID：com.yourcompany.yourproject）。

3. （可选）根据设置工作流的提示输入其他应用信息。

   别名是方便内部使用的标识符，只有您能在 Firebase 控制台中看到。

   注意：Firebase 身份验证（使用 Google 登录或电话号码登录功能时）和 Firebase 动态链接需要 SHA-1 信息。

4. 点击注册应用。

第 3 步：添加 Firebase 配置文件

1. 将 Firebase Android 配置文件添加到您的应用：

   1. 点击下载 google-services.json 以获取 Firebase Android 配置文件 (google-services.json)。

      • 您可以随时再次下载 Firebase Android 配置文件。
      • 请确保该配置文件名未附加其他字符，如 (2)。

   2. 接着将配置文件移动到应用的模块（应用级）目录中。

   注意：该 Firebase 配置文件包含项目的唯一、非机密标识符。
   访问了解 Firebase 项目以详细了解此配置文件。

2. 要在 Android 应用中启用 Firebase 产品，请将 Google 服务插件添加到 Gradle 文件中。

   1. 在根级（项目级）Gradle 文件 (build.gradle) 中添加相应规则，以包含 Google 服务插件。此外，请确认您是否拥有 Google 的 Maven 代码库。

      buildscript {
      
        repositories {
          // Check that you have the following line (if not, add it):
          google()  // Google's Maven repository
        }
      
        dependencies {
          // ...
      
          // Add the following line:
          classpath 'com.google.gms:google-services:4.2.0'  // Google Services plugin
        }
      }
      
      allprojects {
        // ...
      
        repositories {
          // Check that you have the following line (if not, add it):
          google()  // Google's Maven repository
          // ...
        }
      }
      

   2. 在您的模块（应用级）Gradle 文件（通常是 app/build.gradle）中，在文件末尾添加一行内容。

      apply plugin: 'com.android.application'
      
      android {
        // ...
      }
      
      // Add the following line to the bottom of the file:
      apply plugin: 'com.google.gms.google-services'  // Google Play services Gradle plugin
      

第 4 步：将 Firebase SDK 添加到您的应用

您可以将任何受支持的 Firebase 产品添加到 Android 应用中。我们建议您先从添加核心 Firebase SDK (com.google.firebase:firebase-core) 开始，该产品提供有 Google Analytics for Firebase 功能。

1. 在您的模块（应用级）Gradle 文件（通常是 app/build.gradle）中，添加核心 Firebase SDK 的依赖项：

   dependencies {
    // ...
    implementation 'com.google.firebase:firebase-core:17.0.0'
   
    // Getting a "Could not find" error? Make sure that you've added
    // Google's Maven repository to your root-level build.gradle file
   }
   

2. （可选）添加您要使用的其他 Firebase 库的依赖项。

   一些适用于 Android 的 Firebase SDK 提供了备选 Kotlin 扩展程序库。

3. 同步您的应用以确保所有依赖项都具有必要的版本。

4. 运行您的应用，向 Firebase 发送您已成功集成 Firebase 的验证信息。

   您的设备日志将显示说明初始化已完成的 Firebase 验证信息。如果您是在具有网络访问权限的模拟器上运行应用，则 Firebase 控制台会通知您应用连接已完成。

大功告成！您可以跳至后续步骤了。

选项 2：使用 Firebase Assistant 添加 Firebase

Firebase Assistant 可在 Firebase 项目中注册您的应用，并将必要的 Firebase 文件和代码添加到您的 Android 项目中 - 所有这些都在 Android Studio 中完成。

注意：使用 Firebase Assistant 时，请认真按照本指南这部分中所述的步骤检查所有依赖项和设置是否均已正确配置。

请注意，建议的做法是使用 Firebase 控制台设置工作流将应用关联至 Firebase。

1. 在 Android Studio 中打开您的 Android 项目。

2. 依次选择 Tools > Firebase 以打开 Assistant 窗口。

3. 展开所列 Firebase 产品之一（例如 Analytics），然后点击所提供的教程链接（例如“Log an Analytics event”）。

4. 点击 Connect to Firebase 以在已有或新的 Firebase 项目中注册您的应用，并自动向您的 Android 项目添加必要的文件和代码。

5. 检查您的插件和库版本是否最新：

   • 在根级（项目级）Gradle 文件 (build.gradle) 中，检查您的 Google 服务插件版本是否为最新版本 (com.google.gms:google-services:4.2.0)。

   • 在您的模块（应用级）Gradle 文件（通常是 app/build.gradle）中，检查您的 Firebase Android 库版本是否为最新版本。

   注意：如果您使用的是 Android Studio 3.2 版或更早版本，也请确保每个依赖项行仅指定了一个版本号。

6. 同步您的应用以确保所有依赖项都具有必要的版本。

7. 在 Firebase 控制台项目设置中配置您的 Analytics 数据共享设置。
   要使用 Firebase 预测或 Firebase A/B 测试等 Firebase 产品，必须允许与其他 Firebase 产品共享 Analytics 数据。

8. 运行您的应用，向 Firebase 发送您已成功集成 Firebase 的验证信息。

   您的设备日志将显示说明初始化已完成的 Firebase 验证信息。如果您是在具有网络访问权限的模拟器上运行应用，则 Firebase 控制台会通知您应用连接已完成。

可用的库

下面列出了各 Firebase 产品可使用的 Android 库。

一些适用于 Android 的 Firebase SDK 提供了备选 Kotlin 扩展程序库。

服务或产品	Gradle 依赖项行
Google Play 服务插件	com.google.gms:google-services:4.2.0
AdMob	com.google.firebase:firebase-ads:18.0.0
Analytics	com.google.firebase:firebase-core:17.0.0
App Indexing	com.google.firebase:firebase-appindexing:19.0.0
身份验证	com.google.firebase:firebase-auth:18.0.0
Cloud Firestore	com.google.firebase:firebase-firestore:20.0.0
Cloud Functions for Firebase 客户端 SDK	com.google.firebase:firebase-functions:18.0.0
云消息传递	com.google.firebase:firebase-messaging:19.0.0
Cloud Storage	com.google.firebase:firebase-storage:18.0.0
Crashlytics	com.crashlytics.sdk.android:crashlytics:2.10.1
动态链接	com.google.firebase:firebase-dynamic-links:18.0.0
应用内消息	com.google.firebase:firebase-inappmessaging:18.0.0
应用内消息显示	com.google.firebase:firebase-inappmessaging-display:18.0.0
机器学习套件：Vision API	com.google.firebase:firebase-ml-vision:21.0.0
机器学习套件：图片标签模型	com.google.firebase:firebase-ml-vision-image-label-model:18.0.0
机器学习套件：人脸检测模型	com.google.firebase:firebase-ml-vision-face-model:18.0.0
机器学习套件：对象检测和跟踪模型	com.google.firebase:firebase-ml-vision-object-detection-model:17.0.0
机器学习套件：Natural Language API	com.google.firebase:firebase-ml-natural-language:20.0.0
机器学习套件：语言识别模型	com.google.firebase:firebase-ml-natural-language-language-id-model:20.0.0
机器学习套件：翻译模型	com.google.firebase:firebase-ml-natural-language-translate-model:20.0.0
机器学习套件：智能回复模型	com.google.firebase:firebase-ml-natural-language-smart-reply-model:20.0.0
机器学习套件：自定义模型 API	com.google.firebase:firebase-ml-model-interpreter:20.0.0
机器学习套件：AutoML Vision Edge API	com.google.firebase:firebase-ml-vision-automl:17.0.0
性能监控	com.google.firebase:firebase-perf:18.0.0
实时数据库	com.google.firebase:firebase-database:18.0.0
远程配置	com.google.firebase:firebase-config:18.0.0

使用 Firebase 物料清单 (BoM) 进行库版本控制（实验性功能）

为便于进行库版本管理，请考虑导入 Firebase 物料清单 (BoM)。

使用 Firebase BoM 将 Firebase SDK 添加到您的应用

警告：Firebase Android 应用仅支持将 Firebase BoM 作为一项实验性功能。

通过将物料清单 (BoM) Gradle 功能与 Firebase 搭配使用，您可以作为一个整体来设置 Firebase 平台版本。每个 Firebase BoM 版本都包含 Firebase 库的兼容版本。要了解特定 BoM 版本对应的库版本，请参阅版本说明。

更新到最新的 BoM 版本会将所有 Firebase Android 库都更新到该 BoM 发布时可用的最新库版本。

要使用 Firebase BoM 将 Firebase SDK 添加到您的应用，请执行以下操作：

• 对于 Gradle 5.0 及更高版本，将自动启用 BoM 支持。 在模块 Gradle 文件（通常是 app/build.gradle）中设置依赖项：

  dependencies {
    // Import the platform
    implementation platform('com.google.firebase:firebase-bom:20.0.0')
  
    // When using a BoM, dependencies don't require a specified version
    // If you do specify a version, it overrides the library version specified in the BoM
    implementation 'com.google.firebase:firebase-core'
    implementation 'com.google.firebase:firebase-auth'
    implementation 'com.google.firebase:firebase-firestore'
  }
  

• 对于更早的 Gradle 版本，您必须启用 BoM 功能：
  1. 将 enableFeaturePreview('IMPROVED_POM_SUPPORT') 添加到 settings.gradle 文件中。
  2. 如同导入普通库一样导入 BoM（不带 platform 修饰符）。

将 firebase-bom 添加到依赖项后，可以声明 Firebase 库而不指定其版本。如果要更新 Firebase 库版本，您只需更新 Firebase BoM 版本即可。

如果您在库依赖项行中指定版本并使用 Firebase BoM，则指定的库版本将替换 BoM 中包含的版本值。

要报告问题或提供与 Firebase BoM 有关的反馈，请访问 GitHub 上的 Firebase Android SDK 代码库。

后续步骤

了解 Firebase：

• 访问了解 Firebase 项目以详细了解 Firebase 项目和项目的最佳做法。

• 探索 Firebase 应用示例。

• 借助 Firebase Android Codelab 获得实际上手经验。

• 报名参加周末学 Firebase 课程，加深对 Firebase 的了解。

• 准备启动您的应用：

  • 设置结算提醒。
  • 查看 Firebase 发布核对清单。

为您的应用添加 Firebase 功能：

• 借助 Analytics 深入分析用户行为。

• 使用身份验证设置用户身份验证流程。

• 使用 Cloud Firestore 或实时数据库存储数据（如用户信息）。

• 使用 Cloud Storage 存储文件，如照片和视频。

• 使用 Cloud Functions 函数触发在安全环境中运行的后端代码。

• 借助云消息传递功能发送通知。

• 借助 Crashlytics 确定应用崩溃的时间和原因。