Flutter 中 JSON 的序列化和反序列化

前言

Flutter 中没有类似于 Java 中 Gson/Jackson 这样的 JSON 序列化库。
因为这些库都是通过反射实现的，而 Flutter 中不支持反射。
其实 Dart 是支持反射的，只是 Flutter 禁用了而已。
Flutter 在 release 版本中会去除没有使用的代码，优化包大小。由于反射默认应用到所有代码，所以如果支持反射的话，就没法判断反射代码有没有被使用了。

dart 中的 JSON 处理

dart 中的 JSON 处理用到了核心库 dart:convert。

import 'dart:convert';

jsonDecode() 用来把 JSON 转化为 Map 或 List
看一下官方提供的例子：

var jsonString = '''
  [
    {"score": 40},
    {"score": 80}
  ]
''';

var scores = jsonDecode(jsonString);
assert(scores is List);

var firstScore = scores[0];
assert(firstScore is Map);
assert(firstScore['score'] == 40);

jsonEncode() 用来把 Map 或 List 转化为 JSON
看一下官方提供的例子：

var scores = [
  {'score': 40},
  {'score': 80},
  {'score': 100, 'overtime': true, 'special_guest': null}
];

var jsonText = jsonEncode(scores);
assert(jsonText ==
    '[{"score":40},{"score":80},'
        '{"score":100,"overtime":true,'
        '"special_guest":null}]');

jsonDecode() 和 jsonEncode() 只支持 JSON 和 Map/List 之间的转换。如果要支持 JSON 和 Model 类之间的转换，需要自己实现方法去解析。
例如：

class User {
  final String name;
  final int age;

  User({this.name, this.age});

  User.fromJson(Map<String, dynamic> json)
      : name = json['name'],
        age = json['age'];

  Map<String, dynamic> toJson() => <String, dynamic>{
        'name': name,
        'age': age,
      };
}

JSON 简单还好，如果 JSON 复杂的话，编写解析代码既耗时又容易出错。幸运的是，官方提供了自动生成解析代码的库。

自动生成解析代码

json_serializable 就是官方提供的自动生成解析代码的库。
添加依赖：

dependencies:
  # 定义 json_serializable 库用到的一些注解
  json_annotation: 3.0.1

dev_dependencies:
  # 代码生成器
  build_runner: 1.10.0
  # 根据注解生成 Json 序列化和反序列化代码
  json_serializable: 3.3.0

代码生成的相关库不需要打包进 release 版本，所以添加到 dev_dependencies 下。

添加注解并指定生成的类名：

import 'package:json_annotation/json_annotation.dart';

part 'User.g.dart';

@JsonSerializable()
class User {
  final String name;
  final int age;

  User({this.name, this.age});
}

用 @JsonSerializable() 修饰的 Model 类表示需要 JSON 序列化，之后执行相关命令会自动生成代码。
part 指定自动生成的类的名称。

执行命令生成相关代码：
flutter pub run build_runner build
执行完命令可以看到 User.g.dart 被生成了，_$UserFromJson 方法和 _$UserToJson 方法分别为反序列化和序列化的代码。

接下来我们修改 Model 类直接调用生成的代码：

import 'package:json_annotation/json_annotation.dart';

part 'User.g.dart';

@JsonSerializable()
class User {
  final String name;
  final int age;

  User({this.name, this.age});

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

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

当 Model 类有改动时，需要重新执行上述命令生成相关代码。
如果需要持续观察 Model 类的改动自动生成相应代码，可以执行如下命令：
flutter pub run build_runner watch
只需启动一次 watcher，它就会在后台运行，一旦 Model 类有改动，就会生成相应代码。

最后编辑于：2020.07.28 09:33:10