Flutter序列化与反序列化插件jaguar_serializer的使用

Flutter序列化与反序列化插件jaguar_serializer的使用

概述

jaguar_serializer 是一个格式无关的序列化库，可以在 Dart VM、浏览器和 Flutter 中用于 JSON、MongoDB、PostgreSQL 等数据格式的序列化和反序列化。它允许开发者轻松地将模型对象与 Map<String, dynamic> 进行互转。

安装

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

# pubspec.yaml
dependencies:
  jaguar_serializer: ^x.x.x  # 替换为最新版本号

dev_dependencies:
  build_runner: ^x.x.x     # 替换为最新版本号
  jaguar_serializer_cli: ^x.x.x  # 替换为最新版本号

运行 pub get 或 flutter pub get 来安装依赖。

创建简单序列化器

1. 导入库
   引入 jaguar_serializer 库。

   import 'package:jaguar_serializer/jaguar_serializer.dart';
   

2. 定义模型类
   创建一个简单的用户模型类。

   /// 用户模型
   class User {
     String name;
     int age;
   
     User({this.name, this.age});
   }
   

3. 声明序列化器
   使用 [@GenSerializer](/user/GenSerializer)() 注解生成序列化器，并实现序列化逻辑。

   [@GenSerializer](/user/GenSerializer)()
   class UserJsonSerializer extends Serializer<User> with _$UserJsonSerializer {}
   

4. 包含生成的序列化器文件
   在文件顶部添加 part 声明，指定生成的序列化器文件路径。

   part 'user.jser.dart';
   

生成序列化器

运行以下命令生成序列化器代码：

pub run build_runner build

# 或在 Flutter 项目中运行：
flutter packages pub run build_runner build

此命令会在 user.jser.dart 文件中生成 $UserJsonSerializer 类。

使用序列化器

序列化器可以将模型对象与 Map<String, dynamic> 互相转换。以下是一个完整的示例：

import 'package:jaguar_serializer/jaguar_serializer.dart';
import 'model/user.dart';  // 导入用户模型

void main() {
  // 初始化序列化器
  final userSerializer = new UserJsonSerializer();

  // 反序列化：从 Map 转换为 User 对象
  User user = userSerializer.fromMap({
    'name': 'John',
    'age': 25,
  });

  print('反序列化结果: $user');

  // 序列化：从 User 对象转换为 Map
  Map<String, dynamic> map = userSerializer.toMap(user);
  print('序列化结果: $map');
}

输出结果：

反序列化结果: User(name: John, age: 25)
序列化结果: {name: John, age: 25}

使用 JSON 仓库

除了直接使用序列化器，还可以通过 JSON 仓库来管理多个序列化器。

import 'package:jaguar_serializer/jaguar_serializer.dart';
import 'model/user.dart';

void main() {
  // 初始化 JSON 仓库并注册序列化器
  final jsonRepository = new JsonRepo()..add(new UserSerializer());

  // 反序列化：从 JSON 字符串转换为 User 对象
  User user = jsonRepository.from<User>('{"name":"John","age": 25}');
  print('反序列化结果: $user');

  // 序列化：从 User 对象转换为 JSON 字符串
  String jsonStr = jsonRepository.serialize(user);
  print('序列化结果: $jsonStr');
}

输出结果：

反序列化结果: User(name: John, age: 25)
序列化结果: {"name":"John","age":25}

示例代码

以下是完整的示例代码，展示了如何使用 jaguar_serializer 处理复杂对象（如嵌套模型）。

import 'package:jaguar_serializer/jaguar_serializer.dart';

part 'example.jser.dart';

class Player {
  String name;
  String email;
  int score;
  List<Address> address;

  Player({this.name, this.email, this.score, this.address});

  String toString() => 'Player($name, $email, $score, $address)';
}

class Address {
  String street;
  String city;

  Address({this.street, this.city});

  String toString() => 'Address($street, $city)';
}

[@GenSerializer](/user/GenSerializer)()
class PlayerSerializer extends Serializer<Player> with _$PlayerSerializer {}

[@GenSerializer](/user/GenSerializer)()
class AddressSerializer extends Serializer<Address> with _$AddressSerializer {}

void main() {
  // 使用基本序列化器
  PlayerSerializer plSer = new PlayerSerializer();
  Player player = new Player(
      name: 'John',
      email: 'john@noemail.com',
      score: 1000,
      address: [(new Address(street: 'Skögsangavägen', city: 'Stockholm'))]);

  // 序列化：将 Player 对象转换为 Map
  final Map map = plSer.toMap(player);
  print('序列化结果: $map');

  // 反序列化：将 Map 转换回 Player 对象
  Player decoded = plSer.fromMap(map);
  print('反序列化结果: $decoded');
}

输出结果：

序列化结果: {name: John, email: john@noemail.com, score: 1000, address: [{street: Skögsangavägen, city: Stockholm}]}
反序列化结果: Player(John, john@noemail.com, 1000, [Address(Skögsangavägen, Stockholm)])