跨平台开发 / 系统课时

组合 Freezed 与 JSON

组合 Freezed 与 JSON

Freezed 负责不可变模型、copyWith 和值比较,json_serializable 负责 JSON 映射。把两者接入同一个模型后,只需维护一份字段定义,就能同时获得 fromJson、toJson、不可变更新和结构化相等判断。

学习目标

  • 能定义同时支持 Freezed 与 JSON 序列化的模型
  • 理解 .freezed.dart 与 .g.dart 两个生成文件的职责
  • 能验证反序列化、序列化、copyWith 和值比较同时生效

一份模型串起两套生成能力

假设源文件叫 user.dart。组合使用时需要声明两个 part:user.freezed.dart 保存 Freezed 生成的不可变模型相关代码,user.g.dart 保存 json_serializable 生成的 JSON 转换代码。

dart
import 'dart:convert';

import 'package:freezed_annotation/freezed_annotation.dart';

part 'user.freezed.dart';
part 'user.g.dart';

@freezed
abstract class User with _$User {
  const factory User({
    required int id,
    required String name,
    String? email,
  }) = _User;

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

void main() {
  final user = User.fromJson({
    'id': 7,
    'name': 'Ada',
    'email': null,
  });

  final updated = user.copyWith(name: 'Ada Lovelace');
  final sameValue = updated ==
      const User(id: 7, name: 'Ada Lovelace', email: null);

  print(jsonEncode(user.toJson()));
  print(updated.name);
  print(sameValue);
}

预期输出:

text
{"id":7,"name":"Ada","email":null}
Ada Lovelace
true

User.fromJson 的入口写在源文件中,但字段解析逻辑由生成代码完成;copyWith、值比较和具体实现类等能力则来自 Freezed。业务代码只使用公开的 User API,不应直接编辑任何生成文件。

Freezed 与 JSON 代码生成关系

依赖与生成文件的职责

项目通常把运行时注解包放在 dependencies,把代码生成器放在 dev_dependencies。下面是 pubspec.yaml 的片段示例,具体版本应使用项目当前兼容的版本。

yaml
dependencies:
  freezed_annotation: <VERSION>
  json_annotation: <VERSION>

dev_dependencies:
  build_runner: <VERSION>
  freezed: <VERSION>
  json_serializable: <VERSION>

这段配置的作用不是生成第三套模型,而是让两个生成器围绕同一个 Dart 类协作。完成项目既有的代码生成流程后,可以检查源文件同目录是否出现 user.freezed.dart 和 user.g.dart,并由 Dart 分析器确认两个 part 都能正常解析。

fromJson 为什么是关键入口

在 Freezed 模型中声明 factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);,会把该模型接入 JSON 代码生成链路。生成完成后,模型既可以通过 User.fromJson 从接口数据创建实例,也可以调用 toJson 转回可编码的数据结构。

.freezed.dart 和 .g.dart 都属于派生文件。字段增删、类型修改和默认值调整应该发生在 user.dart 中,再重新运行生成流程,而不是直接修改生成结果,否则下一次生成会覆盖手工改动。

四项能力如何一起验证

组合完成后可以沿一条数据链检查全部能力:先用 fromJson 把 Map<String, dynamic> 转成 User,再用 copyWith 创建修改后的新实例,然后用 toJson 转回 JSON,并用 == 验证两个字段值相同的 Freezed 对象是否相等。上面的主示例已经同时覆盖这四项能力。

如果模型只负责简单 JSON 映射,并不需要不可变更新和值比较,单独使用 json_serializable 就可能足够;当接口模型还会进入状态管理层并频繁产生新状态时,把 Freezed 与 JSON 生成链路组合起来,可以显著减少重复样板代码。

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

目录与阅读设置

记录一个想法

组合 Freezed 与 JSON

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

登录哪都通