使用 Json.Net 的 C# 枚举反序列化：将值转换为类型时出错

Question

我正在使用 Json.NET 到 serialize/deserialize 一些 JSON APIs.

API 响应有一些整数值映射到应用程序中定义的枚举。

枚举是这样的：

public enum MyEnum
{
    Type1,
    Type2,
    Type3
}

和 JSON API 响应具有以下内容：

{
    "Name": "abc",
    "MyEnumValue":"Type1"
}

有时 API returns MyEnumValue 字段的值未在我的枚举中定义，如下所示：

{
    "Name": "abc",
    "MyEnumValue":"Type4"
}

抛出异常：

Error converting value "Type4" to type 'MyEnum'

有没有办法通过分配默认值或其他方法来避免应用程序崩溃来处理此错误？

Answer 1

假设我们有以下 json 字符串：

[
    {
        "Name": "abc",
        "MyEnumValue": "Type1"
    },
    {
        "Name": "abcd",
        "MyEnumValue": "Type2"
    },
    {
        "Name": "abcde",
        "MyEnumValue": "Type3"
    }    ,
    {
        "Name": "abcdef",
        "MyEnumValue": "Type4"
    }
]

以及以下 class 和枚举：

public class MyClass
{
    public string Name { get; set; }

    public MyEnum MyEnumValue { get; set; }
}

public enum MyEnum
{
    Type1,
    Type2,
    Type3
}

可以注意到，json 字符串数组包含无法正确映射到 MyEnum 的项目（最后一个）。为避免反序列化错误，您可以使用以下代码片段：

static void Main(string[] args)
{         
    var serializationSettings = new JsonSerializerSettings
    {
        Error = HandleDeserializationError
    };

    var lst = JsonConvert.DeserializeObject<List<MyClass>>(jsonStr, serializationSettings);
}

public static void HandleDeserializationError(object sender, ErrorEventArgs errorArgs)
{
    errorArgs.ErrorContext.Handled = true;
    var currentObj = errorArgs.CurrentObject as MyClass;

    if (currentObj == null) return;
    currentObj.MyEnumValue = MyEnum.Type2;            
}

其中 jsonStr 变量是上面发布的 json 字符串。在上面的代码示例中，如果无法正确解释MyEnumValue，则将其设置为默认值Type2。

示例：https://dotnetfiddle.net/WKd2Lt

Answer 2

我唯一的看法是，你应该编写自己的转换器。但是在 class StringEnumConverter 中已经完成了一半的工作。我们只能覆盖 ReadJson 方法

class Program
{
    static void Main(string[] args)
    {
        const string json = @"{
                'Name': 'abc',
                'Type':'Type4'
            }";

        // uncomment this if you want to use default value other then default enum first value
        //var settings = new JsonSerializerSettings();
        //settings.Converters.Add(new FooTypeEnumConverter { DefaultValue = FooType.Type3 });

        //var x = JsonConvert.DeserializeObject<Foo>(json, settings);

        var x = JsonConvert.DeserializeObject<Foo>(json);
    }
}

public class Foo
{
    public string Name { get; set; }

    public FooType Type { get; set; }
}

public enum FooType
{
    Type1,
    Type2,
    Type3
}

public class FooTypeEnumConverter : StringEnumConverter
{
    public FooType DefaultValue { get; set; }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        try
        {
            return base.ReadJson(reader, objectType, existingValue, serializer);
        }
        catch (JsonSerializationException)
        {
            return DefaultValue;
        }
    }
}

Answer 3

如果您不想创建自定义转换器，另一种方法是将其映射到 DTO 中的私有字符串字段，然后在该字段的属性 getter:

public class MyClass
{
    [JsonProperty("MyEnumValue")]
    private string myEnumValue;

    public string Name { get; set; }

    [JsonIgnore]
    public MyEnum MyEnumValue 
    { 
        get
        {
            MyEnum outputValue = MyEnum.Default;
            Enum.TryParse(myEnumValue, out outputValue);
            return outputValue;
        }
    }
}

使用 Json.Net 的 C# 枚举反序列化：将值转换为类型时出错

C# Enum deserialization with Json.Net: Error converting value to type

.net

c#

json

json.net

deserialization