json_serialized - 将通用字段添加到 freezed/json_serializing 类

Question

如何使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,
    );
}

Answer 1

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

实现这种行为的 3 种方法是：

来自Json ToJson

这比复杂的场景更难以维护JsonConverters，因此我会为您的解决方案放弃此选项。

Json转换器

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

通用参数工厂

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

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

@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 并不正式支持它，因此您可以考虑在不使用 Freezed 包的情况下创建此类。

这是一个带有 a 的封装类和一个测试类的示例，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);
  });