Flutter远程配置管理插件remote_config_feature_manager的使用

Flutter远程配置管理插件remote_config_feature_manager的使用

标题

Flutter远程配置管理插件remote_config_feature_manager的使用

内容

Feature Manager 允许您隐藏一些未完成/秘密的功能，这些功能可以从远程数据源或本地设置进行管理。

• 如果您只需要本地功能切换或偏好，请使用 Feature Manager。

Getting Started

• 安装
  • 添加以下依赖项到您的 pubspec.yaml 文件中：

    dependencies:
      remote_config_feature_manager: ^latest_version
    
    dev_dependencies:
      build_runner:
      feature_manager_generator: ^latest_version
    

  • 在项目根目录运行以下命令以获取依赖项：

    flutter packages get
    

Setup Firebase Remote Config in your project.

• 要开始使用 Firebase Remote Config for Flutter，请参阅文档：Firebase Remote Config 文档 可用链接：https://firebase.flutter.dev

Basic Usage

• 创建功能代码生成
  • 自从版本 3.0.0，feature_manager 支持代码生成来简化功能的创建和管理。

Steps to Use Code Generation

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.g.dart';
     
     @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',
         remoteSourceKey: 'REMOTE-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',
         remoteSourceKey: 'remote_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. 使用代码生成
   • 使用以下命令生成特征类：

     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}');
       }
     }
     

Activate feature manager

• 要获取并激活功能值，请使用 activate 函数。您应该调用 RemoteConfigFeatureManager.getInstance() 函数初始化 RemoteConfigFeatureManager 实例及其依赖项。之后，您可以在整个应用程序中使用 RemoteConfigFeatureManager.instance。

...
final featureManager =
      await RemoteConfigFeatureManager.getInstance();

await featureManager.activate(
            Features.values,
            minimumFetchInterval: const Duration(
                  minutes: 5,
            ),
      );
...

• 如果您希望在其他地方初始化 FirebaseRemoteConfig，请只需使用 refresh 函数将远程值映射到您的功能。

...
featureManager.refresh(Features.values);
...

Using Features

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

import 'package:feature_manager/feature_manager.dart';

final featureManager = RemoteConfigFeatureManager.instance;

final appFeatures = AppFeatures.instance();

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

• 或者，由于每个功能都提供了一个 isEnabled 属性，您可以直接访问它：

final isEnabled = featureManager.booleanFeature.isEnabled;
// 或
final isEnabled = appFeatures.booleanFeature.isEnabled;

Modify remote feature values in Firebase Console

• 修改 Firebase 控制台中的远程功能值：

Modify feature values in DEBUG mode

• 在调试模式下修改功能值：
  • 打开开发人员首选项屏幕，传递您的功能列表作为参数。
  • 注意：生产构建时应隐藏此按钮。

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

Feature parameters

enum FeatureType { feature, experiment }

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