如何定位Newtonsoft.Json中与.NET类不匹配的无效JSON位置？

一、定位JSON反序列化中的无效元素位置 #

默认情况下Newtonsoft.Json会忽略很多错误（比如未知属性、无效枚举值），导致对象为null或属性缺失却无异常。要精准定位问题，需要调整序列化配置并捕获错误细节：

1. 开启严格模式触发异常 #

通过JsonSerializerSettings开启严格校验，让框架对错误直接抛出异常：

var settings = new JsonSerializerSettings
{
    // 遇到未知属性（拼写错误）时抛出异常
    MissingMemberHandling = MissingMemberHandling.Error,
    // 遇到无效枚举值时抛出异常
    EnumHandling = EnumHandling.Error,
    // 禁止为null的引用类型自动创建实例（避免混淆null是原始值还是反序列化失败）
    NullValueHandling = NullValueHandling.Include,
    ObjectCreationHandling = ObjectCreationHandling.Replace
};

try
{
    var result = JsonConvert.DeserializeObject<YourTargetClass>(jsonString, settings);
}
catch (JsonSerializationException ex)
{
    // 异常信息会包含错误路径，比如："Could not find member 'WrongPropertyName' on object of type 'YourTargetClass'. Path 'WrongPropertyName', line 3, position 25."
    Console.WriteLine($"反序列化错误：{ex.Message}");
}

2. 自定义错误处理捕获更细粒度信息 #

如果不想直接抛出中断流程，可以通过Error事件收集所有错误，包括位置和具体问题：

var errors = new List<string>();
var settings = new JsonSerializerSettings
{
    MissingMemberHandling = MissingMemberHandling.Error,
    EnumHandling = EnumHandling.Error
};
settings.Error += (sender, args) =>
{
    var errorMsg = $"路径：{args.ErrorContext.Path}，行号：{args.ErrorContext.LineNumber}，列号：{args.ErrorContext.LinePosition}，错误：{args.ErrorContext.Error.Message}";
    errors.Add(errorMsg);
    // 标记错误已处理，避免抛出异常
    args.ErrorContext.Handled = true;
};

var result = JsonConvert.DeserializeObject<YourTargetClass>(jsonString, settings);
// 遍历所有收集到的错误
foreach (var error in errors)
{
    Console.WriteLine(error);
}

二、用JSON Schema验证JSON与.NET类的匹配性 #

通过JSON Schema可以在反序列化前就验证JSON结构、枚举值、属性名等是否完全匹配，提前发现问题。Newtonsoft提供了Newtonsoft.Json.Schema库来实现这个功能。

1. 安装依赖包 #

先安装NuGet包：

Install-Package Newtonsoft.Json.Schema

2. 从.NET类生成JSON Schema #

使用JSchemaGenerator可以直接从你的目标类生成对应的Schema，包含所有属性约束、枚举允许值等：

var generator = new JSchemaGenerator();
// 配置生成器，比如让枚举以字符串形式生成约束
generator.GenerationSettings.DefaultEnumHandling = EnumHandling.String;

// 从目标类生成Schema
JSchema schema = generator.Generate(typeof(YourTargetClass));

// 可以将Schema保存为JSON文件，方便复用或手动调整
File.WriteAllText("YourTargetSchema.json", schema.ToString());

3. 用Schema验证JSON字符串 #

生成Schema后，使用JSchemaValidatingReader来验证JSON，捕获所有不符合Schema的错误：

var schema = JSchema.Parse(File.ReadAllText("YourTargetSchema.json"));
var validationErrors = new List<string>();

using (var stringReader = new StringReader(jsonString))
using (var jsonReader = new JsonTextReader(stringReader))
using (var validatingReader = new JSchemaValidatingReader(jsonReader))
{
    validatingReader.Schema = schema;
    validatingReader.ValidationEventHandler += (sender, args) =>
    {
        var errorMsg = $"路径：{args.Path}，行号：{args.LineNumber}，列号：{args.LinePosition}，错误：{args.Message}";
        validationErrors.Add(errorMsg);
    };

    // 读取整个JSON完成验证
    JsonSerializer.Create().Deserialize(validatingReader);
}

// 输出所有验证错误
foreach (var error in validationErrors)
{
    Console.WriteLine(error);
}

这种方式可以一次性查出所有问题，比如属性名拼写错误、枚举值不在允许列表、类型不匹配等，比反序列化后排查效率高得多。

内容的提问来源于stack exchange，提问作者Hamilton Woods