在JSON.NET数据解析期间忽略解析错误

时间:2014-09-29 19:45:04

标签: json error-handling json.net deserialization

我有一个具有预定义数据结构的对象:

public class A
{
    public string Id {get;set;}
    public bool? Enabled {get;set;}
    public int? Age {get;set;}
}

和JSON应该是

{ "Id": "123", "Enabled": true, "Age": 23 }

我想以积极的方式处理JSON错误,每当服务器返回已定义数据类型的意外值时,我希望它被忽略并设置默认值(null)。

现在,当JSON部分无效时,我收到JSON阅读器异常:

{ "Id": "123", "Enabled": "NotABoolValue", "Age": 23 }

我根本没有任何对象。 我想要的是获得一个对象:

new A() { Id = "123", Enabled = null, Age = 23 }

并在可能的情况下解析警告。 是否可以使用JSON.NET完成?

3 个答案:

答案 0 :(得分:89)

为了能够处理反序列化错误,请使用以下代码:

var a = JsonConvert.DeserializeObject<A>("-- JSON STRING --", new JsonSerializerSettings
    {
        Error = HandleDeserializationError
    });

其中HandleDeserializationError是以下方法:

public void HandleDeserializationError(object sender, ErrorEventArgs errorArgs)
{
    var currentError = errorArgs.ErrorContext.Error.Message;
    errorArgs.ErrorContext.Handled = true;
}

由于json字符串中存在错误,因此HandleDeserializationError将被调用多次。导致错误的属性不会被初始化。

答案 1 :(得分:5)

与Ilija的解决方案相同,但是对于懒惰/匆忙的一个oneliner(荣誉归于他)

var settings = new JsonSerializerSettings { Error = (se, ev) => { ev.ErrorContext.Handled = true; } };
JsonConvert.DeserializeObject<YourType>(yourJsonStringVariable, settings);

Props to Jam让它更短=)

答案 2 :(得分:0)

还有另一种方式。例如,如果您使用的是nuget包,该包使用newton json并为您进行反序列化和序列化。如果程序包未处理错误,则可能会出现此问题。那么您将无法使用上述解决方案。您需要在对象级别进行处理。在这里 OnErrorAttribute 很有用。因此,下面的代码将捕获任何属性的任何错误,您甚至可以在OnError函数中进行修改并分配默认值

public class PersonError
{
  private List<string> _roles;

  public string Name { get; set; }
  public int Age { get; set; }

  public List<string> Roles
  {
    get
    {
        if (_roles == null)
        {
            throw new Exception("Roles not loaded!");
        }

        return _roles;
    }
    set { _roles = value; }
  }

  public string Title { get; set; }

  [OnError]
  internal void OnError(StreamingContext context, ErrorContext errorContext)
  {
    errorContext.Handled = true;
  }
}

请参阅https://www.newtonsoft.com/json/help/html/SerializationErrorHandling.htm