Flutter数据分析事件记录插件analytics_event的使用

Flutter数据分析事件记录插件analytics_event的使用

1:Flutter数据分析事件记录插件analytics_event的使用

标题：Flutter数据分析事件记录插件analytics_event的使用

内容：

• analytics_events generator

  • analytics_event 是一个易于使用的跟踪分析事件的插件，通过类型安全的方法。

• 添加到 pubspec.yaml

  • 检查最新版本：
    • pub.dev/packages/analytics_event
    • pub.dev/packages/analytics_event_gen

  dependencies:
    # ...
    analytics_event: ^1.2.0
  dev_dependencies:
    analytics_event_gen: ^1.2.0
    # 包含 build_runner，仅用于代码生成。
    build_runner: ^2.1.11
  

• 创建 AnalyticsEvents 类

  // analytics.dart
  
  import 'package:analytics_event/analytics_event.dart';
  
  // 这个文件将被生成。
  part 'analytics.g.dart';
  
  class MyAnalyticsBloc {
    MyAnalyticsBloc() {
      // 初始化生成的事件类实现。生成的代码将简单地将方法名转换为 `eventName` 并传递给您的回调方法。您可以对其进行任何操作，例如发送到 Firebase Analytics。
      events.registerTracker((eventName, params) {
        FirebaseAnalytics().logEvent(name: event, parameters: params);
      });
    }
  
    final events = _$AnalyticsEvents();
  }
  
  abstract class AnalyticsEvents implements AnalyticsEventStubs {
    void trackMyUserInteraction({double myProp, String yourProp});
  }
  

• 运行构建生成器

  # 对于 flutter 项目
  flutter pub pub run build_runner build --delete-conflicting-outputs
  
  # 对于 dart 项目
  pub run build_runner build --delete-conflicting-outputs
  

• 配置名称转换

  • 可以重命名参数名称和事件名称：

    [@AnalyticsEventConfig](/user/AnalyticsEventConfig)(
      eventNameCase: Case.snakeCase,
      parameterNameCase: Case.snakeCase,
    )
    abstract class AnalyticsEvents implements AnalyticsEventStubs {
      void trackMyUserInteraction({double myProp, String yourProp});
    }
    

    将生成名为 my_user_interaction 的事件，带有参数 my_prop 和 your_prop。

示例代码

示例代码如下：

import 'package:analytics_event/analytics_event.dart';
import 'package:logging/logging.dart';
import 'package:logging_appenders/logging_appenders.dart';

part 'example.g.dart';

final _logger = Logger('example');

/// 创建一个抽象类，该类实现了 [AnalyticsEventStubs]，
/// 并具有所有您想要跟踪的事件的 stub 方法。
[@AnalyticsEventConfig](/user/AnalyticsEventConfig)(
  eventNameCase: Case.snakeCase,
  parameterNameCase: Case.snakeCase,
)
abstract class Events implements AnalyticsEventStubs {
  /// 将成为 'app_launch'，带有参数 'date' 和 'user_id'
  void trackAppLaunch({required String date, required userId});
  void trackExample(String myRequiredParameter, {String withDefault = 'test'});

  /// 枚举将正确转换
  /// 例如，'action' 将会是 'launch'、'remove' 或 'share'
  void trackItem(ItemAction action, String someParameterName);

  void trackNullableItem(ItemAction? action);
}

enum ItemAction {
  launch,
  remove,
  share,
}

/// 一个负责将事件发送到您的分析服务（例如 Firebase Analytics）的分析服务。
class AnalyticsService {
  AnalyticsService();

  // 实例化生成的 Events 实现。
  late final Events events = _$Events(_trackEvent);

  void _trackEvent(String event, Map<String, Object?> params) {
    // 在这里，您需要将事件发送到您的分析服务。
    _logger.info('We have to track event $event with parameters: $params');
  }

  void dispose() => events.removeTracker(_trackEvent);
}

void main() {
  PrintAppender.setupLogging();

  final myAnalytics = AnalyticsService();

  // 现在您有一个类型安全的方式将事件发送到您的分析服务。
  myAnalytics.events.trackAppLaunch(date: DateTime.now().toString(), userId: 11);

  myAnalytics.dispose();
}