Flutter数据分析与追踪插件fab_analytics的使用

本包将用于快速轻松地在您的应用程序中集成Fab Analytics。

使用步骤

以下是一个完整的示例，展示如何在Flutter应用中使用fab_analytics插件进行数据跟踪。

1. 添加依赖

首先，在pubspec.yaml文件中添加fab_analytics依赖：

dependencies:
  fab_analytics: ^版本号

然后运行flutter pub get以安装依赖。

2. 初始化配置

在应用启动时，初始化fab_analytics插件并设置必要的配置参数。以下是初始化的完整代码示例：

import 'package:fab_analytics/models/config_model.dart';
import 'package:fab_analytics/widgets/screenshot_upload_button.dart';
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'dart:async';

import 'package:flutter/services.dart';
import 'package:fab_analytics/fab_analytics.dart';
import 'package:package_info_plus/package_info_plus.dart';

final GlobalKey appKey = GlobalKey();
final GlobalKey<NavigatorState> navigatorKey = GlobalKey<NavigatorState>();

// 替换为您的实际凭证
const applicationId = "66fa85c0c732fab445166d3f";
const clientId = ""; // 可选
const clientSecret = ""; // 可选
const version = ""; // 可选
Config config = Config(
  applicationId: applicationId,
  clientId: clientId,
  clientSecret: clientSecret,
  version: version,
  packageInfo: null,
  isDebugMode: kDebugMode,
  appKey: appKey,
);

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

3. 配置初始化逻辑

在initState中完成平台状态和fab_analytics的初始化。以下是完整的代码实现：

class _MyAppState extends State<MyApp> {
  String _platformVersion = 'Unknown';
  final _fabAnalyticsPlugin = FabAnalytics();
  String message = "";

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

  // 获取平台版本信息
  Future<void> initPlatformState() async {
    String platformVersion;
    try {
      platformVersion = await _fabAnalyticsPlugin.getPlatformVersion() ?? 'Unknown platform version';
    } on PlatformException {
      platformVersion = 'Failed to get platform version.';
    }

    if (!mounted) return;

    setState(() {
      _platformVersion = platformVersion;
    });
  }

  // 初始化Fab Analytics
  initFabAnalytics() async {
    var packageInfo = await PackageInfo.fromPlatform();

    config!.packageInfo = packageInfo;
    try {
      await _fabAnalyticsPlugin.init(config!); // 初始化插件
    } catch (e) {
      print(e.toString());
    }
  }
}

4. 数据追踪示例

通过调用trace方法记录用户行为。以下是完整的代码示例：

trace() async {
  var response = await _fabAnalyticsPlugin.trace(
    userId: "1234", // 可选
    fromScreen: "Home",
    toScreen: "toScreen",
    action: "trace_btn_clicked", // 可选
    params: {
      "id": "5678",
    }, // 可选
  );
  return response;
}

5. 构建UI界面

在应用的主界面中添加按钮，触发数据追踪操作，并显示结果反馈。

[@override](/user/override)
Widget build(BuildContext context) {
  return AnalyticsMaterialApp(
    appKey: appKey,
    isDebugMode: kDebugMode,
    config: config,
    navigatorKey: navigatorKey,
    materialApp: MaterialApp(
      navigatorKey: navigatorKey,
      home: Scaffold(
        appBar: AppBar(
          title: const Text('FAB Analytics Plugin example app'),
        ),
        body: Container(
          width: double.infinity,
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            crossAxisAlignment: CrossAxisAlignment.center,
            children: [
              Text('Running on: $_platformVersion\n'),
              ElevatedButton(
                onPressed: () async {
                  var response = await trace();
                  if (response.statusCode == 200) {
                    setState(() {
                      message = "Traced successfully! hop on to your dashboard to view";
                    });
                  }
                },
                child: Text('Trace'),
              ),
              message != "" ? Text(message) : SizedBox(),
            ],
          ),
        ),
      ),
    ),
  );
}

完整示例代码

以下是完整的示例代码，包含所有关键部分：

import 'package:fab_analytics/models/config_model.dart';
import 'package:fab_analytics/widgets/screenshot_upload_button.dart';
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'dart:async';

import 'package:flutter/services.dart';
import 'package:fab_analytics/fab_analytics.dart';
import 'package:package_info_plus/package_info_plus.dart';
import 'package:fab_analytics/widgets/analytics_material_app.dart';

final GlobalKey appKey = GlobalKey();
final GlobalKey<NavigatorState> navigatorKey = GlobalKey<NavigatorState>();

const applicationId = "66fa85c0c732fab445166d3f";
const clientId = ""; // 可选
const clientSecret = ""; // 可选
const version = ""; // 可选
Config config = Config(
  applicationId: applicationId,
  clientId: clientId,
  clientSecret: clientSecret,
  version: version,
  packageInfo: null,
  isDebugMode: kDebugMode,
  appKey: appKey,
);

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

class MyApp extends StatefulWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _platformVersion = 'Unknown';
  final _fabAnalyticsPlugin = FabAnalytics();
  String message = "";

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

  Future<void> initPlatformState() async {
    String platformVersion;
    try {
      platformVersion = await _fabAnalyticsPlugin.getPlatformVersion() ?? 'Unknown platform version';
    } on PlatformException {
      platformVersion = 'Failed to get platform version.';
    }

    if (!mounted) return;

    setState(() {
      _platformVersion = platformVersion;
    });
  }

  initFabAnalytics() async {
    var packageInfo = await PackageInfo.fromPlatform();

    config!.packageInfo = packageInfo;
    try {
      await _fabAnalyticsPlugin.init(config!);
    } catch (e) {
      print(e.toString());
    }
  }

  trace() async {
    var response = await _fabAnalyticsPlugin.trace(
      userId: "1234", // 可选
      fromScreen: "Home",
      toScreen: "toScreen",
      action: "trace_btn_clicked", // 可选
      params: {
        "id": "5678",
      }, // 可选
    );
    return response;
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return AnalyticsMaterialApp(
      appKey: appKey,
      isDebugMode: kDebugMode,
      config: config,
      navigatorKey: navigatorKey,
      materialApp: MaterialApp(
        navigatorKey: navigatorKey,
        home: Scaffold(
          appBar: AppBar(
            title: const Text('FAB Analytics Plugin example app'),
          ),
          body: Container(
            width: double.infinity,
            child: Column(
              mainAxisAlignment: MainAxisAlignment.center,
              crossAxisAlignment: CrossAxisAlignment.center,
              children: [
                Text('Running on: $_platformVersion\n'),
                ElevatedButton(
                  onPressed: () async {
                    var response = await trace();
                    if (response.statusCode == 200) {
                      setState(() {
                        message = "Traced successfully! hop on to your dashboard to view";
                      });
                    }
                  },
                  child: Text('Trace'),
                ),
                message != "" ? Text(message) : SizedBox(),
              ],
            ),
          ),
        ),
      ),
    );
  }
}