将 Firebase 添加到您的 Android 项目

前提条件

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

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

  • 目标 API 级别为 19 (KitKat) 或更高
  • 使用 Android 4.4 或更高版本
  • 使用 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 控制台中，点击添加项目。

   • 如需将 Firebase 资源添加到现有 Google Cloud 项目，请输入该项目的名称或从下拉菜单中选择该项目。

   • 如需创建新项目，请输入要使用的项目名称。您也可以视需要修改项目名称下方显示的项目 ID。

2. 如果看到相关提示，请查看并接受 Firebase 条款。

3. 点击继续。

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

   Firebase Crashlytics Firebase Cloud Messaging

   Firebase In-App Messaging Firebase Remote Config

   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。

   应用别名和调试签名证书 SHA-1 在 Firebase 中的作用是什么？

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

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

5. 点击注册应用。

第 3 步：添加 Firebase 配置文件

1. 下载 Firebase Android 配置文件 (google-services.json)，然后将其添加到您的应用：

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

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

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

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

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

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

2. 为了确保 Firebase SDK 可以访问 google-services.json 配置文件中的值，您需要具有 Google 服务 Gradle 插件 (google-services)。

   1. 在您的根级（项目级）Gradle 文件（<project>/build.gradle.kts 或 <project>/build.gradle）中，将 Google 服务插件添加为依赖项：

      Kotlin

      plugins {
        id("com.android.application") version "7.2.0" apply false
        // ...
      
        // Add the dependency for the Google services Gradle plugin
        id("com.google.gms.google-services") version "4.3.15" apply false
      }
      

      Groovy

      plugins {
        id 'com.android.application' version '7.2.0' apply false
        // ...
      
        // Add the dependency for the Google services Gradle plugin
        id 'com.google.gms.google-services' version '4.3.15' apply false
      }
      

   2. 在您的模块（应用级）Gradle 文件（通常是 <project>/<app-module>/build.gradle.kts 或 <project>/<app-module>/build.gradle）中，添加 Google 服务插件：

      Kotlin

      plugins {
        id("com.android.application")
      
        // Add the Google services Gradle plugin
        id("com.google.gms.google-services")
        // ...
      }
      

      Groovy

      plugins {
        id 'com.android.application'
      
        // Add the Google services Gradle plugin
        id 'com.google.gms.google-services'
        // ...
      }
      

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

1. 在您的模块（应用级）Gradle 文件（通常是 <project>/build.gradle.kts 或 <project>/build.gradle）中，添加您需要在应用中使用的 Firebase 产品的依赖项。我们建议使用 Firebase Android BoM 来实现库版本控制。

   已启用 Analytics

   Kotlin+KTX

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation(platform("com.google.firebase:firebase-bom:32.3.1"))
   
     // When using the BoM, you don't specify versions in Firebase library dependencies
   
     // Add the dependency for the Firebase SDK for Google Analytics
     implementation("com.google.firebase:firebase-analytics-ktx")
   
     // TODO: Add the dependencies for any other Firebase products you want to use
     // See https://firebase.google.com/docs/android/setup#available-libraries
     // For example, add the dependencies for Firebase Authentication and Cloud Firestore
     implementation("com.google.firebase:firebase-auth-ktx")
     implementation("com.google.firebase:firebase-firestore-ktx")
   }
   

   Java

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation(platform("com.google.firebase:firebase-bom:32.3.1"))
   
     // When using the BoM, you don't specify versions in Firebase library dependencies
   
     // Add the dependency for the Firebase SDK for Google Analytics
     implementation("com.google.firebase:firebase-analytics")
   
     // TODO: Add the dependencies for any other Firebase products you want to use
     // See https://firebase.google.com/docs/android/setup#available-libraries
     // For example, add the dependencies for Firebase Authentication and Cloud Firestore
     implementation("com.google.firebase:firebase-auth")
     implementation("com.google.firebase:firebase-firestore")
   }
   

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

   未启用 Analytics

   Kotlin+KTX

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation(platform("com.google.firebase:firebase-bom:32.3.1"))
   
     // When using the BoM, you don't specify versions in Firebase library dependencies
   
     // TODO: Add the dependencies for Firebase products you want to use
     // See https://firebase.google.com/docs/android/setup#available-libraries
     // For example, add the dependencies for Firebase Authentication and Cloud Firestore
     implementation("com.google.firebase:firebase-auth-ktx")
     implementation("com.google.firebase:firebase-firestore-ktx")
   }
   

   Java

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation(platform("com.google.firebase:firebase-bom:32.3.1"))
   
     // When using the BoM, you don't specify versions in Firebase library dependencies
   
     // TODO: Add the dependencies for Firebase products you want to use
     // See https://firebase.google.com/docs/android/setup#available-libraries
     // For example, add the dependencies for Firebase Authentication and Cloud Firestore
     implementation("com.google.firebase:firebase-auth")
     implementation("com.google.firebase:firebase-firestore")
   }
   

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

2. 添加了需要使用的产品的依赖项之后，将 Android 项目与 Gradle 文件同步。

   您是否收到了关于调用自定义 (invoke-custom) 支持和启用脱糖 (desugaring) 的构建失败消息？解决方法如下。

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

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

   • 将错误消息中列出的 compileOptions 添加到您的应用级 build.gradle.kts 或 build.gradle 文件中。
   • 将 Android 项目的 minSdk 提升到 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 > 记录 Analytics 事件）。

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

      此工作流有何用途？

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

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

        • 请查看有关将应用添加到 Firebase 项目的最佳实践，包括如何处理多个变体。

        • 如果您要创建新项目，我们强烈建议您为项目设置 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 库：

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

• Firebase Android SDK GitHub 代码库

请注意，如果使用 Firebase Android BoM，在 Gradle build 配置文件中声明 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 控制台中，为您的项目设置预算提醒。
  • 在 Firebase 控制台中监控“用量和结算”信息中心，以全面了解您的项目在多个 Firebase 服务中的用量信息。
  • 查看 Firebase 发布核对清单。

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