Flutter特性开关管理插件splitio的使用

概述

splitio 是一个官方的Flutter插件，用于与Split平台进行集成。Split是一个控制发布功能的平台，通过特征标志（feature flags）向用户提供功能，并管理您的完整客户体验。

兼容性

快速入门

在您的 pubspec.yaml 文件中添加 splitio 作为依赖项：

dependencies:
  splitio: ^latest_version

下面是一个如何执行评估的小示例：

import 'package:splitio/splitio.dart';

final Splitio _split = Splitio('YOUR_SDK_KEY', 'USER_KEY');

/// 获取处理结果
_split.client(onReady: (client) async {
  final String treatment = await client.getTreatment('FEATURE_FLAG_NAME');

  if (treatment == 'on') {
    /// 插入代码以显示“开启”处理结果
  } else if (treatment == 'off') {
    /// 插入代码以显示“关闭”处理结果
  } else {
    /// 插入控制处理结果代码
  }
});

更多详细的使用示例可以参考 这里。

完整示例Demo

以下是一个完整的Flutter应用程序示例，展示如何使用 splitio 插件：

import 'package:flutter/material.dart';
import 'package:splitio/splitio.dart';

const String _sdkKey = 'sdk-key'; // 替换为有效的SDK Key
const String _matchingKey = 'user-id'; // 替换为有效的用户ID

void main() {
  runApp(const SplitioExampleApp());
}

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

  @override
  State<SplitioExampleApp> createState() => _SplitioExampleAppState();
}

class _SplitioExampleAppState extends State<SplitioExampleApp> {
  String _featureFlagName = '';
  bool _sdkReady = false;
  bool _sdkReadyFromCache = false;
  late SplitClient _client;

  final Splitio _split = Splitio(_sdkKey, _matchingKey,
      configuration: SplitConfiguration(
        trafficType: "user",
      ));

  @override
  void initState() {
    super.initState();
    _initClients();
  }

  void _initClients() {
    _client = _split.client(
        matchingKey: _matchingKey,
        onReady: (client) {
          setState(() {
            _sdkReady = true;
          });
        });

    _client.whenReadyFromCache().then((value) {
      setState(() {
        _sdkReadyFromCache = true;
      });
    });

    _client.setAttributes({
      'name': 'splitio',
      'age': 1,
      'available': true,
    });
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('split.io example app'),
        ),
        body: SingleChildScrollView(
          child: Padding(
            padding: const EdgeInsets.all(8),
            child: Center(
              child: Column(
                mainAxisAlignment: MainAxisAlignment.center,
                crossAxisAlignment: CrossAxisAlignment.center,
                children: [
                  Text(
                    'SDK ready: $_sdkReady',
                    style: const TextStyle(fontWeight: FontWeight.bold, fontSize: 24),
                  ),
                  Text(
                    'SDK ready from cache: $_sdkReadyFromCache',
                    style: const TextStyle(fontWeight: FontWeight.bold, fontSize: 24),
                  ),
                  Padding(
                    padding: const EdgeInsets.fromLTRB(32, 8, 32, 8),
                    child: TextField(
                      decoration: const InputDecoration(hintText: 'Enter feature flag name'),
                      onChanged: (text) {
                        setState(() {
                          _featureFlagName = text;
                        });
                      },
                    ),
                  ),
                  Visibility(
                    visible: _featureFlagName != '',
                    child: ElevatedButton(
                      onPressed: performEvaluation,
                      child: Text('Evaluate: $_featureFlagName'),
                    ),
                  ),
                  Visibility(
                    visible: _sdkReady || _sdkReadyFromCache,
                    child: Column(
                      children: [
                        ElevatedButton(
                          onPressed: track,
                          child: const Text('Track event'),
                        ),
                        ElevatedButton(
                          onPressed: getAttributes,
                          child: const Text('Get attributes'),
                        ),
                        ElevatedButton(
                          onPressed: removeAttribute,
                          child: const Text('Remove age attribute'),
                        ),
                        ElevatedButton(
                          onPressed: flush,
                          child: const Text('Flush'),
                        ),
                        ElevatedButton(
                          onPressed: destroy,
                          child: const Text('Destroy'),
                        ),
                      ],
                    ),
                  ),
                  Visibility(
                    visible: !(_sdkReady || _sdkReadyFromCache),
                    child: const CircularProgressIndicator(),
                  ),
                ],
              ),
            ),
          ),
        ),
      ),
    );
  }

  void performEvaluation() async {
    _client.getTreatment(_featureFlagName).then((value) {
      print('Evaluation value for $_featureFlagName is $value');
    });
  }

  void track() {
    _client.track("event-type", trafficType: "account", value: 25, properties: {
      "age": 50
    }).then((value) => print('Track result is: ' + value.toString()));
  }

  void getAttributes() async {
    var attributes = await _client.getAttributes();
    print('Attribute values: ' + attributes.toString());
  }

  void removeAttribute() async {
    _client.removeAttribute('age');
  }

  void flush() async {
    _client.flush();
  }

  void destroy() async {
    _client.destroy();
  }

  @override
  void dispose() {
    destroy();
    super.dispose();
  }
}

此示例展示了如何初始化Split客户端、设置用户属性、从缓存加载数据以及执行各种操作，如获取特征标志、跟踪事件和销毁客户端等。

提交问题

您可以在 GitHub issue tracker 上提交任何问题、反馈或功能增强请求。Split团队会监控所有提交的问题，并尽力及时回复。

贡献

请参阅 贡献者指南 了解如何提交Pull Request (PR)。

许可证

根据Apache License 2.0版本授权。更多信息请查看 Apache License。

关于Split

Split是领先的特征交付平台，帮助工程团队快速部署特征。更多关于Split的信息，请访问 split.io/product 或查阅 文档。