使用文档

Flutter SDK

AntDock Flutter SDK 为 Flutter 应用提供完整的数据追踪能力,支持 iOS 和 Android。

SDK 获取方式

使用控制台提供的安装地址或下载包;本文不表示 SDK 已在公共仓库开源发布。

安装

将 SDK 源码文件复制到您的 Flutter 项目中:

  1. 下载 sdk/flutter/lib/ 目录下的所有文件
  2. 复制到项目的 lib/antdock/ 目录
  3. 在 pubspec.yaml 中添加依赖:
dependencies:
  shared_preferences: ^2.2.0
  http: ^1.1.0

然后运行:

flutter pub get

初始化

import 'package:flutter/material.dart';
import 'antdock/tracker.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  await AntDockTracker.init(
    appId: 'your-app-id',
    endpoint: 'https://你的域名',
    options: AntDockOptions(
      batchSize: 10,
      flushIntervalMs: 5000,
      debug: false,
    ),
  );

  runApp(MyApp());
}

API 参考

trackPageView(path, {properties})

追踪页面访问。

AntDockTracker.trackPageView('/home');

AntDockTracker.trackPageView(
  '/product/detail',
  properties: {'product_id': '12345'},
);

trackEvent(name, {properties})

追踪自定义事件。

AntDockTracker.trackEvent('button_click');

AntDockTracker.trackEvent(
  'purchase',
  properties: {
    'order_id': 'ORD-12345',
    'amount': 99.99,
  },
);

identify(userId, {traits})

识别用户身份。

await AntDockTracker.identify(
  'user_123',
  traits: {
    'email': 'user@example.com',
    'name': '张三',
  },
);

flush()

立即发送队列中的数据。

reset()

重置用户身份。

路由追踪

使用 RouteObserver

import 'antdock/tracker.dart';

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      navigatorObservers: [AntDockRouteObserver()],
      home: HomeScreen(),
    );
  }
}

配置选项

AntDockOptions(
  batchSize: 10,           // 批量大小
  flushIntervalMs: 5000,   // 刷新间隔 (ms)
  debug: false,            // 调试模式
)

要求

  • Flutter 3.0+
  • Dart 2.17+
  • iOS 12.0+
  • Android 5.0 (API 21)+