Flutter功能开关管理插件 feature_flags_toggly 的使用

feature_flags_toggly 是一个为 Flutter 应用提供功能开关支持的 Dart 包，允许您在应用中轻松启用或禁用某些功能。此插件可以与 Toggly.io 服务结合使用，也可以独立运行。

什么是功能开关？

在软件开发中，功能开关（或称功能标志）提供了一种替代多分支代码管理的方法。通过在代码中设置条件，可以在运行时启用或禁用特定功能。

在敏捷环境中，功能开关可用于生产环境，根据需求对部分或全部用户开启某个功能，从而使得频繁发布变得更加容易。此外，高级发布策略如金丝雀发布和 A/B 测试也更容易处理。

安装

首先，在项目中添加 feature_flags_toggly：

$ flutter pub add feature_flags_toggly

这将在您的 pubspec.yaml 文件中添加如下依赖项，并自动执行 flutter pub get：

dependencies:
  feature_flags_toggly: ^0.0.1

然后，在 Dart 代码中导入该包：

import 'package:feature_flags_toggly/feature_flags_toggly.dart';

基本使用（使用 Toggly.io）

初始化

要初始化 Toggly，请调用 Toggly.init 方法并提供从 Toggly 应用页面 获取的应用密钥：

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

void initToggly() async {
  await Toggly.init(
    appKey: '<your_app_key>',
    environment: '<your_app_environment>',
    refreshInterval: const Duration(minutes: 1), // 从服务器刷新功能标志的时间间隔
    flagDefaults: {
      "ExampleFeatureKey1": true,
      "ExampleFeatureKey2": false,
      "ExampleFeatureKey3": true,
    },
  );
}

refreshInterval 参数决定从 Toggly.io 服务器刷新功能标志的频率，默认值为 10 分钟。

使用示例

将需要控制显示的功能包装在 Feature 小部件中，并提供相应的 featureKeys：

Feature(
  featureKeys: const ['ExampleFeatureKey1'],
  child: const Text('This text will show if ExampleFeatureKey1 is FALSE'),
),

还可以为一个 Feature 小部件使用多个功能键，并利用 requirement 和 negate 选项：

Feature(
  featureKeys: const ['ExampleFeatureKey1', 'ExampleFeatureKey2'],
  requirement: FeatureRequirement.any,
  child: const Text('This text will show if ANY of the provided feature keys are TRUE'),
),

Feature(
  featureKeys: const ['ExampleFeatureKey1', 'ExampleFeatureKey2'],
  requirement: FeatureRequirement.all,
  child: const Text('This text will show if ALL the provided feature keys are TRUE'),
),

Feature(
  featureKeys: const ['ExampleFeatureKey1'],
  negate: true,
  child: const Text('This text will show if ExampleFeatureKey1 is FALSE'),
),

同样，可以直接调用 evaluateFeatureGate 来评估功能开关的状态：

await Toggly.evaluateFeatureGate(
  ["ExampleFeatureKey1", "ExampleFeatureKey2"],
  requirement: FeatureRequirement.all,
  negate: true,
);

基本使用（不使用 Toggly.io）

如果不需要连接到 Toggly.io，只需初始化 flagDefaults 即可：

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

void initToggly() async {
  await Toggly.init(
    flagDefaults: {
      "ExampleFeatureKey1": true,
      "ExampleFeatureKey2": false,
      "ExampleFeatureKey3": true,
    },
  );
}

后续使用方式与上述相同。

示例 Demo

以下是一个完整的 Flutter 示例，展示了如何在实际应用中使用 feature_flags_toggly：

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

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

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blueGrey,
      ),
      home: const MyHomePage(title: 'Toggly Flutter Example'),
    );
  }
}

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

  final String title;

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

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

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

  void _resetCounter() {
    setState(() {
      _counter = 0;
    });
  }

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

  void initToggly() async {
    await Toggly.init(
      flagDefaults: {
        "ExampleDescription": true,
        "ResetCounterButton": true,
      },
    );
  }

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

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Feature(
              featureKeys: ['ExampleDescription'],
              requirement: FeatureRequirement.any,
              child: AppDescription(),
            ),
            const Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
          ],
        ),
      ),
      floatingActionButton: Row(
        mainAxisAlignment: MainAxisAlignment.end,
        children: [
          Feature(
            featureKeys: const ['ResetCounterButton'],
            child: FloatingActionButton(
              onPressed: _resetCounter,
              tooltip: 'Reset',
              backgroundColor: Colors.black54,
              child: const Icon(Icons.refresh),
            ),
          ),
          const SizedBox(width: 8),
          FloatingActionButton(
            onPressed: _incrementCounter,
            tooltip: 'Increment',
            backgroundColor: const Color(0xFF556ee6),
            child: const Icon(Icons.add),
          ),
        ],
      ),
    );
  }
}

class AppDescription extends StatelessWidget {
  const AppDescription({super.key});

  @override
  Widget build(BuildContext context) {
    return const Padding(
      padding: EdgeInsets.only(bottom: 100.0, left: 38.0, right: 38.0),
      child: Column(
        crossAxisAlignment: CrossAxisAlignment.start,
        children: [
          Text(
            'See feature flags in action',
            style: TextStyle(
              fontSize: 22,
              fontWeight: FontWeight.bold,
              color: Color(0xFF556ee6),
            ),
          ),
          SizedBox(height: 20.0),
          Text(
            'Provide different values to the "flagDefault" property when initializing Toggly to enable/disable features.',
            style: TextStyle(
              color: Color(0xFF556ee6),
            ),
          ),
        ],
      ),
    );
  }
}

这个示例展示了如何通过功能开关控制应用中的不同组件显示与否。希望这对您有所帮助！