Flutter数据分析与监控插件skyanalytics的使用

Flutter数据分析与监控插件skyanalytics的使用

安装

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

dependencies:
  skyanalytics: ^0.1.0

然后运行flutter pub get来获取这个包。

使用

首先，导入skyanalytics包并创建一个SkyAnalytics实例：

import 'package:skyanalytics/skyanalytics_flutter.dart';

// 创建一个SkyAnalytics实例
const skyAnalytics = SkyAnalytics(
    sourceKey: 'sourceKey', // 你的数据源密钥
    host: 'https://example.com', // 数据上报的服务器地址
    enabled: true, // 默认启用
    showLogs: false, // 默认不显示日志
);

接下来，你可以使用skyAnalytics对象来跟踪事件、页面导航、元数据以及错误报告等信息：

// 跟踪一个名为'create_element'的事件
skyAnalytics.event(name: 'create_element');

// 记录一个页面导航到'home'屏幕
skyAnalytics.navigate(screenName: 'home');

// 添加一些元数据
skyAnalytics.metadata({
    'key1': 'value1',
    'key2': 'value2',
});

// 提交一个错误报告
skyAnalytics.bugReport(
    description: '这是一个错误报告',
    name: 'Carlos',
    contact: 'email@gmail.com',
);

NavigatorObserver

为了自动跟踪页面导航，可以使用SkyAnalyticsNavigatorObserver：

// 创建一个SkyAnalyticsNavigatorObserver实例
final navigatorObserver = SkyAnalyticsNavigatorObserver(skyAnalytics: skyAnalytics);

// 在MaterialApp中使用该观察者
MaterialApp(
    navigatorObservers: [navigatorObserver], // 将观察者添加到导航器观察者列表中
    home: HomeScreen(), // 主屏幕
);

重要提示：SkyAnalyticsNavigatorObserver需要RouteSettings被设置才能正确跟踪屏幕名称。如果你使用的是MaterialApp组件，那么RouteSettings会自动设置。如果你使用的是自定义Navigator，则需要手动设置RouteSettings。

示例代码

以下是一个完整的示例代码，展示了如何使用SkyAnalytics插件：

import 'package:flutter/material.dart';
import 'package:skyanalytics/skyanalytics_flutter.dart';

void main(List<String> args) {
  // 初始化SkyAnalytics实例
  const skyAnalytics = SkyAnalytics(
    sourceKey: 'sourceKey',
    host: 'https://example.com',
  );

  // 跟踪一个事件
  skyAnalytics.event(name: 'create_element');

  // 记录一个页面导航
  skyAnalytics.navigate(screenName: 'home');

  // 添加一些元数据
  skyAnalytics.metadata({
    'key1': 'value1',
    'key2': 'value2',
  });

  // 提交一个错误报告
  skyAnalytics.bugReport(
    description: '这是一个错误报告',
    name: 'Carlos',
    contact: 'email@gmail.com',
  );

  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    final navigatorObserver = SkyAnalyticsNavigatorObserver(skyAnalytics: skyAnalytics);

    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'Flutter Demo Home Page'),
      navigatorObservers: [navigatorObserver], // 添加导航器观察者
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headline4,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: Icon(Icons.add),
      ),
    );
  }
}