Flutter配置生成插件built_config_generator的使用

built_config_generator 是一个用于生成 built_config 包配置的工具。通过它，您可以轻松地管理应用的配置信息，并在运行时动态加载这些配置。

使用方法

1. 添加依赖

首先，在项目的 pubspec.yaml 文件中添加 built_config_generator 到 dev_dependencies 中：

dev_dependencies:
  built_config_generator: ^x.x.x

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

flutter pub get

2. 创建配置类

接下来，创建一个用于存储配置信息的类。例如，我们创建一个名为 AppConfig 的类来保存 API 地址和其他配置信息。

// lib/app_config.dart
import 'package:built_value/built_value.dart';
import 'package:built_value/serializer.dart';

part 'app_config.g.dart';

abstract class AppConfig implements Built<AppConfig, AppConfigBuilder> {
  String get apiUrl;

  AppConfig._();

  factory AppConfig([void Function(AppConfigBuilder) updates]) = _$AppConfig;

  static Serializer<AppConfig> get serializer => _$appConfigSerializer;
}

3. 生成配置文件

在项目根目录下运行以下命令以生成配置文件：

flutter pub run build_runner build

运行此命令后，会自动生成 app_config.g.dart 文件，该文件包含了 AppConfig 类的实现。

4. 使用配置

现在，您可以在应用中使用生成的 AppConfig 类来加载和访问配置信息。例如：

// lib/main.dart
import 'package:flutter/material.dart';
import 'app_config.dart';

void main() {
  // 加载配置
  final config = AppConfig((b) => b
    ..apiUrl = 'https://api.example.com'
  );

  runApp(MyApp(config: config));
}

class MyApp extends StatelessWidget {
  final AppConfig config;

  const MyApp({required this.config});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      home: MyHomePage(title: 'Flutter Demo Home Page', config: config),
    );
  }
}

class MyHomePage extends StatelessWidget {
  final AppConfig config;

  const MyHomePage({required Key key, required this.title, required this.config})
      : super(key: key);

  final String title;

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(title),
      ),
      body: Center(
        child: Text('API URL: ${config.apiUrl}'),
      ),
    );
  }
}

5. 动态加载配置

如果您希望从外部文件（如 JSON 文件）加载配置，可以使用 built_value 的 JsonSerializable 注解。例如：

修改 AppConfig 类

// lib/app_config.dart
import 'package:built_value/built_value.dart';
import 'package:built_value/serializer.dart';
import 'package:built_value/json_object.dart';

part 'app_config.g.dart';

abstract class AppConfig implements Built<AppConfig, AppConfigBuilder> {
  String get apiUrl;

  AppConfig._();

  factory AppConfig([void Function(AppConfigBuilder) updates]) = _$AppConfig;

  static Serializer<AppConfig> get serializer => _$appConfigSerializer;

  static AppConfig fromJson(Map<String, dynamic> json) {
    return standardSerializers.deserializeWith(serializer, json)!;
  }

  Map<String, dynamic> toJson() {
    return standardSerializers.serializeWith(serializer, this)! as Map<String, dynamic>;
  }
}

加载 JSON 配置

// lib/main.dart
import 'package:flutter/material.dart';
import 'app_config.dart';
import 'dart:convert';

void main() async {
  // 从 JSON 文件加载配置
  final jsonString = await rootBundle.loadString('assets/config.json');
  final config = AppConfig.fromJson(jsonDecode(jsonString));

  runApp(MyApp(config: config));
}

assets/config.json

{
  "apiUrl": "https://api.example.com"
}