将 Firebase 添加到您的 Android 项目

前提条件

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

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

    • 目标 API 级别为 19 (KitKat) 或更高
    • 使用 Android 4.4 或更高版本
    • 使用 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 项目以了解详情。

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

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

  1. 前往 Firebase 控制台。

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

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

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

  5. 点击注册应用。

第 3 步：添加 Firebase 配置文件

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

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

    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.3.0" apply false
  // ...

  // Add the dependency for the Google services Gradle plugin
  id("com.google.gms.google-services") version "4.4.2" 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.2' 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>/<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:33.3.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 库的兼容版本。

    是否想要查找 Kotlin 专用的库模块？从 2023 年 10 月 (Firebase BoM 32.5.0) 开始，Kotlin 和 Java 开发者可以依赖于主库模块（如需了解详情，请参阅关于此计划的常见问题解答）。

    未启用 Analytics

    dependencies {
  // ...

  // Import the Firebase BoM
  implementation(platform("com.google.firebase:firebase-bom:33.3.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 库的兼容版本。

    是否想要查找 Kotlin 专用的库模块？从 2023 年 10 月 (Firebase BoM 32.5.0) 开始，Kotlin 和 Java 开发者可以依赖于主库模块（如需了解详情，请参阅关于此计划的常见问题解答）。

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

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

如果您在设置时遇到问题，请参阅 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 [记录 Analytics 事件]）。

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

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

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

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

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

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

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


可用的库

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

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

服务或产品 Gradle 依赖项 最新
版本		 添加 Analytics？
Firebase Android BoM
（Bill of Materials）		 com.google.firebase:firebase-bom

最新版 Firebase BoM 包含每个 Firebase Android 库的最新版本。如需了解特定的 BoM 版本对应哪些库版本，请查看该 BoM 版本的版本说明。

 33.3.0
AdMob com.google.android.gms:play-services-ads 23.3.0
Analytics com.google.firebase:firebase-analytics 22.1.0
App Check 自定义提供程序 com.google.firebase:firebase-appcheck 18.0.0
App Check 调试提供程序 com.google.firebase:firebase-appcheck-debug 18.0.0
App Check Play Integrity 提供程序 com.google.firebase:firebase-appcheck-playintegrity 18.0.0
App Distribution com.google.firebase:firebase-appdistribution 16.0.0-beta14
App Distribution API com.google.firebase:firebase-appdistribution-api 16.0.0-beta14
App Distribution 插件 com.google.firebase:firebase-appdistribution-gradle 5.0.0
Authentication com.google.firebase:firebase-auth 23.0.0
Cloud Firestore com.google.firebase:firebase-firestore 25.1.0
Cloud Functions for Firebase Client SDK com.google.firebase:firebase-functions 21.0.0
Cloud Messaging com.google.firebase:firebase-messaging 24.0.1
Cloud Storage com.google.firebase:firebase-storage 21.0.0
Crashlytics com.google.firebase:firebase-crashlytics 19.1.0
Crashlytics NDK com.google.firebase:firebase-crashlytics-ndk 19.1.0
Crashlytics 插件 com.google.firebase:firebase-crashlytics-gradle 3.0.2
动态功能模块支持 com.google.firebase:firebase-dynamic-module-support 16.0.0-beta03
Dynamic Links com.google.firebase:firebase-dynamic-links 22.1.0
In-App Messaging com.google.firebase:firebase-inappmessaging 21.0.0
（需要）
In-App Messaging Display com.google.firebase:firebase-inappmessaging-display 21.0.0
（需要）
Firebase 安装 com.google.firebase:firebase-installations 18.0.0
Firebase ML Model Downloader API com.google.firebase:firebase-ml-modeldownloader 25.0.0
Performance Monitoring com.google.firebase:firebase-perf 21.0.1
Performance Monitoring 插件 com.google.firebase:perf-plugin 1.4.2
Realtime Database com.google.firebase:firebase-database 21.0.0
Remote Config com.google.firebase:firebase-config 22.0.0
Vertex AI in Firebase com.google.firebase:firebase-vertexai 16.0.0-beta05
Google Play 服务插件 com.google.gms:google-services 4.4.2
弃用的库
App Check SafetyNet 提供程序 com.google.firebase:firebase-appcheck-safetynet 16.1.2
App Indexing com.google.firebase:firebase-appindexing 20.0.0

Firebase KTX 模块

Analytics com.google.firebase:firebase-analytics-ktx 22.1.0
App Check 自定义提供程序 com.google.firebase:firebase-appcheck-ktx 18.0.0
App Distribution API com.google.firebase:firebase-appdistribution-api-ktx 16.0.0-beta14
Authentication com.google.firebase:firebase-auth-ktx 23.0.0
Cloud Firestore com.google.firebase:firebase-firestore-ktx 25.1.0
Cloud Functions for Firebase Client SDK com.google.firebase:firebase-functions-ktx 21.0.0
Cloud Messaging com.google.firebase:firebase-messaging-ktx 24.0.1
Cloud Storage com.google.firebase:firebase-storage-ktx 21.0.0
Crashlytics com.google.firebase:firebase-crashlytics-ktx 19.1.0
Dynamic Links com.google.firebase:firebase-dynamic-links-ktx 22.1.0
In-App Messaging com.google.firebase:firebase-inappmessaging-ktx 21.0.0
（需要）
In-App Messaging Display com.google.firebase:firebase-inappmessaging-display-ktx 21.0.0
（需要）
Firebase 安装 com.google.firebase:firebase-installations-ktx 18.0.0
Firebase ML Model Downloader API com.google.firebase:firebase-ml-modeldownloader-ktx 25.0.0
Performance Monitoring com.google.firebase:firebase-perf-ktx 21.0.1
Realtime Database com.google.firebase:firebase-database-ktx 21.0.0
Remote Config com.google.firebase:firebase-config-ktx 22.0.0

Firebase 机器学习套件库

Firebase ML 自定义模型 API com.google.firebase:firebase-ml-model-interpreter 22.0.4
Firebase ML Vision API com.google.firebase:firebase-ml-vision 24.1.0
Firebase ML：图片标签模型 com.google.firebase:firebase-ml-vision-image-label-model 20.0.2
Firebase ML：对象检测和跟踪模型 com.google.firebase:firebase-ml-vision-object-detection-model 19.0.6
Firebase ML：人脸检测模型 com.google.firebase:firebase-ml-vision-face-model 20.0.2
Firebase ML：条形码扫描模型 com.google.firebase:firebase-ml-vision-barcode-model 16.1.2
Firebase ML：AutoML Vision Edge API com.google.firebase:firebase-ml-vision-automl 18.0.6
Firebase ML：Natural Language API com.google.firebase:firebase-ml-natural-language 22.0.1
Firebase ML：语言识别模型 com.google.firebase:firebase-ml-natural-language-language-id-model 20.0.8
Firebase ML：翻译模型 com.google.firebase:firebase-ml-natural-language-translate-model 20.0.9
Firebase ML：智能回复模型 com.google.firebase:firebase-ml-natural-language-smart-reply-model 20.0.8


后续步骤

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

了解 Firebase：