Json.net自定义枚举转换器

一尘不染

Json.net自定义枚举转换器

json

我目前正在使用Json.net在我的应用程序中使用json。我使用的API向我发送了枚举的特定字符串格式，例如：

对于 TemperatureType 带有值的类型的枚举 fahrenheit, Celcius

json值为： {"result":["TemperatureType_fahrenheit","TemperatureType_Celcius"]}

我想使用转换器直接管理它，以获得一个IList<TemperatureType>但也适用于其他枚举类型。

有人有主意吗？

我尝试使用自定义JsonConverter：

  if (reader.TokenType == JsonToken.String && reader.Value != null)
  {
      string value = reader.Value.ToString();
      var splitValues = value.Split('_');
      if (splitValues.Length == 2)
      {
         var type = Type.GetType(splitValues[0]);
         return Enum.Parse(type, splitValues[1]);
      }
  }

问题是GetType属性，因为我没有指示所需类型且没有名称空间的参数

阅读 188

2020-07-27

共1个答案

一尘不染

枚举类型是的objectType参数ReadJson。但是，有几点：

您需要处理可为空的枚举类型。
您需要处理[Flag]枚举。Json.NET将它们写为以逗号分隔的值列表。
您需要处理带有无效值的枚举的情况。Json.NET在将它们写为数字值的时候StringEnumConverter.AllowIntegerValues == true，否则将引发异常。

这是StringEnumConverter处理这些情况的子类，方法是调用基类，然后在适当时添加或删除类型前缀：

public class TypePrefixEnumConverter : StringEnumConverter
{
    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        bool isNullable = (Nullable.GetUnderlyingType(objectType) != null);
        Type enumType = (Nullable.GetUnderlyingType(objectType) ?? objectType);
        if (!enumType.IsEnum)
            throw new JsonSerializationException(string.Format("type {0} is not a enum type", enumType.FullName));
        var prefix = enumType.Name + "_";

        if (reader.TokenType == JsonToken.Null)
        {
            if (!isNullable)
                throw new JsonSerializationException();
            return null;
        }

        // Strip the prefix from the enum components (if any).
        var token = JToken.Load(reader);
        if (token.Type == JTokenType.String)
        {
            token = (JValue)string.Join(", ", token.ToString().Split(',').Select(s => s.Trim()).Select(s => s.StartsWith(prefix) ? s.Substring(prefix.Length) : s).ToArray());
        }

        using (var subReader = token.CreateReader())
        {
            while (subReader.TokenType == JsonToken.None)
                subReader.Read();
            return base.ReadJson(subReader, objectType, existingValue, serializer); // Use base class to convert
        }
    }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        var array = new JArray();
        using (var tempWriter = array.CreateWriter())
            base.WriteJson(tempWriter, value, serializer);
        var token = array.Single();

        if (token.Type == JTokenType.String && value != null)
        {
            var enumType = value.GetType();
            var prefix = enumType.Name + "_";
            token = (JValue)string.Join(", ", token.ToString().Split(',').Select(s => s.Trim()).Select(s => (!char.IsNumber(s[0]) && s[0] != '-') ? prefix + s : s).ToArray());
        }

        token.WriteTo(writer);
    }
}

然后，您可以在任何可以使用的地方使用它StringEnumConverter，例如：

        var settings = new JsonSerializerSettings { Converters = new JsonConverter[] { new TypePrefixEnumConverter() } };
        var json = JsonConvert.SerializeObject(myClass, Formatting.Indented, settings);

2020-07-27