Flutter数据序列化插件built_value的使用

简介

built_value 是一个用于 Dart 的库，它提供了不可变值类型、枚举类和 JSON 序列化等功能。它帮助开发者创建不可变的数据模型，并且能够自动生成大量的样板代码（boilerplate code），从而减少手动编写和维护的成本。此外，它还支持复杂的对象模型设计，包括泛型和接口的使用。

安装与配置

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

dependencies:
  built_value: ^8.6.0 # 请根据最新版本进行调整
  built_collection: ^5.1.1 # 用于处理不可变集合

dev_dependencies:
  build_runner: ^2.3.3 # 用于生成代码
  built_value_generator: ^8.6.0 # 用于生成代码

确保你已经安装了 build_runner 和 built_value_generator，它们是用于生成代码的工具。

示例代码

下面是一个完整的示例，展示了如何使用 built_value 创建一个简单的 Person 类，并实现其 JSON 序列化和反序列化功能。

定义 Person 类

首先，在 lib/models/person.dart 文件中定义 Person 类：

import 'package:built_value/built_value.dart';
import 'package:built_value/serializer.dart';
import 'package:built_collection/built_collection.dart';

part 'person.g.dart'; // 自动生成的代码将放在这里

abstract class Person implements Built<Person, PersonBuilder> {
  // 静态方法返回序列化器
  static Serializer<Person> get serializer => _$personSerializer;

  // 必填字段
  int get id;

  // 可选字段
  @nullable
  int get age;

  // 使用 @BuiltValueField 注解映射 JSON 字段名
  @nullable
  @BuiltValueField(wireName: 'first_name')
  String get firstName;

  // 可选字段，使用 BuiltList 表示不可变列表
  @nullable
  BuiltList<String> get hobbies;

  // 私有构造函数
  Person._();

  // 工厂构造函数，用于创建新实例或更新现有实例
  factory Person([void Function(PersonBuilder) updates]) = _$Person;
}

生成代码

在项目根目录下运行以下命令以生成代码：

flutter pub run build_runner build

这将为 Person 类生成必要的代码，并保存在 person.g.dart 文件中。

使用 Person 类

接下来，我们可以在应用程序中使用 Person 类来进行序列化和反序列化操作。

创建和序列化 Person 对象

import 'package:built_value/json_serializable.dart';
import 'models/person.dart';
import 'serializers.dart'; // 包含所有序列化器的文件

void main() {
  final person = Person((b) => b
    ..id = 12345
    ..age = 35
    ..firstName = "Jimmy"
    ..hobbies.replace(BuiltList<String>(["jumping", "basketball"]))
  );

  // 将 Person 对象转换为 JSON 字符串
  final jsonString = jsonEncode(person, serializers: serializers);
  print(jsonString);
}

反序列化 JSON 字符串为 Person 对象

import 'dart:convert';
import 'models/person.dart';
import 'serializers.dart'; // 包含所有序列化器的文件

void main() {
  final jsonString = '{"id":12345,"age":35,"first_name":"Jimmy","hobbies":["jumping","basketball"]}';

  // 将 JSON 字符串转换为 Person 对象
  final dynamicMap = jsonDecode(jsonString);
  final person = serializers.deserializeWith(Person.serializer, dynamicMap);
  print(person);
}

定义序列化器

为了使上述代码正常工作，还需要定义一个包含所有序列化器的文件 serializers.dart：

import 'package:built_value/serializer.dart';
import 'package:built_value/built_value.dart';
import 'package:built_collection/built_collection.dart';
import 'models/person.dart';

part 'serializers.g.dart';

@SerializersFor(const [
  Person,
  // 如果有其他需要序列化的类也添加到这里
])
final Serializers serializers = _$serializers;

然后再次运行 flutter pub run build_runner build 来生成 serializers.g.dart 文件。

总结

通过以上步骤，我们可以轻松地使用 built_value 插件来创建不可变的数据模型，并实现这些模型与 JSON 数据之间的相互转换。这对于构建高效且易于维护的应用程序非常有用。希望这个指南对你有所帮助！如果你有任何问题或需要进一步的帮助，请随时提问。