【问题标题】:Is there a way to return a custom error when Newtonsoft.JSON deserialization fails?当 Newtonsoft.JSON 反序列化失败时,有没有办法返回自定义错误?
【发布时间】:2020-12-23 17:01:31
【问题描述】:

我想在请求失败时更改 ResponseBody,因为对 Enum 的反序列化不成功。该应用程序是一个 .NET Core 3 API。

我的一个实体拥有以下属性:

[JsonConverter(typeof(StringEnumConverter))]
public Attribute Attribute { get; set; }

其中属性为以下枚举:

public enum Attribute
    {
        [EnumMember(Value = "value-1")]
        value1,
        [EnumMember(Value = "value-2")]
        value2,
        [EnumMember(Value = "some-value")]
        somevalue
    }

当我尝试使用错误的枚举值发布正文时:

{
  "attribute": "wrong-value"
}

我的端点返回一个带有 Newtonsoft 错误的 400,我想返回一个由我创建的 ResponseBody。

{
    "errors": {
        "attribute": [
            "Error converting value \"wrong-value\" to type 'Project.Attribute'. Path 'attribute', line 10, position 24."
        ]
    },
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "traceId": "|1cf19d18-4577510ef4de1g923."
}

有没有办法通过中间件拦截此类错误并返回自定义 ResponseBody?

【问题讨论】:

    标签: c# serialization .net-core json.net asp.net-core-middleware


    【解决方案1】:

    我要做的是创建一个StringEnumConverter 类:

    internal class StringEnumConverter : JsonConverter
    {
        public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
        {
            if (reader.TokenType == JsonToken.String)
                try
                {
                    return JsonConvert.DeserializeObject<Attribute>("'" + reader.Value.ToString() + "'");
                }
                catch
                {
                    var tr = reader as JsonTextReader;
                    throw new Exception($"Error converting value \"{reader.Value.ToString()}\" to type \"{objectType.ToString()}\". Path \"{tr.Path}\", line {tr.LineNumber}, position {tr.LinePosition}.");
                }
            throw new NotImplementedException();
        }
    
        public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
        {
            throw new NotImplementedException();
        }
    
        public override bool CanConvert(Type objectType)
        {
            return true;
        }
    }
    

    然后在尝试反序列化我的 JSON 字符串时,我会捕获任何异常,例如:

    string json = "{'attribute': 'value1x'}";
    
    try
    {
        MyClass r = JsonConvert.DeserializeObject<MyClass>(json);
    }
    catch (Exception e)
    {
        Console.WriteLine(e.Message);
    }
    

    这样我的异常就会有适当的消息。当然,您必须记住,这仅用于将字符串反序列化为 Attribute 类型(也许名称应更改为 StringToAttributeConverter 以提高可读性)。如果可能的话,您将不得不为所有不同类型的枚举找到一种更通用的方法(也许通过使用通用...)。

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多