Flutter类型绑定插件type_binder的使用

TypeBinder 插件简化了在 Dart 中管理多种 JSON-可序列化类的过程。它提供了一个基于类型的动态类注册表，以简化将 JSON 数据转换为 Dart 对象的过程。此插件特别适用于模式管理、小部件构建或反序列化时使用类型注解。

通过利用代码生成，此插件会自动将带有注解的类映射到其对应的 fromJson 方法。这使得开发者能够动态处理不同的类类型，而无需手动编写大量的样板代码。

关键特性

1. 基于类型的类注册表 自动生成一个注册表，通过 @TypeAnnotation 将字符串类型的标识符与各自的 fromJson 工厂构造函数关联起来。

2. 自动代码生成 利用 build_runner 和 source_gen 实现无缝高效的代码生成。

3. 可定制且灵活 任何带有 @TypeAnnotation 注解的类都会被包含在生成的注册表中，使其高度适应各种使用场景。

使用方法

1. 在 pubspec.yaml 中添加依赖

首先，在项目的 pubspec.yaml 文件中添加 schema_registry 依赖：

dependencies:
  schema_registry: ^1.0.0

dev_dependencies:
  build_runner: ^2.0.0

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

flutter pub get

2. 添加类型注解

创建一个带有 @TypeAnnotation 注解的类，并使用 @JsonSerializable() 注解来支持 JSON 序列化和反序列化：

import 'package:json_annotation/json_annotation.dart';
import 'package:schema_registry/schema_registry.dart';

// 定义一个带有类型注解的类
@TypeAnnotation('test') // 类型标识符为 "test"
@JsonSerializable()
class TestClass {
  TestClass();

  // 自动生成的反序列化工厂方法
  factory TestClass.fromJson(Map<String, dynamic> json) => _$TestClassFromJson(json);

  // 自动生成的序列化方法
  Map<String, dynamic> toJson() => _$TestClassToJson(this);
}

3. 运行代码生成命令

为了生成注册表文件，需要运行 build_runner 命令：

dart run build_runner build

这将在项目中生成一个注册表文件，用于存储所有带有 @TypeAnnotation 注解的类。

4. 在工厂类中使用生成的注册表

接下来，在工厂类中使用生成的注册表来动态解析 JSON 数据：

import 'package:json_annotation/json_annotation.dart';
import 'package:schema_registry/schema_registry.dart';

// 工厂类，用于根据 JSON 数据动态创建对象
@JsonSerializable()
class FactoryTestClass {
  FactoryTestClass(this.type);

  final String type;

  // 动态解析 JSON 数据并返回对应的类实例
  factory FactoryTestClass.fromJson(Map<String, dynamic> json) {
    return registry[json['type']]!(json); // 使用注册表中的工厂方法
  }

  // 自动生成的序列化方法
  Map<String, dynamic> toJson() => _$FactoryTestClassJson(this);
}

完整示例

以下是一个完整的示例，展示了如何使用 TypeBinder 插件来处理不同类型的 JSON 数据：

1. 定义两个测试类

import 'package:json_annotation/json_annotation.dart';
import 'package:schema_registry/schema_registry.dart';

// 第一个测试类
@TypeAnnotation('test1') // 类型标识符为 "test1"
@JsonSerializable()
class TestClass1 {
  TestClass1(this.name);

  final String name;

  factory TestClass1.fromJson(Map<String, dynamic> json) => _$TestClass1FromJson(json);
  Map<String, dynamic> toJson() => _$TestClass1ToJson(this);
}

// 第二个测试类
@TypeAnnotation('test2') // 类型标识符为 "test2"
@JsonSerializable()
class TestClass2 {
  TestClass2(this.age);

  final int age;

  factory TestClass2.fromJson(Map<String, dynamic> json) => _$TestClass2FromJson(json);
  Map<String, dynamic> toJson() => _$TestClass2ToJson(this);
}

2. 创建工厂类

import 'package:json_annotation/json_annotation.dart';
import 'package:schema_registry/schema_registry.dart';

@JsonSerializable()
class FactoryTestClass {
  FactoryTestClass(this.type);

  final String type;

  factory FactoryTestClass.fromJson(Map<String, dynamic> json) {
    return registry[json['type']]!(json); // 动态解析 JSON 数据
  }

  Map<String, dynamic> toJson() => _$FactoryTestClassJson(this);
}

3. 测试代码

void main() async {
  // 模拟 JSON 数据
  final jsonData1 = {'type': 'test1', 'name': 'Alice'};
  final jsonData2 = {'type': 'test2', 'age': 25};

  // 使用工厂类解析 JSON 数据
  final instance1 = FactoryTestClass.fromJson(jsonData1);
  final instance2 = FactoryTestClass.fromJson(jsonData2);

  // 输出结果
  print(instance1); // 输出 TestClass1 实例
  print(instance2); // 输出 TestClass2 实例
}