Flutter功能管理插件feature_manager的使用

Flutter功能管理插件feature_manager的使用

Feature Manager for Flutter

Feature Manager 允许您隐藏未完成或秘密的功能，或者从远程数据源或本地设置管理实验。

如果您想使用 Firebase Remote Config 进行 A/B 测试或功能切换，请使用 Remote Config Feature Manager。

示例代码

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

void main() {
  final appFeatures = AppFeatures.instance();

  // 访问单个特征
  final textValue = appFeatures.textFeature.value;
  final isEnabled = appFeatures.booleanFeature.isEnabled;

  // 使用扩展访问所有特征
  for (final feature in appFeatures.values) {
    print('Feature key: ${feature.key}');
  }
}

安装

在您的 pubspec.yaml 文件中添加以下内容：

dependencies:
  feature_manager: ^latest_version
  # Other dependencies

dev_dependencies:
  build_runner:
  feature_manager_generator: ^latest_version

然后运行：

flutter packages get

基本使用

创建功能并使用代码生成

从版本 3.0.0 开始，feature_manager 支持代码生成以简化功能创建和管理。

1. 添加注解到您的功能

   创建一个 Dart 文件（例如：app_features.dart）并使用提供的注解定义您的功能：

   import 'package:feature_manager/annotations.dart';
   import 'package:feature_manager/feature.dart';
   import 'package:feature_manager/feature_manager.dart';
   
   part 'features.fm.g.dart';
   
   [@FeatureManagerInit](/user/FeatureManagerInit)()
   class AppFeatures {
     AppFeatures({
       required this.textFeature,
       required this.booleanFeature,
       required this.doubleFeature,
       required this.integerFeature,
       required this.jsonFeature,
     });
   
     factory AppFeatures.instance() => _$AppFeatures();
   
     @FeatureOptions(
       key: 'dev-prefs-text-pref',
       title: 'Text pref',
       description: 'This is text preference',
       defaultValue: '',
       valueType: FeatureValueType.text,
     )
     final Feature textFeature;
   
     @FeatureOptions(
       key: 'dev-prefs-bool-pref',
       title: 'Toggle pref',
       description: 'This is toggle preference',
       defaultValue: false,
       valueType: FeatureValueType.toggle,
     )
     final Feature booleanFeature;
   
     @FeatureOptions(
       key: 'dev-prefs-double-pref',
       title: 'Number double pref',
       description: 'This is number double preference',
       defaultValue: null,
       valueType: FeatureValueType.doubleNumber,
     )
     final Feature doubleFeature;
   
     @FeatureOptions(
       key: 'dev-prefs-integer-pref',
       title: 'Number integer pref',
       description: 'This is number integer preference',
       defaultValue: null,
       valueType: FeatureValueType.integerNumber,
     )
     final Feature integerFeature;
   
     @FeatureOptions(
       key: 'dev-prefs-json-pref',
       title: 'Json pref',
       description: 'This is json preference',
       defaultValue: "{value: 'Json default value'}",
       valueType: FeatureValueType.json,
     )
     final Feature jsonFeature;
   }
   

2. 使用代码生成

   在 app_features.dart 文件中添加上述代码，并运行以下命令来生成功能类：

   flutter packages pub run build_runner build
   

3. 使用生成的功能

   导入生成的文件并在代码中使用这些功能：

   import 'features.dart';
   // 由于 'part' 指令，生成的部分文件会自动包含进来。
   
   void main() {
     final appFeatures = AppFeatures.instance();
   
     // 访问单个特征
     final textValue = appFeatures.textFeature.value;
     final isEnabled = appFeatures.booleanFeature.isEnabled;
   
     // 使用扩展访问所有特征
     for (final feature in appFeatures.values) {
       print('Feature key: ${feature.key}');
     }
   }
   

使用功能

要通过 FeatureManager 检查某个功能是否启用，请通过依赖注入（例如 Provider, GetIt) 或直接创建实例：

import 'package:feature_manager/feature_manager.dart';

final featureManager = FeatureManager();

final appFeatures = AppFeatures.instance();

// 检查功能是否启用
final isEnabled = featureManager.isEnabled(appFeatures.booleanFeature);

或者，因为每个功能都提供了一个 isEnabled 属性，可以直接访问它：

final isEnabled = appFeatures.booleanFeature.isEnabled;

在调试模式中修改功能值

要在调试模式中修改功能值，只需打开应用程序中的开发者偏好屏幕。应将您的功能列表作为参数传递给此屏幕。

注意：在生产构建中隐藏此屏幕或导航选项以防止用户访问开发功能。

Navigator.of(context).push(
  MaterialPageRoute(
    builder: (BuildContext context) =>
      DeveloperPreferencesScreen(Features.values),
    ),
);

功能参数

贡献

请随时联系我 (a.e.getman@gmail.com) 或为此仓库创建 Pull Requests :)

enum FeatureType { feature, experiment }

enum FeatureValueType { text, toggle, doubleNumber, integerNumber, json }