跨平台开发 / 系统课时

生成 fromJson 与 toJson

生成 fromJson 与 toJson

json_serializable 的核心不是让业务代码直接读写 Map,而是让模型只声明字段与两个入口,再由生成器补齐解析和输出逻辑。本节用一个最小模型串起 part、工厂构造函数、生成函数与双向验证,并学会判断生成代码是否符合预期。

学习目标

  • 正确连接 part、fromJson 与 toJson,让生成代码进入同一个 Dart library。
  • 读懂生成文件如何从 JSON 取值,以及如何把模型字段写回 Map<String, dynamic>。
  • 用一次 JSON → 模型 → JSON 的往返测试验证常规字段映射。

把模型接到生成函数

假设项目已经把 json_annotation 放入 dependencies,并把 build_runner、json_serializable 放入 dev_dependencies。片段示例:下面是完整的 lib/models/user.dart,它依赖这些包,并通过后续构建命令生成配套文件:

dart
import 'package:json_annotation/json_annotation.dart';

part 'user.g.dart';

@JsonSerializable()
class User {
  const User({
    required this.id,
    required this.displayName,
    required this.active,
  });

  final String id;
  final String displayName;
  final bool active;

  // 解析入口委托给生成函数,模型本身不手写字段读取。
  factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);

  // 输出入口同样委托给生成函数,避免手写键名时遗漏字段。
  Map<String, dynamic> toJson() => _$UserToJson(this);
}

part 'user.g.dart'; 表示生成文件与当前文件属于同一个 library,因此当前文件可以调用名字以下划线开头的 _$UserFromJson 和 _$UserToJson。生成器会处理带 @JsonSerializable() 的类型,并通过构建命令生成对应的 .g.dart 文件。([Dart packages][1])

生成并读懂 g.dart

在项目根目录运行:

bash
dart run build_runner build

预期结果:

text
退出码:0
生成文件:lib/models/user.g.dart

实际构建日志会因 build_runner 版本和缓存状态不同而变化,判断成功应以命令退出成功且 user.g.dart 已生成或更新为准。官方用法同样通过 dart run build_runner build 触发生成。([Dart packages][1])

片段示例:下面是 user.g.dart 中与本课模型对应的核心结构,它依赖前面的 user.dart,不应手工维护。

dart
part of 'user.dart';

User _$UserFromJson(Map<String, dynamic> json) => User(
      id: json['id'] as String,
      displayName: json['displayName'] as String,
      active: json['active'] as bool,
    );

Map<String, dynamic> _$UserToJson(User instance) => <String, dynamic>{
      'id': instance.id,
      'displayName': instance.displayName,
      'active': instance.active,
    };

_$UserFromJson 的读取方向是“JSON 键 → Dart 字段”,因此键存在但类型不符合声明时会在解析阶段失败。_$UserToJson 的方向相反,只从已经构造成功的模型读取字段并组装新的 Map。这也说明生成代码不是运行时反射,而是构建阶段生成的普通 Dart 代码。

验证双向转换

片段示例:创建 bin/check_user.dart,它依赖前面的 User 模型及已经生成的 user.g.dart,用固定输入做一次往返测试:

dart
import 'dart:convert';

import '../lib/models/user.dart';

void main() {
  final input = <String, dynamic>{
    'id': 'u-7',
    'displayName': 'Ada',
    'active': true,
  };

  final user = User.fromJson(input);
  final output = user.toJson();

  print('${user.id}|${user.displayName}|${user.active}');
  print(jsonEncode(output));
}

运行:

bash
dart run bin/check_user.dart

预期输出:

text
u-7|Ada|true
{"id":"u-7","displayName":"Ada","active":true}

这里验证的是常规字段的双向一致性:输入键能构造出正确类型的模型,模型再输出时仍得到相同的 JSON 键和值。以后增加字段时,应重新运行生成器,并同步补充测试,而不是直接编辑 .g.dart。

按自己的节奏,确认真正理解。

目录与阅读设置

记录一个想法

生成 fromJson 与 toJson

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通