一、配置依賴

1. 在pubspec.yaml中添加必要的依賴：

dependencies:
  flutter:
    sdk: flutter
  json_annotation: ^4.8.1  # 提供必要的注解
 
dev_dependencies:
  build_runner: ^2.4.6     # 代碼生成工具
  json_serializable: ^6.7.1 # 序列化代碼生成器

2. 配置完依賴后，執(zhí)行 flutter pub get

二、 使用

1. 定義一個模型類

import 'package:json_annotation/json_annotation.dart';
 
part 'user.g.dart';

@JsonSerializable()  // 表示這個類需要生成序列化代碼
class User {
  final String name;
  final String name;
  final int age;
  
  User({
    required this.name,
    required this.email
  });
  
  factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);
  
  Map<String, dynamic> toJson() => _$UserToJson(this)
}

代碼解釋如下：
@JsonSerializable()注解告訴生成器需要為這個類生成序列化代碼
user.g.dart文件是自動生成的
需要實現(xiàn)序列化與反序列化函數(shù)

2. 在根目錄，執(zhí)行flutter pub run build_runner build
   這個命令會：
   掃描項目中所有被@JsonSerializable()注解的類
   為每個類生成對應的xxx.g.dart文件
   還會生成序列化和反序列化實現(xiàn)

三、 一些使用配置

3.1 @JsonKey 的簡單使用

  @JsonKey(name: 'user_name') // 自定義JSON字段名
   final String name;

  @JsonKey(ignore: true) // 忽略此字段，不參與序列化
   final int age;

  @JsonKey(defaultValue: 'unknown') // 默認值
     final String statuc;

 @JsonKey(includeIfNull: false) // 為null時不包含在JSON中
 final String token;

  @JsonKey(fromJson: _parseBalance, toJson: _stringifyBalance) // 自定義轉換
  final double balance;

 static double _parseBalance(String json) => double.parse(json);
  static String _stringifyBalance(double balance) => balance.toStringAsFixed(2);

3.2 @JsonKey 枚舉的支持

enum UserType {
  @JsonValue('admin')
  admin,
  @JsonValue('editor')
  editor,
  @JsonValue('viewer')
  viewer,
  @JsonValue('guest')
  guest
}

3.3 范型的支持