Flutter 数据分析插件 sensors_analytics_flutter_plugin 的使用

神策简介

神策数据（Sensors Data）是一家专业的大数据分析服务公司，致力于帮助客户实现数据驱动。业务覆盖互联网、金融、零售快消等多个行业，并提供深度用户行为分析平台及专业的咨询服务和行业解决方案。

SDK 简介

神策的 sensors_analytics_flutter_plugin 插件封装了 iOS、Android 和 Web SDK 常用 API，可用于完成埋点统计上报。

使用方式

添加依赖

在 Flutter 项目的 pubspec.yaml 文件中添加 sensors_analytics_flutter_plugin 依赖：

dependencies:
  # 添加神策 flutter plugin 
  sensors_analytics_flutter_plugin: ^3.0.1

执行以下命令安装插件：

flutter pub get

集成文档

请参考神策官网提供的 Flutter 插件集成文档。

示例代码

下面是一个完整的示例 Demo，展示了如何初始化 SDK 并进行基本的事件跟踪。

import 'dart:async';
import 'package:flutter/material.dart';
import 'package:sensors_analytics_flutter_plugin/sensors_analytics_flutter_plugin.dart';

void main() => runApp(MyApp());

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

class _MyAppState extends State<MyApp> {
  String? _distinctId = '';

  [@override](/user/override)
  void initState() {
    // 初始化 SDK
    startSensorsAnalyticsSDK();
    initPlatformState();

    super.initState();
  }

  void startSensorsAnalyticsSDK() {
    SensorsAnalyticsFlutterPlugin.init(
        serverUrl: "https://sdkdebugtest.datasink.sensorsdata.cn/sa?project=default&token=cfb8b60e42e0ae9b",
        autoTrackTypes: <SAAutoTrackType>{
          SAAutoTrackType.APP_START,
          SAAutoTrackType.APP_VIEW_SCREEN,
          SAAutoTrackType.APP_CLICK,
          SAAutoTrackType.APP_END
        },
        networkTypes: <SANetworkType>{
          SANetworkType.TYPE_2G,
          SANetworkType.TYPE_3G,
          SANetworkType.TYPE_4G,
          SANetworkType.TYPE_WIFI,
          SANetworkType.TYPE_5G
        },
        flushInterval: 30000,
        flushBulkSize: 150,
        enableLog: true,
        javaScriptBridge: true,
        encrypt: true,
        android: AndroidConfig(maxCacheSize: 48 * 1024 * 1024, jellybean: true, subProcessFlush: true),
        ios: IOSConfig(maxCacheSize: 10000),
        web: WebConfig(
            publicKey: '040db1c4d70c229425134d588cf9d5126815ceda1cb2f72e63f3f29e8974c28d10929d341ee2a21fba224dea13ee2d8b5f98b4bbbd6c887d0bba0a20a190c95c57',
            pkv: 4),
        globalProperties: {'aaa': 'aaa-value', 'bbb': 'bbb-value'},
        autoTrackConfig: SAAutoTrackConfig(pageConfigs: [
          SAAutoTrackPageConfig<Home>(title: '首页', screenName: '首页', properties: {'page': 'home'}),
        ]));
  }

  Future<void> initPlatformState() async {
    String? distinctId = "";

    try {
      distinctId = await SensorsAnalyticsFlutterPlugin.getDistinctId;
    } on PlatformException {
      distinctId = 'Failed to get distinctId.';
    }

    if (!mounted) return;

    setState(() {
      _distinctId = distinctId;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      navigatorObservers: SANavigatorObserver.wrap([]),
      initialRoute: '/',
      routes: {
        '/': (context) => Home(),
        '/page2': (context) => Page2(),
        '/page3': (context) => Page3(),
      },
    );
  }
}

// 示例页面
class Home extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text('首页')),
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            Navigator.pushNamed(context, '/page2');
          },
          child: Text('Go to Page 2'),
        ),
      ),
    );
  }
}

class Page2 extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text('页面2')),
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            Navigator.pushNamed(context, '/page3');
          },
          child: Text('Go to Page 3'),
        ),
      ),
    );
  }
}

class Page3 extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text('页面3')),
      body: Center(
        child: Text('这是页面3'),
      ),
    );
  }
}