Flutter通用配置管理插件common_configs的使用

一个简单的包，可以在你的应用中作为全局配置使用，或者在你的包之间共享配置。

特性

• 在整个应用中使用全局配置。
• 在包之间共享配置。
• 从任何地方访问配置。
• 使用 Config.fromMap 从 Map 加载配置。

开始使用

将此包添加为依赖项：

dart pub add common_configs

并在文件中导入它：

import 'package:common_configs/common_configs.dart';

使用方法

以下是一个简短的示例。

首先，可以使用任何标识符来表示你的配置类型。在这个例子中，我使用了一个枚举 ConfigType。

enum ConfigType {
  devel,
  staging,
  prod,
}

接下来，我们将使用一个预定义的 MapConfig，它使用 Map<String, dynamic> 作为配置，并带有一个标识符。

Config createDevelConfig() => MapConfig(ConfigType.devel, { 'hello': 'world' });

要创建自己的配置，可以从 Config 类继承开始。

要使用此配置，可以使用 [Config.put] 方法设置它。

Config.put(create: createDevelConfig);

默认情况下，配置存储在名称为 default 的配置中。

如果要使用其他名称，则可以在获取或设置配置时使用 name 参数。

Config.put(create: createDevelConfig, name: 'app.config');

额外信息

你可以编写自己的代码从源（如 json 或 .env 文件）获取配置详细信息。

对于更长的例子，可以查看 /example 文件夹。

完整示例代码

// ignore_for_file: unused_local_variable

import 'package:common_configs/common_configs.dart';

/// 创建你自己的配置，通过扩展 [Config]。
class Awesome extends Config {
  Awesome(this.id);
  @override
  final AwesomeType id;
}

/// 可选地使用一个枚举作为标识符以区分不同的 [Config]。
enum AwesomeType {
  good,
  better,
  best,
}

Awesome createGoodConfig() => Awesome(AwesomeType.good);
Awesome createBetterConfig() => Awesome(AwesomeType.better);
Awesome createBestConfig() => Awesome(AwesomeType.best);

class AwesomeMapConfig extends MapConfig<AwesomeType> {
  AwesomeMapConfig(super.id, super.data);
}

AwesomeMapConfig createMapConfig() => AwesomeMapConfig(
      AwesomeType.better,
      {'Hello': 'World'},
    );

void main() {
  print('== `default` config ==');

  /// 设置你的配置使用 [Config.put]。
  ///
  /// 示例用例：不同的入口点可以使用不同的配置。
  Config.put(create: createGoodConfig);

  /// 使用 [isA] 方法，你可以检查当前配置。
  print('is good: ${Config.isA(AwesomeType.good)}');
  print('is better: ${Config.isA(AwesomeType.better)}');
  print('is best: ${Config.isA(AwesomeType.best)}');

  /// 你也可以使用不同的名称来获取或存储配置。
  const someOtherScopeName = 'awesome.map';

  print('== `$someOtherScopeName` config ==');

  Config.put(create: createMapConfig, name: someOtherScopeName);

  print('is good: ${Config.isA(AwesomeType.good, someOtherScopeName)}');
  print('is better: ${Config.isA(AwesomeType.better, someOtherScopeName)}');
  print('is best: ${Config.isA(AwesomeType.best, someOtherScopeName)}');

  /// 如果你想通过名称更方便地管理配置，可以尝试使用 [Config.by]。
  final useItLikeConfig = Config.by(someOtherScopeName);

  useItLikeConfig.get();
  useItLikeConfig.set(createMapConfig);
  useItLikeConfig.setIfAbsent(createMapConfig);
  useItLikeConfig.isA(AwesomeType.best);
  useItLikeConfig.setImmediately(createMapConfig());

  /// 你可以选择性地为其提供类型。
  Config.by<AwesomeType, AwesomeMapConfig>(someOtherScopeName);
}