跨平台开发 / 系统课时
用 json_serializable 生成解析代码
用 json_serializable 生成解析代码
本篇解决 Flutter 模型手写序列化代码重复、字段变更容易遗漏的问题。通过配置 json_serializable 代码生成工具,让 Dart 模型自动生成 fromJson 和 toJson 方法,同时保持模型定义清晰可维护。
学习目标
- 理解 json_serializable 解决的序列化问题和生成机制
- 掌握 Flutter 项目中接入代码生成依赖的方法
- 能够创建模型并生成、使用解析代码
为什么需要代码生成
网络接口返回 JSON 后,通常需要转换成 Dart 对象。手写解析代码虽然简单,但随着字段增加、嵌套对象变多,会出现大量重复代码。
json_serializable 通过读取模型上的注解,根据字段定义生成对应代码。开发者只维护模型结构,序列化细节交给生成器处理。
配置 json_serializable 环境
在 Flutter 项目的 pubspec.yaml 中添加运行时依赖和开发依赖。
yaml
dependencies:
flutter:
sdk: flutter
json_annotation: ^4.9.0
dev_dependencies:
build_runner: ^2.4.0
json_serializable: ^6.8.0添加依赖后执行安装:
bash
flutter pub get预期结果
text
Resolving dependencies...
Got dependencies!json_annotation 提供模型注解,json_serializable 负责生成代码,build_runner 负责执行生成流程。
创建可生成的模型
假设接口返回用户数据:
json
{"id":1,"name":"Alice"}创建 Dart 模型文件 user.dart:
dart
import 'package:json_annotation/json_annotation.dart';
part 'user.g.dart';
@JsonSerializable()
class User {
final int id;
final String name;
User({required this.id, required this.name});
factory User.fromJson(Map<String, dynamic> json) =>
_$UserFromJson(json);
Map<String, dynamic> toJson() => _$UserToJson(this);
}part 指向生成文件,_$UserFromJson 和 _$UserToJson 不需要手写,它们会由生成器创建。
生成并验证代码
执行代码生成命令:
bash
dart run build_runner build预期结果
text
[INFO] Generating build script completed
[INFO] Succeeded after <TIME>生成完成后,项目中会出现 user.g.dart 文件,其中包含 JSON 转换逻辑。
使用模型解析接口数据:
dart
final json = {'id': 1, 'name': 'Alice'};
final user = User.fromJson(json);
print(user.name);预期结果
text
Alice生成代码的使用边界
代码生成适合字段稳定、模型数量较多的项目。它可以减少重复代码,但不能替代接口数据校验。
当后端字段经常变化,或者需要复杂转换逻辑时,可以在模型层增加自定义处理,例如自定义转换函数或手写部分解析逻辑。
使用 json_serializable 后,模型文件成为数据结构的唯一维护入口,能够降低网络层和业务层之间的数据转换成本。
按自己的节奏,确认真正理解。