转到控制台

将 Firebase 添加到您的 Android 项目

前提条件

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

  • 确保您的 Android 应用符合以下条件:

    • 目标为 API 级别 16 (Jelly Bean) 或更高版本
    • 使用 Gradle 4.1 或更高版本
  • 设置可用于运行应用的设备或模拟器。

    • 模拟器必须使用具有 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 项目

您必须先创建一个 Firebase 项目,并将其关联到您的 Android 应用,然后才能将 Firebase 添加到您的 Android 应用。访问了解 Firebase 项目以详细了解 Firebase 项目。

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

拥有 Firebase 项目后,您就可以向其中添加 Android 应用了。

访问了解 Firebase 项目以详细了解将应用添加到 Firebase 项目的最佳做法和注意事项,包括如何处理多个应用版本。

  1. Firebase 控制台的项目概览页面的中心位置,点击 Android 图标以启动设置工作流。

    如果您已向 Firebase 项目添加了应用,请点击添加应用以显示平台选项。

  2. Android 软件包名称字段中输入您的应用 ID

    • “应用 ID”有时被称为“软件包名称”

    • 在您的模块(应用级)Gradle 文件(通常是 app/build.gradle)中找到此应用 ID(如 ID:com.yourcompany.yourproject)。

  3. (可选)根据设置工作流的提示输入其他应用信息。

    别名是方便内部使用的标识符,只有您能在 Firebase 控制台中看到。

  4. 点击注册应用

第 3 步:添加 Firebase 配置文件

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

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

    2. 接着将配置文件移动到应用的模块(应用级)目录中。

  2. 要在 Android 应用中启用 Firebase 产品,请将 Google 服务插件添加到 Gradle 文件中。

    1. 在根级(项目级)Gradle 文件 (build.gradle) 中添加相应规则,以包含 Google 服务插件。此外,请确认您是否拥有 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.2.0'  // 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)中,在文件末尾添加一行内容。

      apply plugin: 'com.android.application'
      
      android {
        // ...
      }
      
      // Add the following line to the bottom of the file:
      apply plugin: 'com.google.gms.google-services'  // Google Play services Gradle plugin
      

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

您可以将任何受支持的 Firebase 产品添加到 Android 应用中。我们建议您先从添加核心 Firebase SDK (com.google.firebase:firebase-core) 开始,该产品提供有 Google Analytics for Firebase 功能。

  1. 在您的模块(应用级)Gradle 文件(通常是 app/build.gradle)中,添加核心 Firebase SDK 的依赖项:

    dependencies {
     // ...
     implementation 'com.google.firebase:firebase-core:17.0.0'
    
     // Getting a "Could not find" error? Make sure that you've added
     // Google's Maven repository to your root-level build.gradle file
    }
    
  2. (可选)添加您要使用的其他 Firebase 库的依赖项。

    一些适用于 Android 的 Firebase SDK 提供了备选 Kotlin 扩展程序库

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

  4. 运行您的应用,向 Firebase 发送您已成功集成 Firebase 的验证信息。

    您的设备日志将显示说明初始化已完成的 Firebase 验证信息。如果您是在具有网络访问权限的模拟器上运行应用,则 Firebase 控制台会通知您应用连接已完成。

大功告成!您可以跳至后续步骤了。

选项 2:使用 Firebase Assistant 添加 Firebase

Firebase Assistant 可在 Firebase 项目中注册您的应用,并将必要的 Firebase 文件和代码添加到您的 Android 项目中 - 所有这些都在 Android Studio 中完成。

请注意,建议的做法是使用 Firebase 控制台设置工作流将应用关联至 Firebase。

  1. 在 Android Studio 中打开您的 Android 项目。

  2. 依次选择 Tools > Firebase 以打开 Assistant 窗口。

  3. 展开所列 Firebase 产品之一(例如 Analytics),然后点击所提供的教程链接(例如“Log an Analytics event”)。

  4. 点击 Connect to Firebase 以在已有或新的 Firebase 项目中注册您的应用,并自动向您的 Android 项目添加必要的文件和代码。

  5. 检查您的插件和库版本是否最新:

    • 在根级(项目级)Gradle 文件 (build.gradle) 中,检查您的 Google 服务插件版本是否为最新版本 (com.google.gms:google-services:4.2.0)。

    • 在您的模块(应用级)Gradle 文件(通常是 app/build.gradle)中,检查您的 Firebase Android 库版本是否为最新版本。

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

  7. 在 Firebase 控制台项目设置配置您的 Analytics 数据共享设置
    要使用 Firebase 预测或 Firebase A/B 测试等 Firebase 产品,必须允许与其他 Firebase 产品共享 Analytics 数据。

  8. 运行您的应用,向 Firebase 发送您已成功集成 Firebase 的验证信息。

    您的设备日志将显示说明初始化已完成的 Firebase 验证信息。如果您是在具有网络访问权限的模拟器上运行应用,则 Firebase 控制台会通知您应用连接已完成。

可用的库

下面列出了各 Firebase 产品可使用的 Android 库

一些适用于 Android 的 Firebase SDK 提供了备选 Kotlin 扩展程序库

服务或产品 Gradle 依赖项行
Google Play 服务插件 com.google.gms:google-services:4.2.0
AdMob com.google.firebase:firebase-ads:18.0.0
Analytics com.google.firebase:firebase-core:17.0.0
App Indexing com.google.firebase:firebase-appindexing:19.0.0
身份验证 com.google.firebase:firebase-auth:18.0.0
Cloud Firestore com.google.firebase:firebase-firestore:20.0.0
Cloud Functions for Firebase 客户端 SDK com.google.firebase:firebase-functions:18.0.0
云消息传递 com.google.firebase:firebase-messaging:19.0.0
Cloud Storage com.google.firebase:firebase-storage:18.0.0
Crashlytics com.crashlytics.sdk.android:crashlytics:2.10.1
动态链接 com.google.firebase:firebase-dynamic-links:18.0.0
应用内消息 com.google.firebase:firebase-inappmessaging:18.0.0
应用内消息显示 com.google.firebase:firebase-inappmessaging-display:18.0.0
机器学习套件:Vision API com.google.firebase:firebase-ml-vision:21.0.0
机器学习套件:图片标签模型 com.google.firebase:firebase-ml-vision-image-label-model:18.0.0
机器学习套件:人脸检测模型 com.google.firebase:firebase-ml-vision-face-model:18.0.0
机器学习套件:对象检测和跟踪模型 com.google.firebase:firebase-ml-vision-object-detection-model:17.0.0
机器学习套件:Natural Language API com.google.firebase:firebase-ml-natural-language:20.0.0
机器学习套件:语言识别模型 com.google.firebase:firebase-ml-natural-language-language-id-model:20.0.0
机器学习套件:翻译模型 com.google.firebase:firebase-ml-natural-language-translate-model:20.0.0
机器学习套件:智能回复模型 com.google.firebase:firebase-ml-natural-language-smart-reply-model:20.0.0
机器学习套件:自定义模型 API com.google.firebase:firebase-ml-model-interpreter:20.0.0
机器学习套件:AutoML Vision Edge API com.google.firebase:firebase-ml-vision-automl:17.0.0
性能监控 com.google.firebase:firebase-perf:18.0.0
实时数据库 com.google.firebase:firebase-database:18.0.0
远程配置 com.google.firebase:firebase-config:18.0.0

使用 Firebase 物料清单 (BoM) 进行库版本控制(实验性功能)

为便于进行库版本管理,请考虑导入 Firebase 物料清单 (BoM)。

后续步骤

了解 Firebase:

为您的应用添加 Firebase 功能: