跨平台开发 / 系统课时
手写 fromJson 和 toJson
手写 fromJson 和 toJson
本篇解决 Flutter 项目中 JSON 数据和 Dart 对象之间转换的问题。通过手写 fromJson 与 toJson,理解模型解析的核心流程,并能够控制接口字段和应用对象之间的映射关系。
学习目标
- 掌握使用
Map<String, dynamic>创建 Dart 模型对象。 - 理解
fromJson和toJson的输入输出方向。 - 能编写简单可靠的数据模型转换代码。
fromJson 和 toJson 的职责
接口返回 JSON 后,应用通常需要把动态数据转换成业务对象,这个过程叫反序列化,对应 fromJson。
当应用需要提交数据给服务器时,又需要把对象转换回 JSON,这个过程叫序列化,对应 toJson。
两者方向相反:
| 方法 | 输入 | 输出 | 使用场景 |
|---|---|---|---|
fromJson |
Map<String, dynamic> |
Dart 对象 | 读取接口响应 |
toJson |
Dart 对象 | Map<String, dynamic> |
提交请求参数 |
创建一个数据模型
假设接口返回用户信息:
json
{
"id": 1,
"name": "Alice",
"email": "alice@example.com"
}可以创建对应模型:
dart
class User {
final int id;
final String name;
final String email;
User({
required this.id,
required this.name,
required this.email,
});
factory User.fromJson(Map<String, dynamic> json) {
return User(
id: json['id'] as int,
name: json['name'] as String,
email: json['email'] as String,
);
}
Map<String, dynamic> toJson() {
return {
'id': id,
'name': name,
'email': email,
};
}
}这个模型完成了 JSON 与 Dart 对象之间的双向转换。
验证模型转换结果
下面示例展示如何创建对象,再转换回 JSON。
dart
void main() {
final json = {
'id': 1,
'name': 'Alice',
'email': 'alice@example.com',
};
final user = User.fromJson(json);
final result = user.toJson();
print(result);
}预期输出:
text
{id: 1, name: Alice, email: alice@example.com}处理可选字段和类型转换
真实接口经常存在字段缺失或类型变化。例如昵称可能不存在:
json
{
"id": 1,
"name": "Alice"
}模型应该允许字段为空:
dart
class User {
final int id;
final String name;
final String? email;
User({
required this.id,
required this.name,
this.email,
});
factory User.fromJson(Map<String, dynamic> json) {
return User(
id: json['id'] as int,
name: json['name'] as String,
email: json['email'] as String?,
);
}
}如果接口字段可能变化,直接强制转换可能导致异常,需要根据业务情况增加默认值或校验逻辑。
手写转换的适用边界
手写 fromJson 和 toJson 适合模型数量较少、字段关系简单的项目,也适合学习 JSON 解析原理。
当项目包含大量接口模型时,通常会使用代码生成工具自动生成转换代码。但无论是否自动生成,理解转换过程仍然重要,因为字段映射错误、空值处理和嵌套模型问题最终都需要人工判断。
按自己的节奏,确认真正理解。