Flutter配置管理插件config_builder的使用

Flutter配置管理插件config_builder的使用

插件介绍

config_builder 是一个用于通过代码生成从 .json 文件构建应用配置的插件。它支持类型安全，并且在应用启动时无需进行不必要的 IO/解析。

特性

• 避免将配置存储在 Dart 文件中。
• 避免在应用启动时从磁盘读取并解析配置文件。
• 类型安全。
• 支持 String, bool, int, double 和枚举类型。

使用方法

1. 添加到 devDependencies 中（示例）：

   dev_dependencies:
     build_runner: <version>
     config_builder: <version>
   

2. 定义配置模型：

   part 'config.g.dart'; // 使用与该 Dart 文件同名的 <filename>.g.dart
   
   [@BuildConfiguration](/user/BuildConfiguration)([
     ConfigFile(configName: "devConfig", path: "lib/secrets/config.dev.json"),
     ConfigFile(configName: "testConfig", path: "lib/secrets/config.test.json"),
   ])
   class Config {
     final String name;
     final int value;
     final Environment environment;
   
     const Config({this.name, this.value, this.environment});
   }
   

3. 确保配置类具有一个 const 构造函数，参数名称唯一。 生成的代码会假设这样的构造函数存在。

4. 添加您的配置 JSON 文件（必须保存在 lib/ 目录中：

   {
     "name": "devApp",
     "value": 1,
     "environment": "Dev"
   }
   

5. 运行代码生成：

   flutter packages pub run build_runner build
   

   或者

   pub run build_runner build
   

6. 现在可以在应用程序的不同入口点访问配置对象：

   main.dev.dart:
   ```dart
   import 'config.dart';
   
   void main() => printConfig(devConfig);
   

   main.test.dart:
   ```dart
   import 'config.dart';
   
   void main() => printConfig(testConfig);
   

示例代码

import 'package:config_builder_example/config.dart';
import 'package:config_builder_example/do_stuff_with_config.dart';

void main(){
  // 运行 'flutter packages pub run build_runner build' 来生成代码
  final Config config = prodConfig;
  printConfig(config);
}

完整示例 demo

// config.g.dart
part 'config.g.dart';

[@BuildConfiguration](/user/BuildConfiguration)([
  ConfigFile(configName: "devConfig", path: "lib/secrets/config.dev.json"),
  ConfigFile(configName: "testConfig", path: "lib/secrets/config.test.json"),
])
class Config {
  final String name;
  final int value;
  final Environment environment;

  const Config({this.name, this.value, this.environment});
}

// config.dev.json
{
  "name": "devApp",
  "value": 1,
  "environment": "Dev"
}

// config.test.json
{
  "name": "testApp",
  "value": 2,
  "environment": "Test"
}

// main.dev.dart
import 'config.dart';

void main() => printConfig(devConfig);

// main.test.dart
import 'config.dart';

void main() => printConfig(testConfig);