Flutter JSON序列化与依赖注入插件json_serializable_ioc_generator的使用

json_serializable_ioc_generator 是一个简化模型类 toJson 和 fromJson 方法注册的插件。它与 json_serializable_ioc 配合使用，能够自动生成这些方法的注册代码。

特性

• 自动方法注册：自动生成代码以注册模型的工厂方法和转换器方法。
• 利用 [@JsonSerializable](/user/JsonSerializable)：使用 json_annotation 包进行模型序列化。
• 自定义启动注解：将 [@RegisterJsonSerializable](/user/RegisterJsonSerializable) 注解应用于负责应用程序配置的方法（如 main()），触发生成 $registerJsonSerializableMethods() 方法。
• 生成的注册方法：生成一个 $registerJsonSerializableMethods() 函数，用于在运行时注册序列化方法。

安装

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

dependencies:
  json_annotation: ^4.7.0
  json_serializable_ioc: ^1.0.0

dev_dependencies:
  build_runner: ^2.1.0
  json_serializable_ioc_generator: ^1.0.0

然后运行以下命令以获取依赖项：

flutter pub get

工作原理

1. 模型注解：使用 json_annotation 包中的 [@JsonSerializable](/user/JsonSerializable) 注解标记模型类。这会触发生成 toJson 和 fromJson 方法。
2. 注册注解：使用 [@RegisterJsonSerializable](/user/RegisterJsonSerializable) 注解标记负责依赖注入配置的方法（如 main()）。这会生成 $registerJsonSerializableMethods() 函数。
3. 代码生成：使用 build_runner 工具生成注册方法。
4. 启动应用：调用生成的 $registerJsonSerializableMethods() 方法，将序列化方法注册到 JsonFactoryIoc 和 JsonConverterIoc 容器中。

基本用法

1. 注解你的模型

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

part 'user.g.dart'; // 自动生成的文件

[@JsonSerializable](/user/JsonSerializable)()
class User {
  final int id;
  final String name;

  User({required this.id, required this.name});

  // 自动生成的工厂方法
  factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);

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

在此示例中，User 模型使用了 [@JsonSerializable](/user/JsonSerializable) 注解，这将为该模型生成 fromJson 和 toJson 方法。

2. 代码生成

运行以下命令以触发代码生成：

flutter pub run build_runner build

这将生成 $registerJsonSerializableMethods() 函数，该函数会自动注册工厂和转换器方法。

3. 注册序列化方法

在 main.dart 或其他启动方法中，使用 [@RegisterJsonSerializable](/user/RegisterJsonSerializable) 注解标记方法以触发代码生成。生成后，调用生成的 $registerJsonSerializableMethods() 函数。

// main.dart
import 'dart:convert';
import 'package:json_ioc_example/user.dart';
import 'package:json_ioc_example/main.json_ioc.dart';
import 'package:json_serializable_ioc/json_serializable_ioc.dart';

[@RegisterJsonSerializable](/user/RegisterJsonSerializable)() // 触发生成 $registerJsonSerializableMethods()
void main(List<String> arguments) {
  // 注册所有注解模型的方法
  $registerJsonSerializableMethods();

  // 从 JSON 反序列化 User 对象
  User user = factory<User>({
    "id": 55,
    "name": "potatoes",
  });

  // 将 User 对象序列化回 JSON
  print(jsonEncode(converter<User>(user))); // 输出: {"id":55,"name":"potatoes"}
}

解释：

• [@RegisterJsonSerializable](/user/RegisterJsonSerializable) 注解被用于 main() 方法，这将生成 $registerJsonSerializableMethods() 函数。
• 此函数将 toJson 和 fromJson 方法注册到 JsonFactoryIoc 和 JsonConverterIoc 容器中。
• 使用 factory<T>() 动态反序列化 User 实例，使用 converter<T>() 将其序列化回 JSON。

API 参考

[@RegisterJsonSerializable](/user/RegisterJsonSerializable)

此注解用于标记负责依赖注入配置的方法（通常是 main() 方法）。它触发生成 $registerJsonSerializableMethods() 函数，该函数注册所有带有 [@JsonSerializable](/user/JsonSerializable) 注解的模型的 toJson 和 fromJson 方法。

生成的方法：$registerJsonSerializableMethods()

此方法由代码生成器生成，并将所有带有 [@JsonSerializable](/user/JsonSerializable) 注解的模型的 toJson 和 fromJson 方法注册到 JsonFactoryIoc 和 JsonConverterIoc 容器中。必须在运行时调用以正确注册。

示例代码

以下是完整的示例代码：

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

part 'user.g.dart';

[@JsonSerializable](/user/JsonSerializable)()
class User {
  final int id;
  final String name;

  User({required this.id, required this.name});

  factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);

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

// main.dart
import 'dart:convert';
import 'package:json_ioc_example/user.dart';
import 'package:json_ioc_example/main.json_ioc.dart';
import 'package:json_serializable_ioc/json_serializable_ioc.dart';

[@RegisterJsonSerializable](/user/RegisterJsonSerializable)()
void main(List<String> arguments) {
  // 注册所有注解模型的方法
  $registerJsonSerializableMethods();

  // 从 JSON 反序列化 User 对象
  User user = factory<User>({
    "id": 55,
    "name": "potatoes",
  });

  // 将 User 对象序列化回 JSON
  print(jsonEncode(converter<User>(user))); // 输出: {"id":55,"name":"potatoes"}
}