JSON.NET - 反序列化时的自定义枚举处理

Question

我们有一个可以反序列化为自定义域模型的 JSON，完全没有问题。它包括一个自定义枚举的属性：

public enum UserType
{
    President,
    Chump
}

我们现在更改了枚举类，但仍需要接受并反序列化任何到达的 JSON 的先前值。就像我们现在有两个版本的 JSON

public enum UserType
{
    President,
    Vice-President,
    Citizen  // Chump maps to Citizen, now.
}

在 json 本身中..

"userType": "chump"; // needs to map to Citizen

我不知道该怎么做。

这是使用JsonConverter 吗？

此外，这是我们用于所有序列化和反序列化的自定义设置。注意：我们将任何枚举序列化为 string 描述/值，而不是 int 值。

internal static JsonSerializerSettings JsonSerializerSettings => new JsonSerializerSettings
{
    Converters = new JsonConverter[]
    {
        new StringEnumConverter()
    },
    Formatting = Formatting.Indented
};

Answer 1

在您的 Enum 中添加 EnumMember 属性，指定序列化/反序列化过程的值。

public enum UserType
{
    President,
    VicePresident,

    [EnumMember(Value = "chump")]
    Citizen  // Chump maps to Citizen, now.
}

当在您的 json 中，userType 属性等于 "Chump" 或 "Citizen" 时，属性 userType 将为 Citizen。

记得将System.Runtime.Serialization 引用添加到您的项目中。

编辑

我注意到EnumMember 属性的Value 属性的检查区分大小写。所以你不能使用"Chump"，如果你的json中有"chump"。要解决此问题，您可以使用自定义StringEnumConverter。

public class UserTypeEnumConverter : StringEnumConverter
{
    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        var userTypeType = typeof(UserType);
        if (objectType == userTypeType)
        {
            var value = reader.Value.ToString().ToLower();

            foreach (var item in Enum.GetNames(userTypeType))
            {
                var memberValue = GetEnumMemberValue(userTypeType.GetMember(item)[0]);
                if (memberValue != null && memberValue.ToLower() == value)
                {
                    return Enum.Parse(userTypeType, item);
                }
            }
        }

        return base.ReadJson(reader, objectType, existingValue, serializer);
    }
}

private static string GetEnumMemberValue(MemberInfo memberInfo)
{
    var attributes = memberInfo.GetCustomAttributes(typeof(EnumMemberAttribute), inherit: false);

    if (attributes.Length == 0) return null;

    return ((EnumMemberAttribute)attributes[0]).Value;
}

在上面的代码中，我只检查EnumMember 属性，因为默认StringEnumConvert 已经完成UserType 的成员不区分大小写检查。

请注意，由于检查，此转换器仅适用于您的 UserType 枚举：

var userTypeType = typeof(UserType);
if (objectType == userTypeType)
{

将JsonSerializerSettings初始化替换为：

internal static JsonSerializerSettings JsonSerializerSettings => new JsonSerializerSettings
{
    Converters = new JsonConverter[]
    {
        new UserTypeEnumConverter()
    },
    Formatting = Formatting.Indented
};

我假设Vice-President 枚举器是VicePresident in UserType。

Answer 2

您可以实现从StringEnumConverter 派生的自定义Converter：

public class UserTypeEnumConverter : StringEnumConverter
{
    public override bool CanConvert(Type objectType)
    {
        return objectType == typeof(UserType);
    }

    public override object ReadJson(JsonReader reader, 
                                    Type objectType, 
                                    object existingValue, 
                                    JsonSerializer serializer)
    {
        if (reader.TokenType == JsonToken.Null)
        {
            var isNullable = (Nullable.GetUnderlyingType(objectType) != null);
            if (!isNullable)
            {
                throw new JsonSerializationException();
            }
            return null;
        }

        var token = JToken.Load(reader);
        var value = token.ToString();
        if (string.Equals(value, "chump", StringComparison.OrdinalIgnoreCase))
        {
            return UserType.Citizen;
        }
        else
        {
            return base.ReadJson(reader, objectType, existingValue, serializer);
        }               
    }
}

转换器处理底层类型也可以为空并且仅在反序列化类上声明的属性类型为UserType 时调用的情况。然后它会检查被解析的值是否是“弃用”的值，如果不是，它将读取委托给基址StringEnumConverter。