Question

我使用Json.NET来序列化/反序列化一些JSON API。

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

枚举是这样的：

public enum MyEnum
    {
        Type1,
        Type2,
        Type3
}

并且json API响应具有以下内容：

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

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

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

引发异常：

转换值时出错＆＃34; Type4＆＃34;输入＆＃39; MyEnum＆＃39;

有没有办法通过分配默认值或某些东西来避免应用程序崩溃来处理此错误？

Answer 1

我们说我们有以下json字符串：

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

以及以下类和枚举：

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

我看到的唯一方法是，你应该编写自己的转换器。但是，有一半的工作已在课程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中使用Enum.TryParse：

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＃枚举反序列化：将值转换为类型时出错

3 个答案: