转到控制台

将 Firebase 添加到您的 Flutter 应用

按照本指南将 Firebase 产品添加到 Flutter 应用。

第 1 步:设置环境

  • 为您的特定操作系统安装 Flutter,包括安装以下各项:

    • Flutter SDK
    • 支持库
    • 针对具体平台的软件和 SDK
  • 安装您的首选编辑器或 IDE,例如 Android Studio、IntelliJ、Xcode 或 VS Code。

  • 在您的首选编辑器或 IDE 中打开 Flutter 应用。

    • iOS 开发 - 应用必须适用于 iOS 8 或更高版本。
    • Android 开发 - 应用必须适用于 API 级别 16 (Jelly Bean) 或更高版本。
  • 设置用于运行您应用的设备或模拟器。

    • Android 开发 - 模拟器必须通过 Google Play 使用模拟器图片。
  • 使用您的 Google 帐号登录 Firebase

第 2 步:创建 Firebase 项目

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

第 3 步:配置您的应用以使用 Firebase

您可以配置一款(或多款)应用以与您的 Firebase 项目关联。为此,请在 Firebase 项目中注册针对具体平台的应用 ID。Firebase 会自动为您的应用生成配置文件。

如需查看配置应用方面的详细说明,请按照下面针对具体平台(iOSAndroid)的步骤操作。

在 Flutter 应用的顶层目录中,iosandroid 目录中包含针对具体平台(iOS 和 Android)的配置文件。

配置 iOS 应用

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

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

  2. 将您的应用添加到 Firebase 项目:

    1. iOS 软件包 ID 字段中输入应用的软件包 ID

      • 通过在 XCode 中打开您的应用,然后在顶级 Runner 目录中访问常规标签页,找到此软件包 ID。软件包标识符字段的值是 iOS 软件包 ID(例如 com.yourcompany.yourproject)。
    2. (可选)根据设置工作流的提示输入其他应用信息。

    3. 点击注册应用

  3. 将 Firebase iOS 配置文件添加到您的应用:

    1. 点击下载 GoogleService-Info.plist 以获取 Firebase iOS 配置文件 (GoogleService-Info.plist)。

      您可以随时再次下载 Firebase iOS 配置文件

    2. 将该文件移动到 Flutter 应用的 Runner/Runner 目录中。

  4. 返回 Firebase 控制台设置工作流,点击下一步,然后跳过其余步骤。

  5. 继续添加 FlutterFire 插件

配置 Android 应用

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

  2. 将您的应用添加到 Firebase 项目:

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

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

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

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

    3. 点击注册应用

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

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

      您可以随时再次下载 Firebase Android 配置文件

    2. 接着将配置文件移动到 Flutter 应用的 android/app 目录中。

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

    1. 在根级(项目级)Gradle 文件 (android/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:3.2.1'  // Google Services plugin
        }
      }
      allprojects {
        // ...
      
        repositories {
          // Check that you have following line (if not, add it):
          google()  // Google's Maven repository
          // ...
        }
      }
      
    2. 在您的模块(应用级)Gradle 文件(通常是 android/app/build.gradle)中,将以下代码行添加到文件的底部。

      dependencies {
        // ...
      }
      
      // ...
      
      // Add the following line to the bottom of the file:
      apply plugin: 'com.google.gms.google-services'  // Google Play services Gradle plugin
      
    3. 运行 flutter packages get

      如需详细了解如何管理软件包和插件,请参阅使用软件包

  5. 继续添加 FlutterFire 插件

第 4 步:添加 FlutterFire 插件

Flutter 提供了多种插件,供用户访问针对具体平台的各种服务(如 Firebase API)。插件包括针对具体平台的代码,用于访问各种平台上的服务和 API。

Firebase 可通过多个不同的库访问,每个库对应一种 Firebase 产品(例如数据库、身份验证、分析或存储)。Flutter 提供了一组 Firebase 插件,统称为 FlutterFire

由于 Flutter 是一个多平台 SDK,每个 FlutterFire 插件都同时适用于 iOS 和 Android。因此,如果您向 Flutter 应用添加任何 FlutterFire 插件,则 iOS 版和 Android 版 Firebase 应用都会使用该插件。

请务必参阅 FlutterFire 文档,以查看最新的 FlutterFire 插件列表。

  1. 确保您的应用当前未在模拟器或设备上运行。

  2. 从 Flutter 应用的根目录中,打开 pubspec.yaml 文件。

  3. Firebase Core SDK 添加 FlutterFire 插件。

    dependencies:
      flutter:
        sdk: flutter
      firebase_core: ^0.2.5  # add dependency for Firebase Core
    
  4. 添加其他 FlutterFire 插件以使用具体的 Firebase 产品。

    下面的添加分析部分是一个如何将 FlutterFire 插件添加到您的应用的示例。

  5. 运行您的应用以验证安装。

大功告成!您的 Flutter 应用已注册,并配置为使用 Firebase。

添加分析(可选)

Google Analytics for Firebase 添加到您的 Flutter 应用是可选的,但这是验证 Firebase 与 Flutter 能否正常配合的一种相对简单的方法。此外,Analytics 在开发和调试过程中都非常有用,并有助于跟踪生产应用的表现。

  1. 确保您的应用当前未在模拟器或设备上运行。

  2. pubspec.yaml 文件中,为 Google Analytics for Firebase 添加 FlutterFire 插件

    dependencies:
      flutter:
        sdk: flutter
      firebase_core: ^0.2.5       # This dependency was added during initial configuration.
      firebase_analytics: ^1.0.4  # add dependency for Google Analytics for Firebase
    
  3. 运行 flutter packages get

    如需详细了解如何管理软件包和插件,请参阅使用软件包

Analytics 应用示例

与所有软件包一样,firebase_analytics 插件也带有示例程序

  1. 打开已配置为使用 Firebase 的 Flutter 应用。

  2. 访问应用的 lib 目录,然后删除现有的 main.dart 文件。

  3. 从 Google Analytics for Firebase 示例程序代码库中,将以下两个文件复制并粘贴到应用的 lib 目录中:

    • main.dart
    • tabs_page.dart
  4. 运行您的 Flutter 应用。

  5. Firebase 控制台中,转到您的应用的 Firebase 项目,然后点击左侧导航栏中的分析

    • 点击 Dashboard。如果 Google Analytics 正常运行,则信息中心会在“过去 30 分钟的活跃用户数”面板中显示一名活跃用户(这可能需要一些时间来填充此面板)。

    • 点击 DebugView。启用该功能可查看示例程序所生成的所有事件。

如需详细了解如何设置“分析”,请访问适用于 iOSAndroid 的入门指南。

后续步骤