Flutter自动生成配置文件插件default_config_generator的使用

参考 https://github.com/deCardenas/json_config_generator

json 文件创建配置类的生成器。

安装

在 pubspec.yaml 文件中添加以下依赖：

dependencies:
  default_config_annotation: ^0.0.2

dev_dependencies:
  build_runner:
  default_config_generator: ^0.1.0

执行以下命令以安装依赖：

flutter pub get

使用

创建一个空配置类

首先，在 Dart 文件中导入 default_config_annotation 并定义一个空的配置类。生成器会根据 JSON 文件生成对应的类。

import 'package:default_config_annotation/default_config_annotation.dart';

part 'default_config.g.dart'; // {dart file name}.g.dart

@DefaultConfig(path: 'assets/config/dev.json') // 指定 JSON 文件路径
class $DefaultConfig {}

JSON 文件 dev.json

创建一个 JSON 文件 dev.json，用于存储配置信息。

{
  "base_url": "https://example.com",
  "custom_class": {
    "value_1": "we324523b252dghfdhd",
    "value_2": "3c252bv66b7yn5m8m6"
  },
  "int_value": 3,
  "double_value": 3.5,
  "boolean_value": true,
  "string_list": ["hello", "world"],
  "int_list": [1, 23, 5],
  "bool_list": [false, true, true]
}

运行命令

执行以下命令以生成配置类：

flutter pub run build_runner build

生成器会根据 JSON 文件生成对应的 Dart 类文件。

生成的文件 default_config.g.dart

生成器会生成以下文件 default_config.g.dart，包含解析后的常量类。

// 默认配置类
class DefaultSetting {
  static const String baseUrl = "https://example.com"; // 基础 URL

  static const customClass = _CustomClass(); // 自定义类实例

  static const int intValue = 3; // 整型值

  static const double doubleValue = 3.5; // 浮点型值

  static const bool booleanValue = true; // 布尔值

  static const List<String> stringList = ["hello", "world"]; // 字符串列表

  static const List<int> intList = [1, 23, 5]; // 整数列表

  static const List<bool> boolList = [false, true, true]; // 布尔值列表
}

// 自定义类
class _CustomClass {
  const _CustomClass();

  final String value1 = "we324523b252dghfdhd"; // 自定义字段 1

  final String value2 = "3c252bv66b7yn5m8m6"; // 自定义字段 2
}