Flutter数据分析插件confidence_flutter_sdk的使用

Flutter实现的Confidence SDK。

该SDK在底层分别使用了Android和iOS的实现。

使用方法

通过以下命令将Confidence SDK添加到您的Flutter应用中：

flutter pub add confidence_flutter_sdk

初始化Confidence

首先，我们需要设置API配置，其中包含一个api_key：

import 'package:confidence_flutter_sdk/confidence_flutter_sdk.dart';

final confidence = ConfidenceFlutterSdk();
await confidence.setup("API_KEY");

可以向SDK传递上下文信息：

await confidence.putContext(key, value);

也可以一次性发送多个上下文元素：

await confidence.putAllContext(map);

完成初始设置后，我们可以开始获取并访问标志（flags）：

await confidence.fetchAndActivate();
await confidence.getString("[FLAG]", "Default"));

属性的模式在解析属性时起着关键作用。如果模式类型与请求类型匹配，则返回该值，否则我们期望返回默认值。

发送自定义事件

可以通过以下方式向Confidence SDK发送自定义事件：

confidence.track("[EVENT-NAME]", <String, dynamic>{});

运行iOS示例应用

要在Xcode中运行iOS示例应用，请先更新子模块：

git submodule update --init --recursive

然后，您可以将ios/Classes/confidence_sdk/Sources/Confidence文件夹拖放到您的Xcode项目中，位于ConfidenceFlutterSDkPlugin.swift文件旁边。

接下来，如果您的iOS模拟器正在运行，可以使用以下命令运行Flutter：

flutter run

或者直接从Xcode运行应用。

示例代码

以下是完整的示例代码：

import 'dart:async';

import 'package:confidence_flutter_sdk/confidence_flutter_sdk.dart';
import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:flutter_dotenv/flutter_dotenv.dart';

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

class MyApp extends StatefulWidget {
  MyApp({super.key});
  final Completer<void> _initCompleter = Completer<void>();

  Future<void> initDone() async {
    return _initCompleter.future;
  }

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

class _MyAppState extends State<MyApp> {
  String _object = 'Unknown';
  String _message = 'Unknown';
  final _confidenceFlutterSdkPlugin = ConfidenceFlutterSdk();
  final Completer<void> initCompleter;

  _MyAppState(this.initCompleter);

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

  // 平台消息是异步的，所以我们初始化在一个异步方法中。
  Future<void> initPlatformState() async {
    String message;
    String object;
    // 平台消息可能会失败，所以我们使用try/catch来捕获PlatformException。
    // 我们也处理消息可能返回null的情况。
    try {
      await dotenv.load(fileName: ".env");
      await _confidenceFlutterSdkPlugin.setup(dotenv.env["API_KEY"]!);
      await _confidenceFlutterSdkPlugin.putAllContext({
        "targeting_key": "random",
        "my_bool": false,
        "my_int": 1,
        "my_double": 1.1,
        "my_map": {"key": "value"},
        "my_list": ["value1", "value2"]
      });
      await _confidenceFlutterSdkPlugin.fetchAndActivate();
      object =
          (_confidenceFlutterSdkPlugin.getObject("hawkflag", <String, dynamic>{})).toString();
      message =
          (_confidenceFlutterSdkPlugin.getString("ludwigs-new-test-flag.struct-key.string-key", "0"));
      final data = {
        'screen': 'home',
        "my_bool": false,
        "my_int": 1,
        "my_double": 1.1,
        "my_map": {"key": "value"},
        "my_list": ["value1", "value2"]
      };
      _confidenceFlutterSdkPlugin.track("navigate", data);
      _confidenceFlutterSdkPlugin.flush();
    } on PlatformException {
      message = 'Failed to get platform version.';
      object = 'Failed to get object.';
    }

    // 如果小部件在异步平台消息飞行时被树移除，我们希望丢弃回复而不是调用setState来更新我们的非存在的外观。
    if (!mounted) return;

    setState(() {
      _message = message;
      _object = object;
    });
    initCompleter.complete();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('插件示例应用'),
        ),
        body: Center(
          child: ListView.builder(
            itemCount: 2,
            itemBuilder: (context, index) {
              var title = "";
              switch (index) {
                case 0:
                  title = _message;
                case 1:
                  title = _object;
              }
              return ListTile(
                title: Text('$title\n'),
              );
            },
          ),
        ),
      ),
    );
  }
}