Flutter JSON序列化(FromJson和ToJson)详解(build_runner使用)

序列化方式

• 手动序列化和反序列化
• 通过代码生成自动序列化和反序列化

对于较小项目，使用代码生成器可能会过度。对于具有多个JSON model的复杂应用程序，手动序列化可能会比较重复，并会很容易出错。

①小项目手动序列化

• 使用dart:convert中内置的JSON解码器
• 将原始JSON字符串传递给JSON.decode() 方法，然后在返回的Map<String, dynamic>中查找所需的值
• 有外部依赖或其它的设置

②大中型项目中使用代码生成

• 通过外部库为您自动生成序列化模板
• 它需要一些初始设置，并运行一个文件观察器，从您的model类生成代码

使用代码生成序列化JSON

借助：json_serializable 和 build_runner、json_annotation 库实现

①添加依赖

dependencies:
  flutter:
    sdk: flutter
  # json生成
  json_annotation: ^2.2.0

dev_dependencies:
  flutter_test:
    sdk: flutter
  build_runner: ^1.3.0
  json_serializable: ^2.2.0

②创建model类

JSON 实例

{
  "list1": [
    {
      "XMMC": "晶泽·云玺(一期)",
      "XMDZ": "南湖生态城B-05地块",
      "PIC": "../../images/xmimg/b72c1ecd-2f0b-46a0-b226-2440817e9f4d-20180607093242.jpg"
    }
  ]
}

为了便利使用 json_serializable库

• 复杂的格式可能会有问题，需要自己斟酌

import 'package:json_annotation/json_annotation.dart';

part 'newhouse.g.dart';


@JsonSerializable()
class newhouse extends Object {

  @JsonKey(name: 'list1')
  List<List1> list1;

  newhouse(this.list1,);

  factory newhouse.fromJson(Map<String, dynamic> srcJson) => _$newhouseFromJson(srcJson);

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

}


@JsonSerializable()
class List1 extends Object {

  @JsonKey(name: 'XMMC')
  String xMMC;

  @JsonKey(name: 'XMDZ')
  String xMDZ;

  @JsonKey(name: 'PIC')
  String pIC;

  List1(this.xMMC,this.xMDZ,this.pIC,);

  factory List1.fromJson(Map<String, dynamic> srcJson) => _$List1FromJson(srcJson);

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

}

③生成序列化模板

3.1一次性生成

• 根目录下运行flutter packages run build_runner build --delete-conflicting-outputs，我们可以在需要时为我们的model生成json序列化代码
• 虽然这非常方便，但如果不需要每次在model类中进行更改时都要手动运行构建命令会更好

3.2持续生成

• 使用watcher可以使我们的源代码生成的过程更加方便。它会监视我们项目中文件的变化，并在需要时自动构建必要的文件
• 通过flutter packages pub run build_runner watch在项目根目录下运行来启动watcher
• 只需启动一次观察器，然后并让它在后台运行

④使用json_serializable模型

• 反序列化(decode)

Map houseMap = json.decode(json);
var house = new newhouse.fromJson(houseMap);

• 序列化(encode)

String json = JSON.encode(house );