Dart Academy · 课时

json_serializable 实战

Q: 「json_serializable 实战」这节课中我会学到什么？

自动生成模型序列化代码 你通过在浏览器中直接运行的动手代码来练习 Dart Academy，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

自动生成模型序列化代码

json_serializable 实战 是 CoddyKit 上的免费 Dart Academy 课时。这是第 4 节课，共 4 节。你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。这是 Dart Academy 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 Dart Academy 课程共包含 4 节课。

JSON 样板代码问题

手动编写 fromJson 和 toJson 既繁琐又容易出错。JSON 序列化器软件包可以根据模型为您生成这两者。📦

添加软件包

您需要将 JSON 注解作为普通依赖添加，同时将 JSON 序列化器和构建运行器作为用于生成代码的开发依赖。

dependencies:
  json_annotation: ^4.9.0

为类添加注解

请使用 @JsonSerializable 标记您的模型。此注解会告诉生成器为该类生成序列化代码。

@JsonSerializable()
class User {
  final String name;
  User(this.name);
}

声明部分文件

添加部分指令，让您的文件可以包含生成的辅助代码。其名称与您的文件名相对应，并以 .g.dart 作为后缀。

part 'user.g.dart';

连接 fromJson

添加一个转发到生成函数的工厂构造函数。_$UserFromJson 辅助函数会由构建器为您创建。

factory User.fromJson(Map<String, dynamic> j) =>
    _$UserFromJson(j);

连接 toJson

添加一个调用生成的写入函数的方法。_$UserToJson 辅助函数会将您的对象转换回 JSON 映射。

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

生成代码

运行一次构建运行器后，user.g.dart 文件就会出现，其中的两个辅助函数都已完整实现，可以直接使用。

dart run build_runner build

重命名 JSON 键

当接口字段名与您的 Dart 名称不同时，请使用 @JsonKey 进行映射。这样既能保持代码整洁，又能让 JSON 与服务器保持一致。

@JsonKey(name: 'full_name')
final String fullName;

提供默认值

您可以为缺失字段提供备用值。defaultValue 选项会在 JSON 中缺少相应键时填入指定值。

@JsonKey(defaultValue: 0)
final int score;

嵌套模型开箱即用

如果某个字段是另一个 @JsonSerializable 类，生成器会递归地将其序列化。处理嵌套对象无需额外操作。

像使用普通 Dart 一样使用

生成代码后，您可以通过普通的方法调用来解析和编码。生成的辅助函数会被隐藏，因此调用位置读起来很自然。

final u = User.fromJson(data);
final back = u.toJson();

快速检查

哪个注解会标记一个类，以便生成 JSON 代码？

回顾

使用 @JsonSerializable 添加注解，连接 fromJson 和 toJson，然后运行构建运行器。使用 @JsonKey 映射字段名称和默认值。🎉

常见问题解答

「json_serializable 实战」课时是免费的吗？

是的 — 「json_serializable 实战」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 Dart Academy 课程的其余内容，请升级到 CoddyKit PRO。 Dart Academy 课程共包含 4 节课。

「json_serializable 实战」这节课中我会学到什么？

自动生成模型序列化代码你通过在浏览器中直接运行的动手代码来练习 Dart Academy，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 Dart Academy 需要有经验吗？

无需任何先前经验。CoddyKit 上的 Dart Academy 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。这是第 4 节课，共 4 节。

「json_serializable 实战」课时需要多长时间？

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。

我能在这节 Dart Academy 课中编写并运行代码吗？

能。每节 Dart Academy 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

← 返回 Dart Academy