json_serializable - 将通用字段添加到冻结/json_serializable 类

编程问答 2022-04-28

问题描述

如何使 Freezed 对象采用泛型类型？我想这样做：

import 'package:freezed_annotation/freezed_annotation.dart';
import 'package:vepo/src/entity_types/option_entity.dart';

part 'vegan_item_tag.freezed.dart';
part 'vegan_item_tag.g.dart';

@freezed
abstract class VeganItemTag<T>
    with _$VeganItemTag<T>
    implements OptionEntity<T> {
  const factory VeganItemTag({int? iconCodePoint,T? id,String? name}) =
      _VeganItemTag;

  const VeganItemTag._();

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

我已尝试使用文档中的 @With.fromString('AdministrativeArea<House>')，但无法将其正确应用于此类。

错误之一：

lib/src/common/enums/tags/common/vegan_item_tag.freezed.dart:142:32: 错误：位置参数太少：需要 2 个，给定 1 个。
$$_VeganItemTagFromJson(json);

认为我可能在正确的轨道上，但它不再生成 vegan_item_tag.g.dart 文件：

@freezed
abstract class VeganItemTag<T>
    with _$VeganItemTag<T>
    implements OptionEntity<T> {
  const factory VeganItemTag(
      {required int iconCodePoint,required T id,required String name}) = _VeganItemTag;

  const VeganItemTag._();

  factory VeganItemTag.fromJson(
    Map<String,Object?> json,T Function(Object?) fromJsonT,) => VeganItemTag(
      iconCodePoint: json['iconCodePoint'] as int,id: fromJsonT(json['id']),name: json['name'] as String,);
}

解决方法

这个问题有几种解决方案。但在所有这些中，您都需要将您的类显式转换为 Firebase 可以处理的泛型类型，例如 String 或 Map<dynamic,String>。

实现此类行为的 3 种方法是：

从Json到Json

在复杂的情况下，这比 JsonConverters 维护起来更麻烦，因此我会在您的解决方案中放弃此选项。

JsonConverters

它适用于通过继承自动转换特定类或抽象类，但从具有不同数据的泛型类型来存储它可能不是您所需要的。如果您总是从泛型类型 T 中保存相同的值，您可以尝试通过实现的抽象类来使用此解决方案。

GenericArgumentFactories

这才是你真正要问的。在 genericArgumentFactories 和 json_serializable 上使用 Freezed 并不容易，同时我在 Freezed package 上发现了一个错误。

但我设法让这段代码正常工作，这是实际的解决方案?。

@freezed
@JsonSerializable(genericArgumentFactories: true)
class VeganItemTagV2<T> with _$VeganItemTagV2<T> {
  const VeganItemTagV2._();

  const factory VeganItemTagV2({
    required int iconCodePoint,required T id,required String name,}) = _VeganItemTag<T>;

  //It only works with block bodies and not with expression bodies
  //I don't know why
  factory VeganItemTagV2.fromJson(
      Map<String,dynamic> json,T Function(Object? json) fromJsonT) {
    return _$VeganItemTagV2FromJson<T>(json,fromJsonT);
  }

  Map<String,dynamic> toJson(Object Function(T value) toJsonT) {
    return _$VeganItemTagV2ToJson<T>(this,toJsonT);
  }
}

这会根据泛型类型在 toJson 和 fromJson 方法上添加转换器。

注意。这些方法不能作为某些错误的表达式，因为它不能编译但可以与块体一起使用。 Freezed does not oficcially support it 所以你可以考虑在没有 Freezed 包的情况下创建这个类。

这是一个包含 String 封装类和一个测试类的示例，以了解其工作原理：

class VeganId {
  final String id;

  VeganId(this.id);

  String itemId() {
    return id;
  }

  @override
  String toString() {
    return 'VeganId{id: $id}';
  }

  @override
  bool operator ==(Object other) =>
      identical(this,other) ||
      other is VeganId && runtimeType == other.runtimeType && id == other.id;

  @override
  int get hashCode => id.hashCode;
}

测试效果很好

  test('veganItemV2 from and toJson',() {
    final dto = VeganItemTagV2<VeganId>(
      iconCodePoint: 1,id: VeganId("veganID"),name: "name",);

    final Map<String,dynamic> actualToJson = dto.toJson((id) => id.itemId());

    expect(actualToJson,{"iconCodePoint": 1,"id": "veganID","name": "name"});

    final VeganItemTagV2 actualFromJson = VeganItemTagV2<VeganId>.fromJson(
      actualToJson,(json) =>
        VeganId(json as String),);

    expect(actualFromJson,dto);
  });
,

您最后的代码没有生成 vegan_item_tag.g.dart，因为您在 VeganItemTag.fromJson 工厂中编写了错误的代码。编辑它是这样的：

factory VeganItemTag.fromJson(
    Map<String,Object?> json,T Function(Object?) fromJsonT,) => _$VeganItemTagFromJson(json,fromJsonT);

或者：

factory VeganItemTag.fromJson(Map<String,Object?> json) =>
    _$VeganItemTagFromJson(json);

然后重新运行 flutter pub run build_runner build --delete-conflicting-outputs 命令。

dartflutter-freezedfreezedjson-serializable