Flutter数据分析插件cux_analytics_sdk的使用

特性

CUX Analytics SDK 可以与 Flutter（支持 Android 和 iOS）应用程序集成，自动检测用户活动。通过添加几行代码，您可以监控和分析整个应用程序，了解用户如何使用它。此类监控的结果会在 CUX Analytics 仪表板中展示。

开始使用

在使用 CUX Analytics SDK 之前，您首先需要创建一个 CUX 账户：https://app.cux.io

使用方法

Android 需要检查网络权限

以下是一个简单的示例，展示如何初始化并使用 CUX Analytics SDK：

void main() {
  print("CuxSDK: main()");
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    print("CuxSDK: MyApp build()");

    // 初始化 CUX Analytics SDK
    CuxAnalytics.init(
        context, '1428112091.0.46456300.1480349278.583c565e0fc5d');
    return AnalyticsWidget(
      child: MaterialApp(
          title: 'Flutter CUX Demo',
          home: const HomeWidget(),
      navigatorObservers: [
        // 添加导航观察器以跟踪页面导航
        CuxAnalytics.createNavigationObserver(context, this)
      ],
    ),
    );
  }
}

如果需要用户同意收集数据，可以先初始化禁用的 SDK，然后在确认允许收集数据后开始收集：

// 初始化禁用的 SDK
CuxAnalytics.init(context, {token}, needConfirmToStart: true);

// 开始收集数据
CuxAnalytics.resumeCollectingData();

如果您使用的是 go_router，则需要添加 RouterNavigationListener：

@override
Widget build(BuildContext context) {
  return MaterialApp.router(
    routerConfig: _router,
    debugShowCheckedModeBanner: false,
    onNavigationNotification:
    RouterNavigationListener(rootWidget: this).onNavigationNotification,
  );
}

如果您的应用页面不是 MaterialApp 或 Scaffold，为了更好的导航可观察性，建议将屏幕的部件包装在一个具有唯一目的地名称的 DestinationWidget 中：

@override
Widget build(BuildContext context) {
  return DestinationWidget(
      destinationName: "Destination_$name",
      child: Column(...

您还可以对包含敏感信息的部分屏幕进行遮罩处理。最佳实践是不仅遮罩敏感信息，还要遮罩更大的区域，尤其是滚动屏幕：

import 'package:cux_analytics_sdk/masking_widget.dart';

MaskingWidget(
  child: Padding(
  padding: EdgeInsets.all(16.0),
  child: Text('Masked text'),
)),

如果您需要停止收集数据，可以调用以下方法：

CuxAnalytics.stopCollectingData();

如果您初始化了禁用的 SDK 或者已经停止了数据收集，可以通过以下方法恢复数据收集：

CuxAnalytics.resumeCollectingData();