将 Firebase 添加到您的 Flutter 应用


前提条件

如果您还没有 Flutter 应用,则可以使用您偏好的编辑器或 IDE 按照使用入门:体验服务创建一个新的 Flutter 应用。

第 1 步:安装所需的命令行工具

  1. 如果您尚未安装 Firebase CLI,请先安装。

  2. 运行以下命令,使用您的 Google 账号登录 Firebase:

    firebase login
    
  3. 从任何目录运行以下命令来安装 FlutterFire CLI:

    dart pub global activate flutterfire_cli
    

第 2 步:将应用配置为使用 Firebase

使用 FlutterFire CLI 将您的 Flutter 应用配置为连接到 Firebase。

从 Flutter 项目目录运行以下命令,启动应用配置工作流:

flutterfire configure


第 3 步:在您的应用中初始化 Firebase

  1. 在您的 Flutter 项目目录中,运行以下命令以安装核心插件:

    flutter pub add firebase_core
    
  2. 在 Flutter 项目目录中运行以下命令,以确保您的 Flutter 应用的 Firebase 配置保持最新状态:

    flutterfire configure
    
  3. lib/main.dart 文件中,导入您之前生成的 Firebase 核心插件和配置文件:

    import 'package:firebase_core/firebase_core.dart';
    import 'firebase_options.dart';
    
  4. 同样在 lib/main.dart 文件中,使用配置文件导出的 DefaultFirebaseOptions 对象初始化 Firebase:

    await Firebase.initializeApp(
      options: DefaultFirebaseOptions.currentPlatform,
    );
    
  5. 重新构建 Flutter 应用:

    flutter run
    

如果您更愿意使用演示项目,可以启动 Firebase 模拟器,然后在 lib/main.dart 文件中使用 demoProjectId(应以 demo- 开头)初始化 Firebase:

  await Firebase.initializeApp(
    demoProjectId: "demo-project-id",
  );

第 4 步:添加 Firebase 插件

您可以通过各种 Firebase Flutter 插件(每个插件对应一种 Firebase 产品,例如 Cloud FirestoreAuthenticationAnalytics 等)在 Flutter 应用中访问 Firebase。

由于 Flutter 是一个多平台框架,因此每个 Firebase 插件都同时适用于 Apple、Android 和 Web 平台。也就是说,如果您将任何 Firebase 插件添加到 Flutter 应用,则 Apple 版、Android 版和 Web 版应用都会使用该插件。

添加 Firebase Flutter 插件的方法如下:

  1. 在您的 Flutter 项目目录中,运行以下命令:

    flutter pub add PLUGIN_NAME
  2. 在您的 Flutter 项目目录中,运行以下命令:

    flutterfire configure
    

    运行此命令可确保您的 Flutter 应用的 Firebase 配置保持最新状态,并且对于 Android 版 CrashlyticsPerformance Monitoring,会将所需的 Gradle 插件添加到您的应用中。

  3. 完成后,重新构建您的 Flutter 项目:

    flutter run
    

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

可用的插件

产品 插件名称 iOS Android Web 其他 Apple 平台
(macOS 等)
Windows
Analytics firebase_analytics
测试版
App Check firebase_app_check
测试版
Authentication firebase_auth
测试版 测试版
Cloud Firestore cloud_firestore
测试版 测试版
Cloud Functions cloud_functions
测试版
Cloud Messaging firebase_messaging
测试版
Cloud Storage firebase_storage
测试版 测试版
Crashlytics firebase_crashlytics
测试版
Dynamic Links firebase_dynamic_links
In-App Messaging firebase_in_app_messaging
Firebase 安装 firebase_app_installations
测试版
机器学习模型下载程序 firebase_ml_model_downloader
测试版
Performance Monitoring firebase_performance
Realtime Database firebase_database
测试版
Remote Config firebase_remote_config
测试版
Vertex AI in Firebase firebase_vertexai
测试版

通过 Analytics 试用示例应用

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

  1. 打开已配置为使用 Firebase 的 Flutter 应用(请参阅本页面中的说明)。

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

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

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

  5. Firebase 控制台中,前往您的应用的 Firebase 项目,然后点击左侧导航栏中的 Analytics

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

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

如需详细了解如何设置 Analytics,请访问 iOS+AndroidWeb 平台的入门指南。

后续步骤