Flutter Firebase分析集成插件djangoflow_firebase_analytics的使用

djangoflow_firebase_analytics 是一个基于 firebase_analytics 和 analytics 包构建的 Flutter 库。它提供了一种简单且有组织的方式来为您的 Flutter 应用程序实现 Firebase 分析功能。

特性

• 事件记录：可以记录带有参数和值汇总的 Firebase 应用事件。
• 用户属性移除：可以移除用户 ID 和所有用户数据。
• 用户属性更新：可以更新用户的属性，例如电子邮件、名字、姓氏和用户 ID。

注意事项

请确保遵循 firebase_analytics 的指南 查看文档。

使用方法

1. 添加依赖

在 pubspec.yaml 文件中添加以下依赖项：

dependencies:
  djangoflow_firebase_analytics: <最新版本>
  djangoflow_analytics: <最新版本>
  firebase_analytics: <最新版本>

然后运行以下命令以安装它们：

flutter pub get

2. 导入库并初始化

在您的代码中导入库并初始化 djangoflow_firebase_analytics：

import 'package:djangoflow_firebase_analytics/djangoflow_firebase_analytics.dart';

接下来，您需要初始化库，并将以下三个类添加到 DjangoflowAnalytics 实例中：

• FirebaseAnalyticEventSender
• FirebaseUserPropertyUpdater
• FirebaseUserPropertyRemover

这些类来自 djangoflow_analytics 包。

3. 初始化和添加操作执行器

以下是完整的初始化和添加操作执行器的示例代码：

// 创建 FirebaseAnalyticEventSender 实例
final firebaseAnalyticsEventSender = FirebaseAnalyticEventSender(firebaseAnalytics);

// 创建 FirebaseUserPropertyUpdater 实例
final firebaseUserPropertyUpdater = FirebaseUserPropertyUpdater(firebaseAnalytics);

// 创建 FirebaseUserPropertyRemover 实例
final firebaseUserPropertyRemover = FirebaseUserPropertyRemover(firebaseAnalytics);

// 初始化 DjangoflowAnalytics
DjangoflowAnalytics.instance.init();

// 将操作执行器添加到 DjangoflowAnalytics 实例中
DjangoflowAnalytics.instance.addAllActionPerformers([
  firebaseAnalyticsEventSender,
  firebaseUserPropertyUpdater,
  firebaseUserPropertyRemover,
]);

4. 发送事件到 Firebase Analytics

您可以使用 DjangoflowAnalytics.instance.performAction 方法来发送数据到 Firebase Analytics。以下是一个发送自定义事件的示例：

// 发送自定义事件
DjangoflowAnalytics.instance.performAction(
  FirebaseAnalyticEventSender(firebaseAnalytics).logEvent(
    name: 'custom_event',
    parameters: {'key': 'value'},
    valueToSum: 100,
  ),
);

5. 更新用户属性

您可以更新用户的属性，例如电子邮件或用户 ID。以下是一个更新用户属性的示例：

// 更新用户属性
DjangoflowAnalytics.instance.performAction(
  FirebaseUserPropertyUpdater(firebaseAnalytics).updateUserProperty(
    key: 'email',
    value: 'example@example.com',
  ),
);

6. 移除用户数据

如果您需要移除用户 ID 或所有用户数据，可以使用以下代码：

// 移除用户 ID
DjangoflowAnalytics.instance.performAction(
  FirebaseUserPropertyRemover(firebaseAnalytics).removeUserId(),
);

// 移除所有用户数据
DjangoflowAnalytics.instance.performAction(
  FirebaseUserPropertyRemover(firebaseAnalytics).resetUserProperties(),
);

完整示例代码

以下是一个完整的示例代码，展示了如何集成和使用 djangoflow_firebase_analytics：

import 'package:flutter/material.dart';
import 'package:firebase_analytics/firebase_analytics.dart';
import 'package:djangoflow_firebase_analytics/djangoflow_firebase_analytics.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: HomeScreen(),
    );
  }
}

class HomeScreen extends StatefulWidget {
  [@override](/user/override)
  _HomeScreenState createState() => _HomeScreenState();
}

class _HomeScreenState extends State<HomeScreen> {
  final FirebaseAnalytics firebaseAnalytics = FirebaseAnalytics.instance;

  [@override](/user/override)
  void initState() {
    super.initState();

    // 初始化 DjangoflowAnalytics
    DjangoflowAnalytics.instance.init();

    // 创建操作执行器
    final firebaseAnalyticsEventSender = FirebaseAnalyticEventSender(firebaseAnalytics);
    final firebaseUserPropertyUpdater = FirebaseUserPropertyUpdater(firebaseAnalytics);
    final firebaseUserPropertyRemover = FirebaseUserPropertyRemover(firebaseAnalytics);

    // 添加操作执行器
    DjangoflowAnalytics.instance.addAllActionPerformers([
      firebaseAnalyticsEventSender,
      firebaseUserPropertyUpdater,
      firebaseUserPropertyRemover,
    ]);
  }

  void logCustomEvent() {
    // 发送自定义事件
    DjangoflowAnalytics.instance.performAction(
      FirebaseAnalyticEventSender(firebaseAnalytics).logEvent(
        name: 'custom_event',
        parameters: {'key': 'value'},
        valueToSum: 100,
      ),
    );
  }

  void updateUserProperty() {
    // 更新用户属性
    DjangoflowAnalytics.instance.performAction(
      FirebaseUserPropertyUpdater(firebaseAnalytics).updateUserProperty(
        key: 'email',
        value: 'example@example.com',
      ),
    );
  }

  void removeUserId() {
    // 移除用户 ID
    DjangoflowAnalytics.instance.performAction(
      FirebaseUserPropertyRemover(firebaseAnalytics).removeUserId(),
    );
  }

  void resetUserProperties() {
    // 移除所有用户数据
    DjangoflowAnalytics.instance.performAction(
      FirebaseUserPropertyRemover(firebaseAnalytics).resetUserProperties(),
    );
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('djangoflow_firebase_analytics 示例'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            ElevatedButton(
              onPressed: logCustomEvent,
              child: Text('记录自定义事件'),
            ),
            SizedBox(height: 16),
            ElevatedButton(
              onPressed: updateUserProperty,
              child: Text('更新用户属性'),
            ),
            SizedBox(height: 16),
            ElevatedButton(
              onPressed: removeUserId,
              child: Text('移除用户 ID'),
            ),
            SizedBox(height: 16),
            ElevatedButton(
              onPressed: resetUserProperties,
              child: Text('重置用户属性'),
            ),
          ],
        ),
      ),
    );
  }
}