将 Firebase 添加到您的 Android 应用

前提条件

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

  • 请确保您的项目满足以下要求（请注意，某些产品可能具有更严格的要求）：

  • 目标 API 级别为 23 (Marshmallow) 或更高版本

  • 使用 Android 6.0 或更高版本
  • 使用 Jetpack (AndroidX)，同时需要满足以下版本要求：
    • com.android.tools.build:gradle v7.3.0 或更高版本
    • 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 项目。

查看创建 Firebase 项目的说明

Firebase 或 Cloud 新用户

如果您是 Firebase 或 Google Cloud 的新用户，请按以下步骤操作。 如果您想创建一个全新的 Firebase 项目（以及其底层 Google Cloud 项目），也可以按照这些步骤操作。

  1. 登录 Firebase 控制台。
  2. 点击相应按钮以创建新的 Firebase 项目。
  3. 在文本字段中输入项目名称。

如果您是 Google Cloud 组织的成员，可以酌情选择在某个文件夹中创建项目（可选）。 4. 如果看到相关提示，请查看并接受 Firebase 条款，然后点击继续。 5. （可选）在 Firebase 控制台中启用 AI 辅助功能（称为“Gemini in Firebase”），可帮助您快速入门并简化开发流程。 6. （可选）为您的项目设置 Google Analytics，这样您在使用以下 Firebase 产品时可获得最佳体验：Firebase A/B Testing、Cloud Messaging、Crashlytics、In-App Messaging 和 Remote Config（包括个性化）。

您可以选择一个现有的 Google Analytics 账号，或者创建一个新账号。如果您创建新账号，请选择 Analytics 报告位置，然后接受项目的数据共享设置和 Google Analytics 条款。 7. 点击 Create project。

Firebase 会创建您的项目，预配一些初始资源，并启用重要 API。完成此过程后，您将进入 Firebase 控制台中该 Firebase 项目的概览页面。

现有 Cloud 项目

如果您想在现有 Google Cloud 项目中开始使用 Firebase，请按以下步骤操作。详细了解向现有 Google Cloud 项目“添加 Firebase”的方法，并排查相关问题。

  1. 使用拥有现有 Google Cloud 项目访问权限的账号登录 Firebase 控制台。
  2. 点击相应按钮以创建新的 Firebase 项目。
  3. 在页面底部，点击将 Firebase 添加到 Google Cloud 项目。
  4. 在文本字段中输入现有项目的项目名称，然后从显示的列表中选择该项目。
  5. 点击打开项目。
  6. 如果看到相关提示，请查看并接受 Firebase 条款，然后点击继续。
  7. （可选）在 Firebase 控制台中启用 AI 辅助功能（称为“Gemini in Firebase”），可帮助您快速入门并简化开发流程。
  8. （可选）为您的项目设置 Google Analytics，这样您在使用以下 Firebase 产品时可获得最佳体验：Firebase A/B Testing、Cloud Messaging、Crashlytics、In-App Messaging 和 Remote Config（包括个性化）。

您可以选择一个现有的 Google Analytics 账号，或者创建一个新账号。如果您创建新账号，请选择 Analytics 报告位置，然后接受项目的数据共享设置和 Google Analytics 条款。 9. 点击添加 Firebase。

Firebase 会将 Firebase 添加到现有项目。 完成此过程后，系统会将您带到 Firebase 控制台中该 Firebase 项目的概览页面。

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

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

  1. 前往 Firebase 控制台。
  2. 在项目概览页面的中心位置，点击 Android 图标 () 或添加应用，启动设置工作流。
  3. 在 Android 软件包名称字段中输入应用的软件包名称。

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

  • 软件包名称是您的应用在设备上和 Google Play 商店中的唯一标识符。
  • 软件包名称通常称为应用 ID。
  • 在模块（应用级）Gradle 文件（通常是 app/build.gradle）中查找应用的软件包名称（示例软件包名称：com.yourcompany.yourproject）。
  • 请注意，软件包名称值区分大小写，并且当您在 Firebase 项目中注册此 Firebase Android 应用后，将无法更改其软件包名称。
  • （可选）输入应用别名；这是用于内部的便捷标识符，仅您可在 Firebase 控制台中看到。
  • 点击注册应用。

第 3 步：添加 Firebase 配置文件

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

  2. 点击下载 google-services.json 以获取应用的 Firebase 配置文件。

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

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

  • 此 Firebase 配置文件包含项目和应用的唯一标识符（但不涉及机密信息）。如需进一步了解该配置文件，请访问了解 Firebase 项目。
  • 您可以随时再次下载 Firebase 配置文件。
  • 请确保该配置文件名未附加其他字符，如 (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.3.0" apply false // ...

    // Add the dependency for the Google services Gradle plugin
id("com.google.gms.google-services") version "4.4.4" apply false

    } ```

    ### Groovy

    ``` plugins { id 'com.android.application' version '7.3.0' apply false // ...

    // Add the dependency for the Google services Gradle plugin
id 'com.google.gms.google-services' version '4.4.4' apply false

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

### 已启用 Analytics

``` dependencies { // ...

 // Import the Firebase BoM
 implementation(platform("com.google.firebase:firebase-bom:34.11.0"))

 // 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

``` dependencies { // ...

 // Import the Firebase BoM
 implementation(platform("com.google.firebase:firebase-bom:34.11.0"))

 // 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：

  2. Windows/Linux：帮助 > 检查更新

  3. macOS：Android Studio > 检查更新
  4. 打开 Firebase Assistant：工具 > Firebase。

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

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

    此工作流有何用途？

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

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

    • 请查看有关将应用添加到 Firebase 项目的最佳实践，包括如何处理多个变体。
    • 如果您要创建新项目，我们强烈建议您为项目设置 Google Analytics，以便在使用众多 Firebase 产品时获得良好的体验。
    • 此工作流还会将 Firebase 项目的 Android 配置文件 (google-services.json) 添加到应用的模块（应用级）目录中。
    • 点击按钮以添加希望使用的 Firebase 产品（例如，将 Analytics 添加到您的应用）。
    • 同步您的应用以确保所有依赖项都具有必要的版本。
    • 在 Assistant 窗格中，按照所选 Firebase 产品的其余设置说明进行操作。
    • 通过 Firebase Assistant 添加任意数量的其他 Firebase 产品。

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

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