Google 致力于为黑人社区推动种族平等。查看具体举措

将 Firebase 添加到您的 Android 项目

前提条件

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

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

    • 目标 API 级别为 16 (Jelly Bean) 或更高
    • 使用 Gradle 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 项目以了解详情。

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

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

  1. 转到 Firebase 控制台

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

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

  4. (可选)输入其他应用信息:应用别名调试签名证书 SHA-1

  5. 点击注册应用

第 3 步:添加 Firebase 配置文件

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

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

    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.5'  // 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:26.5.0')
    
      // 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:26.5.0')
    
      // 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:26.5.0')
    
      // 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:26.5.0')
    
      // 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. 同步您的应用以确保所有依赖项都具有所需的版本。

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



选项 2:使用 Firebase Assistant 添加 Firebase

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

  1. 在 Android Studio 中打开您的 Android 项目并访问 Firebase Assistant:

    1. 依次转到 File > Check for updates,确保您使用的是最新版 Android Studio 和 Firebase Assistant。

    2. 转到 Tools > Firebase,打开 Assistant 窗格

  2. 选择要添加到您的应用的 Firebase 产品。展开该产品部分,然后点击教程链接(例如 Analytics > Log an Analytics event)。

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

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

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

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

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

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



可用的库

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

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

Java

服务或产品 Gradle 依赖项 最新
版本
添加 Analytics?
Firebase Android BoM
(物料清单)
com.google.firebase:firebase-bom

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

26.5.0
AdMob com.google.android.gms:play-services-ads 19.7.0
Analytics com.google.firebase:firebase-analytics 18.0.2
App Indexing com.google.firebase:firebase-appindexing 19.2.0
Authentication com.google.firebase:firebase-auth 20.0.2
Cloud Firestore com.google.firebase:firebase-firestore 22.1.0
Cloud Functions for Firebase 客户端 SDK com.google.firebase:firebase-functions 19.2.0
Cloud Messaging com.google.firebase:firebase-messaging 21.0.1
Cloud Storage com.google.firebase:firebase-storage 19.2.1
Crashlytics com.google.firebase:firebase-crashlytics 17.3.1
Dynamic Links com.google.firebase:firebase-dynamic-links 19.1.1
Firebase ML Vision API com.google.firebase:firebase-ml-vision 24.1.0
Firebase ML Custom Model API com.google.firebase:firebase-ml-model-interpreter 22.0.4
In-App Messaging com.google.firebase:firebase-inappmessaging 19.1.4
(需要)
In-App Messaging Display com.google.firebase:firebase-inappmessaging-display 19.1.4
(需要)
Performance Monitoring com.google.firebase:firebase-perf 19.1.1
Realtime Database com.google.firebase:firebase-database 19.6.0
Remote Config com.google.firebase:firebase-config 20.0.3
Google Play 服务插件 com.google.gms:google-services 4.3.5
弃用的库
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

Kotlin+KTX

服务或产品 Gradle 依赖项 最新
版本
添加 Analytics?
Firebase Android BoM
(物料清单)
com.google.firebase:firebase-bom

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

26.5.0
AdMob com.google.android.gms:play-services-ads 19.7.0
Analytics com.google.firebase:firebase-analytics-ktx 18.0.2
App Indexing com.google.firebase:firebase-appindexing 19.2.0
Authentication com.google.firebase:firebase-auth-ktx 20.0.2
Cloud Firestore com.google.firebase:firebase-firestore-ktx 22.1.0
Cloud Functions for Firebase 客户端 SDK com.google.firebase:firebase-functions-ktx 19.2.0
Cloud Messaging com.google.firebase:firebase-messaging-ktx 21.0.1
Cloud Storage com.google.firebase:firebase-storage-ktx 19.2.1
Crashlytics com.google.firebase:firebase-crashlytics-ktx 17.3.1
Dynamic Links com.google.firebase:firebase-dynamic-links-ktx 19.1.1
Firebase ML Vision API com.google.firebase:firebase-ml-vision 24.1.0
Firebase ML Custom Model API com.google.firebase:firebase-ml-model-interpreter 22.0.4
In-App Messaging com.google.firebase:firebase-inappmessaging-ktx 19.1.4
(需要)
In-App Messaging Display com.google.firebase:firebase-inappmessaging-display-ktx 19.1.4
(需要)
Performance Monitoring com.google.firebase:firebase-perf-ktx 19.1.1
Realtime Database com.google.firebase:firebase-database-ktx 19.6.0
Remote Config com.google.firebase:firebase-config-ktx 20.0.3
Google Play 服务插件 com.google.gms:google-services 4.3.5
弃用的库
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: