将 Firebase 添加到您的 Android 项目

前提条件

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

• 确保您的项目满足以下要求：

  • 目标 API 级别为 16 (Jelly Bean) 或更高
  • 使用 Android 4.1 或更高版本
  • 使用 Jetpack (AndroidX)，同时需要满足以下版本要求：
    • com.android.tools.build:gradle 3.2.1 版或更高版本
    • compileSdkVersion 28 或更高版本

• 设置一台实体设备或使用模拟器运行您的应用。
  请注意，依赖于 Google Play 服务的 Firebase SDK 需要在设备或模拟器上安装 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 项目

您需要先创建一个要关联到 Android 应用的 Firebase 项目，然后才能将 Firebase 添加到您的 Android 应用。请访问了解 Firebase 项目以了解详情。

创建 Firebase 项目

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

   如果您已有 Google Cloud 项目，则可以从下拉菜单中选择该项目，然后将 Firebase 资源添加到该项目中。

2. （可选）如果要创建一个新项目，可以修改项目 ID。

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

3. 点击继续。

4. （可选）为您的项目设置 Google Analytics（分析），以便在使用以下任何 Firebase 产品时获得最佳体验：

   Firebase Crashlytics Firebase Predictions

   Firebase Cloud Messaging Firebase In-App Messaging

   Firebase Remote Config Firebase A/B Testing

   出现提示时，选择使用现有的 Google Analytics（分析）帐号或新建帐号。
   如果您选择创建一个新帐号，请选择 Analytics（分析）报告位置，然后接受项目的数据共享设置和 Google Analytics（分析）条款。

5. 点击创建项目（如果使用现有的 Google Cloud 项目，则点击添加 Firebase）。

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

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

如需在 Android 应用中使用 Firebase，您需要向 Firebase 项目注册您的应用。注册应用的过程通常称为将应用“添加”到项目中。

1. 转到 Firebase 控制台。

2. 在项目概览页面的中心，点击 Android 图标 (plat_android) 或添加应用以启动设置工作流。

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

   软件包名称是什么？您可以在哪里找到它？

   • 软件包名称是您的应用在设备上和 Google Play 商店中的唯一标识符。

   • 软件包名称通常称为应用 ID。

   • 在模块（应用级）Gradle 文件中查找应用的软件包名称，通常是 app/build.gradle（示例软件包名称：com.yourcompany.yourproject）。

   • 请注意，软件包名称值区分大小写，并且当您在 Firebase 项目中注册此 Firebase Android 应用后，将无法更改该名称。

4. （可选）输入其他应用信息：应用别名和调试签名证书 SHA-1。

   如何在 Firebase 中使用应用别名和调试签名证书 SHA-1？

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

   • 调试签名证书 SHA-1：Firebase Authentication（使用 Google 登录或手机号码登录时）和 Firebase Dynamic Links 需要 SHA-1 哈希。

5. 点击注册应用。

第 3 步：添加 Firebase 配置文件

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

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

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

   关于此配置文件，您需要了解哪些信息？

   • 此 Firebase 配置文件包含项目的唯一、非密文的标识符。如需详细了解此配置文件，请访问了解 Firebase 项目。

   • 您可以随时再次下载 Firebase 配置文件。

   • 请确保该配置文件名未附加其他字符，如 (2)。

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

   1. 在根级（项目级）Gradle 文件 (build.gradle) 中添加规则，以纳入 Google 服务 Gradle 插件。此外，请确认您拥有 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.3.10'  // 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）中，应用 Google 服务 Gradle 插件：

      apply plugin: 'com.android.application'
      // Add the following line:
      apply plugin: 'com.google.gms.google-services'  // Google Services plugin
      
      android {
        // ...
      }
      

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

1. 使用 Firebase Android BoM 声明您要在应用中使用的 Firebase 产品的依赖项。在模块（应用级）Gradle 文件（通常为 app/build.gradle）中声明这些依赖项。

   已启用 Analytics

   Java

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation platform('com.google.firebase:firebase-bom:28.4.1')
   
     // When using the BoM, you don't specify versions in Firebase library dependencies
   
     // Declare the dependency for the Firebase SDK for Google Analytics
     implementation 'com.google.firebase:firebase-analytics'
   
     // Declare the dependencies for any other desired Firebase products
     // For example, declare the dependencies for Firebase Authentication and Cloud Firestore
     implementation 'com.google.firebase:firebase-auth'
     implementation 'com.google.firebase:firebase-firestore'
   }
   

   Kotlin+KTX

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation platform('com.google.firebase:firebase-bom:28.4.1')
   
     // When using the BoM, you don't specify versions in Firebase library dependencies
   
     // Declare the dependency for the Firebase SDK for Google Analytics
     implementation 'com.google.firebase:firebase-analytics-ktx'
   
     // Declare the dependencies for any other desired Firebase products
     // For example, declare the dependencies for Firebase Authentication and Cloud Firestore
     implementation 'com.google.firebase:firebase-auth-ktx'
     implementation 'com.google.firebase:firebase-firestore-ktx'
   }
   

   使用 Firebase Android BoM，可确保您的应用始终使用 Firebase Android 库的兼容版本。

   未启用 Analytics

   Java

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation platform('com.google.firebase:firebase-bom:28.4.1')
   
     // When using the BoM, you don't specify versions in Firebase library dependencies
   
     // Declare the dependencies for the desired Firebase products
     // For example, declare the dependencies for Firebase Authentication and Cloud Firestore
     implementation 'com.google.firebase:firebase-auth'
     implementation 'com.google.firebase:firebase-firestore'
   }
   

   Kotlin+KTX

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation platform('com.google.firebase:firebase-bom:28.4.1')
   
     // When using the BoM, you don't specify versions in Firebase library dependencies
   
     // Declare the dependencies for the desired Firebase products
     // For example, declare the dependencies for Firebase Authentication and Cloud Firestore
     implementation 'com.google.firebase:firebase-auth-ktx'
     implementation 'com.google.firebase:firebase-firestore-ktx'
   }
   

   使用 Firebase Android BoM，可确保您的应用始终使用 Firebase Android 库的兼容版本。

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

   收到关于调用自定义支持和启用脱糖的构建失败消息？解决方法如下。

   使用 Android Gradle 插件 (AGP) v4.2 或更早版本的 Gradle 构建需要启用 Java 8 支持。否则，这些 Android 项目在添加 Firebase SDK 时会遇到构建失败问题。

   要解决此构建失败问题，您可以采用以下两种方案中的一种：

   • 将错误消息中列出的 compileOptions 添加到您的应用级 build.gradle 文件中。
   • 将 Android 项目的 minSdkVersion 增大为 26 或更大数字。

   如需详细了解此构建失败问题，请参阅此常见问题解答。

大功告成！您可以跳过，直接查看推荐的后续步骤。

如果您在设置时遇到问题，请参阅 Android 问题排查和常见问题解答。

---

选项 2：使用 Firebase Assistant 添加 Firebase

Firebase Assistant 可在 Firebase 项目中注册您的应用，并将必要的 Firebase 文件、插件和依赖项添加到您的 Android 项目中 - 这一切都在 Android Studio 中完成！

1. 在 Android Studio 中打开您的 Android 项目，然后确保您使用的是最新版 Android Studio 和 Firebase Assistant：

   • Windows/Linux：帮助 > 检查更新
   • macOS：Android Studio > 检查更新

2. 打开 Firebase Assistant：工具 > Firebase。

3. 在 Assistant 窗格中，选择要添加到应用的 Firebase 产品。展开该产品部分，然后点击教程链接（例如 Analytics > Log an Analytics event）。

   1. 点击 Connect to Firebase，将您的 Android 项目与 Firebase 连接。

      此工作流有何用途？

      • 此工作流会自动使用应用的软件包名称创建新的 Firebase Android 应用。您可以在现有 Firebase 项目或新项目中创建新的 Firebase Android 应用。

        以下是有关设置 Firebase 项目的一些提示：

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

        • 如果您要创建新项目，我们强烈建议您为项目设置 Google Analytics（分析），以便在使用众多 Firebase 产品时获得最佳体验。

      • 此工作流还会将 Firebase 项目的 Android 配置文件 (google-services.json) 添加到应用的模块（应用级）目录中。

   2. 点击按钮以添加希望使用的 Firebase 产品（例如，将 Analytics 添加到您的应用）。

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

5. 在 Assistant 窗格中，按照所选 Firebase 产品的其余设置说明进行操作。

6. 通过 Firebase Assistant 添加任意数量的其他 Firebase 产品。

大功告成！请务必查看建议的后续步骤。

如果您在设置时遇到问题，请参阅 Android 问题排查和常见问题解答。

---

可用的库

本部分列出了 Android 支持的 Firebase 产品及其 Gradle 依赖项。详细了解以下 Firebase Android 库：

• 参考文档 (Java | Kotlin+KTX)

• Firebase Android SDK GitHub 代码库

请注意，如果使用 Firebase Android BoM，在 build.gradle 中声明 Firebase 库依赖项时，您无需指定具体的库版本。

---

后续步骤

将 Firebase 服务添加到您的应用：

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

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

• 使用 Cloud Firestore 或 Realtime Database 存储数据（如用户信息）。

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

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

• 借助 Cloud Messaging 功能发送通知。

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

了解 Firebase：

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

• 如果您对不熟悉的概念或特定于 Firebase 和 Android 开发的概念有疑问，请访问详细了解 Android 和 Firebase。

• 探索 Firebase 应用示例。

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

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

• 准备启动您的应用：

  • 在 Google Cloud Console 中为您的项目设置预算提醒。
  • 在 Firebase 控制台中监控“使用量和结算”信息中心，以全面了解您的项目在多个 Firebase 服务中的使用情况。
  • 查看 Firebase 发布核对清单。

• 在使用 Firebase 和 Android 项目时遇到问题？ 请参阅 Android 问题排查和常见问题解答。