如何为Freezed数据类实现带Firestore文档ID参数的fromJson？

你遇到的问题本质是：id被标记为必填项但不参与JSON序列化，导致Freezed自动生成的fromJson方法无法获取id值来构造实例。要实现带单独id参数的解析方法，直接手动实现即可，无需依赖自动生成的fromJson。

修改后的完整代码 #

import 'package:freezed_annotation/freezed_annotation.dart';

part 'habit.freezed.dart';
part 'habit.g.dart';

const String uninstantiatedId = '未实例化ID';

@freezed
class Habit with _$Habit {
  const Habit._();

  const factory Habit({
    @JsonKey(includeFromJson: false, includeToJson: false) required String id,
    required String title,
    String? description,
  }) = _Habit;

  factory Habit.newEmpty() => Habit(
        id: uninstantiatedId,
        title: '',
      );

  // 自定义从Firestore文档解析的方法，单独传入文档ID
  factory Habit.fromFirestore(String id, Map<String, dynamic> json) {
    return Habit(
      id: id,
      title: json['title'] as String,
      description: json['description'] as String?,
    );
  }

  // 保留自动生成的toJson，会自动忽略id字段
  @override
  Map<String, dynamic> toJson() => _$HabitToJson(this);
}

关键说明 #

1. 手动实现解析逻辑：放弃使用自动生成的_$HabitFromJson，改为直接从JSON中解析title、description等字段，结合传入的id构造Habit实例，完全规避必填项id无法从JSON获取的问题。
2. 保持序列化行为：@JsonKey的配置不变，toJson依然会自动忽略id，符合Firestore不存储文档ID的需求。
3. 命名更清晰：将方法命名为fromFirestore而非fromJson，明确它是专门处理Firestore文档解析的方法，避免和通用JSON解析混淆。

字段较多时的优化方案 #

如果你的Habit类有大量字段，手动解析太繁琐，可以借助json_serializable的临时解析技巧：

// 在Habit类中添加
factory Habit.fromFirestore(String id, Map<String, dynamic> json) {
  // 先创建一个临时的Habit实例（id用占位符）
  final tempHabit = _$HabitFromJson({...json, 'id': 'temp'});
  // 通过copyWith替换为真实的文档ID
  return tempHabit.copyWith(id: id);
}

这种方式利用自动生成的解析器处理所有字段，仅手动替换id，兼顾了便捷性和需求。

内容的提问来源于stack exchange，提问作者Charlie Page