获取我们在 Firebase 峰会上发布的所有信息,了解 Firebase 可如何帮助您加快应用开发速度并满怀信心地运行应用。了解详情

将 Firebase 添加到您的 Android 项目

先决条件

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

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

    • 目标 API 级别 19 (KitKat) 或更高级别
    • 使用 Android 4.4 或更高版本
    • 使用Jetpack (AndroidX) ,其中包括满足以下版本要求:
      • com.android.tools.build:gradle v3.2.1 或更高版本
      • compileSdkVersion 28 或更高版本
  • 设置物理设备或使用模拟器来运行您的应用程序。
    请注意,依赖于 Google Play 服务的 Firebase SDK要求设备或模拟器安装 Google Play 服务。

  • 使用您的 Google 帐户登录 Firebase

如果您还没有 Android 项目并且只想试用 Firebase 产品,您可以下载我们的快速入门示例之一。


您可以使用以下选项之一将您的 Android 应用程序连接到 Firebase:

  • 选项 1 :(推荐)使用 Firebase 控制台设置工作流。
  • 选项 2 :使用 Android Studio Firebase 助手(可能需要额外的配置)。



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

将 Firebase 添加到您的应用涉及Firebase 控制台和您打开的 Android 项目中的任务(例如,您从控制台下载 Firebase 配置文件,然后将它们移动到您的 Android 项目中)。

第 1 步:创建一个 Firebase 项目

在将 Firebase 添加到您的 Android 应用程序之前,您需要创建一个 Firebase 项目以连接到您的 Android 应用程序。访问了解 Firebase 项目以了解有关 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. 要使google-services.json配置文件中的值可供 Firebase SDK 访问,您需要Google 服务 Gradle 插件( google-services )。

    1. 在您的根级(项目级) Gradle 文件 ( <project>/build.gradle ) 中,将 Google 服务插件添加为构建脚本依赖项:

      buildscript {
      
          repositories {
            // Make sure that you have the following two repositories
            google()  // Google's Maven repository
            mavenCentral()  // Maven Central repository
          }
      
          dependencies {
            ...
      
            // Add the dependency for the Google services Gradle plugin
            classpath 'com.google.gms:google-services:4.3.14'
          }
      }
      
      allprojects {
        ...
      
        repositories {
          // Make sure that you have the following two repositories
          google()  // Google's Maven repository
          mavenCentral()  // Maven Central repository
        }
      }
      
    2. 在您的模块(应用程序级别) Gradle 文件(通常是<project>/<app-module>/build.gradle )中,添加 Google 服务插件:

      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 )中,添加您要在应用程序中使用的Firebase 产品的依赖项。我们建议使用Firebase Android BoM来控制库版本。

    启用分析

    Java

    dependencies {
      // ...
    
      // Import the Firebase BoM
      implementation platform('com.google.firebase:firebase-bom:31.1.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'
    }
    

    Kotlin+KTX

    dependencies {
      // ...
    
      // Import the Firebase BoM
      implementation platform('com.google.firebase:firebase-bom:31.1.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-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'
    }
    

    通过使用Firebase Android BoM ,您的应用将始终使用兼容版本的 Firebase Android 库。

    未启用分析

    Java

    dependencies {
      // ...
    
      // Import the Firebase BoM
      implementation platform('com.google.firebase:firebase-bom:31.1.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'
    }
    

    Kotlin+KTX

    dependencies {
      // ...
    
      // Import the Firebase BoM
      implementation platform('com.google.firebase:firebase-bom:31.1.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-ktx'
      implementation 'com.google.firebase:firebase-firestore-ktx'
    }
    

    通过使用Firebase Android BoM ,您的应用将始终使用兼容版本的 Firebase Android 库。

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

而已!您可以向前跳到查看建议的后续步骤

不过,如果您在设置时遇到问题,请访问Android 故障排除和常见问题解答



选项 2 :使用 Firebase 助手添加 Firebase

Firebase 助手将您的应用程序注册到 Firebase 项目,并将必要的 Firebase 文件、插件和依赖项添加到您的 Android 项目——所有这些都在 Android Studio 中完成!

  1. 在 Android Studio 中打开您的 Android 项目,然后确保您使用的是最新版本的 Android Studio 和 Firebase 助手:

    • Windows / Linux:帮助 > 检查更新
    • macOS: Android Studio > 检查更新
  2. 打开 Firebase 助手:工具 > Firebase

  3. 在“助手”窗格中,选择要添加到您的应用程序的 Firebase 产品。展开其部分,然后单击教程链接(例如, Analytics > Log an Analytics event )。

    1. 单击连接到 Firebase以将您的 Android 项目连接到 Firebase。

    2. 单击按钮添加所需的 Firebase 产品(例如,将分析添加到您的应用程序)。

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

  5. 在“助手”窗格中,按照所选 Firebase 产品的其余设置说明进行操作。

  6. 通过 Firebase 助手添加任意数量的其他 Firebase 产品!

而已!请务必查看推荐的后续步骤

不过,如果您在设置时遇到问题,请访问Android 故障排除和常见问题解答



可用库

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

请注意,使用Firebase Android BoM时,您在build.gradle中声明 Firebase 库依赖项时无需指定各个库版本。

Java

服务或产品摇篮依赖最新的
版本
添加分析?
Firebase Android 物料清单
(材料清单)
com.google.firebase:firebase-bom

最新的 Firebase BoM 版本包含每个 Firebase Android 库的最新版本。要了解哪些库版本映射到特定的 BoM 版本,请查看该 BoM 版本的发行说明。

31.1.0
AdMob com.google.android.gms:play-services-ads 21.3.0
分析com.google.firebase:firebase 分析21.2.0
App Check 自定义提供商com.google.firebase:firebase-appcheck 16.1.0
App Check 调试提供程序com.google.firebase:firebase-appcheck-debug 16.1.0
App Check Play 完整性提供商com.google.firebase:firebase-appcheck-playintegrity 16.1.0
App Check SafetyNet 提供商com.google.firebase:firebase-appcheck-safetynet 16.1.0
应用分发com.google.firebase:firebase-appdistribution 16.0.0-beta05
应用程序分发 API com.google.firebase:firebase-appdistribution-api 16.0.0-beta05
应用分发插件com.google.firebase:firebase-appdistribution-gradle 3.1.1
验证com.google.firebase:firebase-auth 21.1.0
云端 Firestore com.google.firebase:firebase-firestore 24.4.1
Firebase 客户端 SDK 的云函数com.google.firebase:firebase 函数20.2.1
云消息com.google.firebase:firebase 消息23.1.0
云储存com.google.firebase:firebase 存储20.1.0
崩溃分析com.google.firebase:firebase-crashlytics 18.3.2
Crashlytics NDK com.google.firebase:firebase-crashlytics-ndk 18.3.2
Crashlytics 插件com.google.firebase:firebase-crashlytics-gradle 2.9.2
动态特性模块支持com.google.firebase:firebase 动态模块支持16.0.0-beta03
动态链接com.google.firebase:firebase 动态链接21.1.0
应用内消息com.google.firebase:firebase-inappmessaging 20.2.0
(必需的)
应用内消息显示com.google.firebase:firebase-inappmessaging-display 20.2.0
(必需的)
Firebase 安装com.google.firebase:firebase 安装17.1.0
Firebase ML 模型下载器 API com.google.firebase:firebase-ml-modeldownloader 24.1.1
性能监控com.google.firebase:firebase-perf 20.3.0
性能监控插件com.google.firebase:性能插件1.4.2
实时数据库com.google.firebase:firebase 数据库20.1.0
远程配置com.google.firebase:firebase 配置21.2.0
Google Play 服务插件com.google.gms:google 服务4.3.14
弃用的库
应用索引com.google.firebase:firebase-appindexing 20.0.0
Firebase ML 自定义模型 API com.google.firebase:firebase-ml-model-interpreter 22.0.4
Firebase 机器学习视觉 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 边缘 API com.google.firebase:firebase-ml-vision-automl 18.0.6
Firebase ML:自然语言 API com.google.firebase:firebase-ml-自然语言22.0.1
Firebase ML:语言识别模型com.google.firebase:firebase-ml-自然语言-语言-id-模型20.0.8
Firebase ML:翻译模型com.google.firebase:firebase-ml-自然语言翻译模型20.0.9
Firebase ML:智能回复模型com.google.firebase:firebase-ml-自然语言-智能回复模型20.0.8

Kotlin+KTX

服务或产品摇篮依赖最新的
版本
添加分析?
Firebase Android 物料清单
(材料清单)
com.google.firebase:firebase-bom

最新的 Firebase BoM 版本包含每个 Firebase Android 库的最新版本。要了解哪些库版本映射到特定的 BoM 版本,请查看该 BoM 版本的发行说明。

31.1.0
AdMob com.google.android.gms:play-services-ads 21.3.0
分析com.google.firebase:firebase-analytics-ktx 21.2.0
App Check 自定义提供商com.google.firebase:firebase-appcheck-ktx 16.1.0
App Check 调试提供程序com.google.firebase:firebase-appcheck-debug 16.1.0
App Check SafetyNet 提供商com.google.firebase:firebase-appcheck-safetynet 16.1.0
应用程序分发 API com.google.firebase:firebase-appdistribution-api-ktx 16.0.0-beta05
应用分发插件com.google.firebase:firebase-appdistribution-gradle 3.1.1
验证com.google.firebase:firebase-auth-ktx 21.1.0
云端 Firestore com.google.firebase:firebase-firestore-ktx 24.4.1
Firebase 客户端 SDK 的云函数com.google.firebase:firebase-functions-ktx 20.2.1
云消息com.google.firebase:firebase-消息-ktx 23.1.0
云储存com.google.firebase:firebase-storage-ktx 20.1.0
崩溃分析com.google.firebase:firebase-crashlytics-ktx 18.3.2
Crashlytics NDK com.google.firebase:firebase-crashlytics-ndk 18.3.2
Crashlytics 插件com.google.firebase:firebase-crashlytics-gradle 2.9.2
动态特性模块支持com.google.firebase:firebase 动态模块支持16.0.0-beta03
动态链接com.google.firebase:firebase-动态链接-ktx 21.1.0
应用内消息com.google.firebase:firebase-inappmessaging-ktx 20.2.0
(必需的)
应用内消息显示com.google.firebase:firebase-inappmessaging-display-ktx 20.2.0
(必需的)
Firebase 安装com.google.firebase:firebase-安装-ktx 17.1.0
Firebase ML 模型下载器 API com.google.firebase:firebase-ml-modeldownloader-ktx 24.1.1
性能监控com.google.firebase:firebase-perf-ktx 20.3.0
性能监控插件com.google.firebase:性能插件1.4.2
实时数据库com.google.firebase:firebase-数据库-ktx 20.1.0
远程配置com.google.firebase:firebase-config-ktx 21.2.0
Google Play 服务插件com.google.gms:google 服务4.3.14
弃用的库
应用索引com.google.firebase:firebase-appindexing 20.0.0
Firebase ML 自定义模型 API com.google.firebase:firebase-ml-model-interpreter 22.0.4
Firebase 机器学习视觉 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 边缘 API com.google.firebase:firebase-ml-vision-automl 18.0.6
Firebase ML:自然语言 API com.google.firebase:firebase-ml-自然语言22.0.1
Firebase ML:语言识别模型com.google.firebase:firebase-ml-自然语言-语言-id-模型20.0.8
Firebase ML:翻译模型com.google.firebase:firebase-ml-自然语言翻译模型20.0.9
Firebase ML:智能回复模型com.google.firebase:firebase-ml-自然语言-智能回复模型20.0.8



下一步

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

了解 Firebase: