Flutter学习笔记--JSON与序列化，自动生成json_serializable的方式model类

数据模型的JSON序列化，是大部分网络请求的基础，所以，我感觉还是先写这部分的帖子比较合适。

官方的文档中是推荐使用两种方法：

一种是手动序列化，其中的fromJson和toJson需要自己写

class Person{
    final String name;
    final int age;

    Person(this.name,this.age);

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

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

其中反序列化可以直接使用fromJson方法就可以了，而序列化时不需要使用toJson方法，直接使用JSON.encode就可以了。
如果是使用这第一种方法，建议找个插件，比如FlutterJsonBeanFactory，或者自己写一个插件或者脚本。

另一种是生成序列化，使用的是json_serializable package，注意在pubspec.yaml文件中导入库需要加上三行，版本号可能过期了，只能请自己去pub上查了。

dependencies:
  # Your other regular dependencies here
  # json_serializable helper
  json_annotation: ^2.0.0

dev_dependencies:
  # Your other dev_dependencies here
  # 创建.g文件的
  build_runner: ^1.0.0 
  # 序列化json
  json_serializable: ^2.0.0

这样之后就可以创建model文件了，比如刚刚上面那个Person类就可以变成

import 'package:json_annotation/json_annotation.dart';

part 'person_model.g.dart';

@JsonSerializable()
class Person {
  
  final String name;

  final int age;

  Person(this.name, this.age);

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

  Map<String, dynamic> toJson(Person instance) => _$PersonToJson(instance);
  
}

当然如果靠手写这样一个类，其实也是挺费时费神的（其实就是傻，一旦写错写漏了某些代码，根本生成不出.g文件），所以大佬给我们提供了又一个偷懒的插件AutoJson，

生成json.gif

其中千万别忘记了是需要生成一个构造函数的，切记，切记。

这样我们就可以通过flutter packages pub run build_runner build或者flutter packages pub run build_runner watch命令来生成.g文件了，第一个命令是一次性的，而第二个是持续的，这样我们选哪个就很明确了，Model文件一般都是在开发过程中陆续添加的，还是用第二个比较省心。

而第二种方法生成的Json文件的用法其实是和第一种一样的，反序列化用fromJson，序列化用JSON.encode。

接下来就是实际工程中的Model对象的使用，一般来说实际工程中，在业务Model都是需要包在一个基类Model中的，而基类Model中除了业务Model字段，还需要诸如status、msg、code之类的字段，用来记录请求的状态。在Android中这个很好实现，直接泛型解析就可以了，但恭喜你，json_serializable是不支持的。

那既然泛型不支持，那我们可以再写一个既继承基类Model，又包含业务Model的新Model

class PersonBoxModel extends BaseModel {
    // Person是实际业务Model，上面已经写了，不再写了
    Person data;
    PersonBoxModel (this.data) : super(0, '',0);

    factory PersonBoxModel .fromJson(Map<String, dynamic> json) => 
                _$PersonBoxModelFromJson(json);
    Map<String, dynamic> toJson() => _$PersonBoxModelToJson(this);
}

import 'package:json_annotation/json_annotation.dart';

part 'base_response.g.dart';

@JsonSerializable()
class BaseModel extends Object {
  @JsonKey(name: 'code')
  int code;

  @JsonKey(name: 'msg')
  String msg;

  @JsonKey(name: 'status')
  int status;

  BaseModel (
    this.code,
    this.msg,
    this.status,
  );

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

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

至此我们就可以像Android中一样使用Model了。

追加：在生成.g文件过程中出现pub finished with exit code 78或者because the.dart_tool/build folder was deleted, or you are submitting generated files to your source repository时
执行命令

flutter packages pub run build_runner clean
flutter packages pub run build_runner build --delete-conflicting-outputs

最后编辑于：2019.06.27 11:14:51