Flutter 自定义序列化并生成

Posted on Edited on Views:

json model定义的时候，定义了一个必须型，但是服务端返回的时候，这个字段是null，这个时候，如果直接序列化，就会报错。在freezed中，如何利用自动生成功能，又能手动解决这个问题呢？

o1 grok3 claude 3.7
❌ ✅ ❌

竟然是 grok3 直接找出了这个答案，o1 试了很多次都没有，即便是你给它提示它都还不太理解，claude 3.7 第一时间也没给这个答案，但是你给它提示它就理解了。神奇（不过文章都是o1来总结的😂）

一句话总结：

@JsonSerializable(explicitToJson: true, genericArgumentFactories: true)

JP

以下は、FreezedFreezed + 泛型はんけい（ジェネリックgeneric）の場面ばめんで、 fromJson に独自どくじロジックを挿入そうにゅうしながら .g.dart ファイルファイルを正常せいじょうに生成せいせいする方法ほうほうについての 完全かんぜんなまとめまとめ です：

背景はいけい

FreezedFreezed でジェネリックgenericを含ふくむ実体じったいクラスclassを定義ていぎするときは、通常つうじょうこんな書かき方かたをしますします：

@freezed
class MyResponse<T> with _$MyResponse<T> {
  const factory MyResponse({
    // ...
  }) = _MyResponse<T>;

  factory MyResponse.fromJson(
    Map<String, dynamic> json,
    T Function(Object?) fromJsonT,
  ) => _$MyResponseFromJson(json, fromJsonT);
}

そのあと build_runnerビルドランナー を使つかうと、 my_response.g.dart ファイルファイル（ _$MyResponseFromJson などを含ふくむ）を自動的じどうてきに生成せいせいしてくれます。

しかし、ときどきビジネスbusinessロジック（検証けんしょう、補完ほかん、ログログの出力しゅつりょく、エラーエラー処理しょりなど）を反序列化はんじょれつかの際さいに追加ついかしたい場合ばあいがありますあります。もし fromJson を直接ちょくせつこんな風ふうに書かき換かえると：

factory MyResponse.fromJson(
  Map<String, dynamic> json,
  T Function(Object?) fromJsonT,
) {
  // ここで JSON を先に処理して、
  // 自動生成された反序列化関数に渡したい
  return _$MyResponseFromJson(json, fromJsonT);
}

このこのとき、 FreezedFreezed や内部ないぶの json_serializable がコードコードの生成せいせいに失敗しっぱいする可能性かのうせいが出でてきます。
解決かいけつ策さく ： 対象たいしょうのクラスclassに @JsonSerializable(explicitToJson: true, genericArgumentFactories: true) を加くわえて、正しいただ関数かんすうシグネチャsignatureと引数ひきすうの順序じゅんじょを保たもちましょう。

なぜなぜこのアノテーションannotationで上手うまくいくのか？

  • @JsonSerializable(genericArgumentFactories: true)
    これは内部ないぶの json_serializable および FreezedFreezed に：

    1. 「汎用はんよう（ジェネリックgeneric）を反序列化はんじょれつかするためための工場こうじょう関数かんすうが必要ひつようだ」
      → T Function(Object?) fromJsonT のようような形かたちのシグネチャsignatureを対応たいおうできるようにするする。
    2. 「このクラスclassは追加ついかの処理しょりが必要ひつような型かたを含ふくむ」

  • explicitToJson: true
    主おもに toJson の際さい、ネストされたオブジェクトobjectにも明示的めいしてきに toJson() を呼よぶよう指示しじしてくれます。そうしないと、単純たんじゅんにインスタンスinstanceを放ほうり込こむだけで不完全ふかんぜんなシリアライズserializationになる事ことがあります。

この2つのパラメータparametersを両方りょうほうオンにしておくことで、 fromJson の大括弧だいかっこ+独自どくじロジックという書かき方かたにも対応たいおうできるようになり、大括弧だいかっこと追加ついかロジックを理由りゆうにコードコードが生成せいせいできなくなる問題もんだいが解消かいしょうされます。

正ただしい例れい

@JsonSerializable(explicitToJson: true, genericArgumentFactories: true)
@freezed
class xxxProjectResponse<T> with _$xxxProjectResponse<T> {
  const factory xxxProjectResponse({
    // 定义字段...
  }) = _xxxProjectResponse<T>;

  factory xxxProjectResponse.fromJson(
    Map<String, dynamic> json,
    T Function(Object?) fromJsonT,
  ) {
    // ここで独自ロジックを挿入
    if (!json.containsKey('datas')) {
      json['datas'] = {"item": []};
    }
    return _$xxxProjectResponseFromJson(json, fromJsonT);
  }
}

そのあと、

flutter pub run build_runner build

を実行じっこうすれば xxx_project_response.g.dart が正常せいじょうに生成せいせいされ、 _$xxxProjectResponseFromJson / _$xxxProjectResponseToJson 関数かんすうなどが含ふくまれています。

重要じゅうようポイントpointまとめ

  1. fromJson のシグネチャsignatureは自動生成じどうせいせいの要件ようけんに合致がっちさせる
  2. @JsonSerializable(explicitToJson: true, genericArgumentFactories: true) を付与ふよする
  3. 「追加ついかロジック」を _$xxxProjectResponseFromJson の中なかには直接ちょくせつ書かかない
  4. もし fromJson を波括弧なみかっこにしたくない場合ばあいは、矢印やじるし（アローarrowシンタックスsyntax）のままにしておき、別べつの静的せいてきメソッドmethodで包つつむ
  5. もし完全かんぜんに fromJson / toJson を手書てがきしたいなら、 @Freezed(fromJson: false, toJson: false) ににして自力じりきで書かく

結論けつろん

  • FreezedFreezed + ジェネリックgeneric + 手動しゅどう修正しゅうせいした fromJson という場面ばめんで：

    • @JsonSerializable(explicitToJson: true, genericArgumentFactories: true) を付つけ、
    • シグネチャsignature / 引数ひきすうを既定きていどおりに揃そろえる
    • 大括弧だいかっこの中なかで独自どくじの処理しょりを追加ついかし、最後さいごに _$XXXFromJson(...) を呼よぶ

  • そうすれば、自分じぶんのロジックlogicを挿入そうにゅうしつつも、コードコード 生成せいせいを正常せいじょうに継続けいぞくできるようになります。

CN

以下是一份关于在 Freezed + 泛型 场景下，如何在 fromJson 中插入自定义逻辑、并确保 .g.dart 文件正常生成的完整总结：

背景

在使用 Freezed 来定义一个带泛型的实体类时，通常我们会这样写：

@freezed
class MyResponse<T> with _$MyResponse<T> {
  const factory MyResponse({
    // ...
  }) = _MyResponse<T>;

  factory MyResponse.fromJson(
    Map<String, dynamic> json,
    T Function(Object?) fromJsonT,
  ) => _$MyResponseFromJson(json, fromJsonT);
}

然后通过 build_runner 会自动生成 my_response.g.dart 文件（其中包括 _$MyResponseFromJson 等方法）。

但有时我们需要在反序列化时插入一些业务逻辑（例如：检查、补全、打印日志、异常处理等）。如果我们直接把 fromJson 写成：

factory MyResponse.fromJson(
  Map<String, dynamic> json,
  T Function(Object?) fromJsonT,
) {
  // 我想在这里先处理一波 JSON
  // 再把它交给自动生成的反序列化函数
  return _$MyResponseFromJson(json, fromJsonT);
}

就有可能导致 Freezed 或底层的 json_serializable 生成代码失败。
解决方法：给该类添加 @JsonSerializable(explicitToJson: true, genericArgumentFactories: true)，并且保持正确的函数签名和参数顺序。

为什么会失败？

  • 当我们开启了 genericArgumentFactories: true，生成器就必须帮“泛型”生成对应的反序列化方法签名（带 T Function(Object?) fromJsonT）。
  • Freezed（基于 json_serializable）对 fromJson 的解析十分严格：
    1. 函数签名必须符合预期（包括参数名称、类型、顺序）。
    2. 如果不是箭头函数而是大括号，生成器默认会“先读”我们手写的逻辑，再结合自动逻辑，看是否能完美拼装。稍有不一致，就会导致解析失败。

加上 @JsonSerializable(explicitToJson: true, genericArgumentFactories: true) 可以让 json_serializable 知道这个类在序列化时需要对泛型和嵌套对象进行处理，也允许我们在 fromJson 里写大括号并添加手动处理，不会破坏生成器对签名的识别。

正确示例

import 'package:freezed_annotation/freezed_annotation.dart';

part 'xxx_project_response.freezed.dart';
part 'xxx_project_response.g.dart';

// 核心：在类上加这个注解
@JsonSerializable(explicitToJson: true, genericArgumentFactories: true)
@freezed
class xxxProjectResponse<T> with _$xxxProjectResponse<T> {
  const factory xxxProjectResponse({
    // 定义字段...
  }) = _xxxProjectResponse<T>;

  // fromJson 大括号版本
  factory xxxProjectResponse.fromJson(
    Map<String, dynamic> json,
    T Function(Object?) fromJsonT,
  ) {
    // 在这里插入自定义逻辑
    if (!json.containsKey('datas')) {
      json['datas'] = {"item": []};
    }
    return _$xxxProjectResponseFromJson(json, fromJsonT);
  }
}

然后执行

flutter pub run build_runner build

就能正常生成 xxx_project_response.g.dart，并包含 _$xxxProjectResponseFromJson、_$xxxProjectResponseToJson 等方法。

关键点总结

  1. @JsonSerializable(genericArgumentFactories: true) 必须有

    • 告诉生成器要为泛型 T 生成（反）序列化所需的工厂函数。
    • 没有这个，带泛型的 fromJson 往往会引起冲突或直接失败。

  2. @JsonSerializable(explicitToJson: true) 一般也推荐

    • 保证嵌套对象也会自动调用它们的 toJson()，而不是直接把对象插入到 JSON 中。
    • 特别是当你的泛型类型或其他字段包含更多可序列化对象时，很有必要。

  3. fromJson 的函数签名和 _...FromJson 必须一致

    • 保证：factory MyResponse.fromJson(Map<String, dynamic> json, T Function(Object?) fromJsonT)
    • 保持这两个参数，且名字、类型不能乱改。
    • 最后 return _$MyResponseFromJson(json, fromJsonT); 调用自动生成的函数。

  4. 如果你不想在 fromJson 里加大括号，也可以先保留箭头函数，让生成器把 _$FromJson 生成好，然后你再创建一个新的静态方法来做处理：

    static MyResponse<T> fromJsonWithLog<T>(
  Map<String, dynamic> json,
  T Function(Object?) fromJsonT,
) {
  print('json: $json');
  return MyResponse<T>.fromJson(json, fromJsonT);
}

    这样就更简单，不会破坏生成器的默认识别。

  5. 如果想彻底自己写 fromJson / toJson（不依赖自动生成），可以把 @Freezed(fromJson: false, toJson: false) 关掉自动生成，然后完全手写。但这样就失去了 Freezed 对序列化的辅助，需要你自己处理所有字段、泛型转换等逻辑。

结论

  • 在使用 Freezed + 泛型 + 手动修改 fromJson 的场景下：
    • 加上 @JsonSerializable(explicitToJson: true, genericArgumentFactories: true)，
    • 签名/参数保持一致，
    • 大括号里写你的自定义逻辑再调用 _$XXXFromJson(...)。
  • 这样就能既插入自定义逻辑，又保持代码生成正常。