使用Enum将映射编码为JSON

Question

我想将我的Map编码为json。它看起来像这样：

Map<MyEnum, int> map = {type: limit};

其中 MyEnum 是枚举。一个简单的json.encode（map）将不起作用，因为它不知道如何序列化枚举类。

错误消息是：

Unhandled Exception: Converting object to an encodable object failed: _LinkedHashMap len:1

如何将此地图序列化为json？

Answer 1

您可以在枚举上创建一个扩展名以将其转换为字符串，然后将地图转换为地图

import 'dart:convert';

enum MyEnum { type }

extension MyEnumModifier on MyEnum {
  String get string => this.toString().split('.').last;
}

void main() {
  Map<MyEnum, int> map = {MyEnum.type: 10};
  Map<String, int> newMap = {};
  
  map.forEach((key, value) =>
    newMap[key.string] = value);
  
  final json = jsonEncode(newMap);
  print(json);
}

输出

{"type":10}

Answer 2

这真的不是一个我会推荐的解决方案，但我最终这么做主要是为了“好玩”。我不保证任何关于解决方案的事情，除了它是可怕的事实。:)

问题是enum没有定义为Json的有效类型，因此整个概念确实给我们带来了一些问题。一种解决方案是将enum值转换为字符串，首先使用enum的名称，然后使用值的名称，如MyFirstEnum.first1。如果对枚举值调用toString（），Dart会给出这种表示。

这很好，但为了安全起见，我们还可以在开头添加一个魔术字符串，如＜code＞DART_ENUM:MyFirstEnum。first1以便更容易在其他字符串之间识别，这些字符串可能与enumvalue具有相同的名称，而不是enum。

接下来是类型安全。在Json中，我们知道所有的映射都有< code>String作为键的类型。通过制作我们自己的< code>enum表示并允许它也是键，我们不能期望解码器返回例如< code>Map

也就是说，我尝试构建一个Json解码器和编码器来处理< code>enum值。它还适用于地图中的< code>enum键:

import 'dart:convert';

class JsonConverterWithEnumSupport {
  final String magicString;
  final Set<Object> allEnumValues = {};
  final Map<String, Object> enumStringToEnumValue = {};

  JsonConverterWithEnumSupport(List<List<Object>>? enumsValues,
      {this.magicString = "DART_ENUM:"}) {
    enumsValues?.forEach(addEnumValues);
  }

  void addEnumValues(List<Object> enumValues) {
    for (final enumValue in enumValues) {
      enumStringToEnumValue[enumValue.toString()] = enumValue;
      allEnumValues.add(enumValue);
    }
  }

  String _addMagic(dynamic enumValue) => '$magicString$enumValue';
  String _removeMagic(String string) => string.substring(magicString.length);

  String encode(Object? value) =>
      json.encode(value, toEncodable: (dynamic object) {
        if (object is Map) {
          return object.map<dynamic, dynamic>((dynamic key, dynamic value) =>
              MapEntry<dynamic, dynamic>(
                  allEnumValues.contains(key) ? _addMagic(key) : key,
                  allEnumValues.contains(value) ? _addMagic(value) : value));
        }

        if (object is List) {
          return object.map<dynamic>(
              (dynamic e) => allEnumValues.contains(e) ? _addMagic(e) : e);
        }

        if (allEnumValues.contains(object)) {
          return _addMagic(object);
        }

        return object;
      });

  dynamic decode(String source) => json.decode(source, reviver: (key, value) {
        if (value is String && value.startsWith(magicString)) {
          return enumStringToEnumValue[_removeMagic(value)];
        }

        if (value is Map) {
          return value.map<dynamic, dynamic>((dynamic key, dynamic value) =>
              MapEntry<dynamic, dynamic>(
                  (key is String) && key.startsWith(magicString)
                      ? enumStringToEnumValue[_removeMagic(key)]
                      : key,
                  value));
        }

        return value;
      });
}

enum MyFirstEnum { first1, first2 }
enum MySecondEnum { second1, second2 }

void main() {
  final converter =
      JsonConverterWithEnumSupport([MyFirstEnum.values, MySecondEnum.values]);

  final jsonString = converter.encode({
    MyFirstEnum.first1: [MySecondEnum.second2, MySecondEnum.second1],
    'test': {MyFirstEnum.first2: 5}
  });

  print(jsonString);
  // {"DART_ENUM:MyFirstEnum.first1":["DART_ENUM:MySecondEnum.second2","DART_ENUM:MySecondEnum.second1"],"test":{"DART_ENUM:MyFirstEnum.first2":5}}
  print(converter.decode(jsonString));
  // {MyFirstEnum.first1: [MySecondEnum.second2, MySecondEnum.second1], test: {MyFirstEnum.first2: 5}}
}

您将需要输入到 JsonConverter中支持所有可能的枚举值（例如，请参阅底部的主方法）。

如果您不希望将魔术字符串附加到每个枚举上，则只需创建带有以下参数的 JsonConverter与以下工具进行支持：魔术字符串：'“作为参数。

Answer 3

你可以在foundation.dart中使用dealEnum方法