flutter中老生常谈的json序列化操作json_serializable和json_annotation以及插件使用

dart pub add dev:json_serializable

dart pub add json_annotation

{
  "user_id" : "1234",
  "nick_name" : "Tom",
  "age": 1,
  "right": {
    "vip" : 1
  }
}

import 'package:json_annotation/json_annotation.dart';

// 1. 一定要加一个文件引入，这个part引入的.g.dart文件是在后面的dart命令中生成的，而且和class在同一个目录中。
part 'right.g.dart';

// 2. 需要添加 @JsonSerializable()
@JsonSerializable()
class Right {
  final int? vip;

  Right({
    this.vip,
  });

  // 3. 下面的2个方法需要手动写上，_$RightFromJson和_$RightToJson是在后面的dart命令中生成的，暂时的语法报错，先不要管。（前缀都是默认你的class名字的首字母大写驼峰写法：Right， 后缀统一为fromJson和toJson）
  factory Right.fromJson(Map<String, dynamic> json) =>
      _$RightFromJson(json);

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

import 'package:json_annotation/json_annotation.dart';
import 'package:xxx/modules/app/beans/right.dart';

// 1. 声明后续dart命令会生成的文件
part 'user.g.dart';

// 2. 需要添加 @JsonSerializable()
@JsonSerializable()
class User {
  // 3. 使用别名，那么要使用@JsonKey去声明原始json中的字段
  @JsonKey(name: "user_id")
  final String? userId;

  @JsonKey(name: "nick_name")
  final String? nickName;

  final int? age;
  // 4. 权益class
  final Right? right;

  User({
    this.userId,
    this.nickName,
    this.age,
    this.right,
  });

  // 5. fromJson和toJson方法
  factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);

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

...
final res = response as Map<String, dynamic>?;
if (res == null) return null;
final user = User.fromJson(res);
...

dart run build_runner build

...
// 1. 在JsonKey中设置这2个属性为false，表示这个字段不需要从json数据中转，也不需要从class中转的Map中。
// 2. 这里不用final声明，表示user这个class的isSelected字段可以在使用时进行修改。
@JsonKey(includeFromJson: false, includeToJson: false)
bool isSelected = true;
...

{
  "user_id" : "1234",
  "nick_name" : "Tom",
  "age": 1,
  "right": {
    "vip" : 1
  },
  # 这里比user信息多一个字段
  "visit_count" : 3
}

// 1. 必须引入user class
import 'package:xxx/modules/app/beans/user.dart';
// 2. 这个文件虽然没有用到right class，但是也必须引入。
// 否则dart命令将找不到嵌套的right的class声明。
import 'package:xxx/modules/app/beans/right.dart';

// 3. 同样需要引入后续命令生成的.g.dart
part 'visitor.g.dart';

// 4. 这里需要extends user
@JsonSerializable()
class Visitor extends User {
  @JsonKey(name: "visit_count")
  final int? visitCount;

  Visitor(this.visitCount);

  // 5. 依然需要from json 和 to json方法
  factory Visitor.fromJson(Map<String, dynamic> json) =>
      _$VisitorFromJson(json);

  @override
  Map<String, dynamic> toJson() => _$VisitorToJson(this);
}