NewtonSoft JSON无法解析数组引用项，Web API接收含引用JSON时数据丢失

嘿，这个问题我之前也碰到过——本质是JSON.NET（Newtonsoft.Json）默认在反序列化时不会识别$id和$ref这些引用标记，虽然你获取数据时序列化能正常生成它们，但提交回去就没法解析完整数据了。下面是具体的解决办法：

1. 全局配置引用处理 #

首先得确保你的API在序列化和反序列化时都启用了引用处理。根据你的.NET版本，在配置文件里加这段：

.NET 6+（极简模式） #

builder.Services.AddControllers()
    .AddNewtonsoftJson(options =>
    {
        // 启用对象引用处理，识别$id和$ref
        options.SerializerSettings.PreserveReferencesHandling = PreserveReferencesHandling.Objects;
        // 处理循环引用（如果你的模型有循环依赖的话）
        options.SerializerSettings.ReferenceLoopHandling = ReferenceLoopHandling.Serialize;
    });

.NET Framework/.NET Core 3.x及更早版本 #

services.AddMvc()
    .AddJsonOptions(options =>
    {
        options.SerializerSettings.PreserveReferencesHandling = PreserveReferencesHandling.Objects;
        options.SerializerSettings.ReferenceLoopHandling = ReferenceLoopHandling.Serialize;
    });

2. 检查模型类的标记 #

如果全局配置后还有问题，确认你的模型类/属性上的标记是否正确：

• 在需要被引用的类上添加[JsonObject(IsReference = true)]
• 或者针对特定属性加[JsonProperty(IsReference = true)]

举个例子：

[JsonObject(IsReference = true)]
public class GeneralDetails
{
    public string Description { get; set; }
    public ScheduleInfo ScheduleInfo { get; set; }
}

public class ScheduleInfo
{
    // 你的属性定义
}

提示：如果已经全局配置了PreserveReferencesHandling.Objects，类上的标记可以省略，两者共存也不会冲突。

3. 验证提交的JSON格式 #

确保你提交回去的JSON格式是正确的，比如包含合法的$id和$ref：

{
  "GeneralDetails": {
    "$id": "1",
    "Description": "23",
    "ScheduleInfo": {
      "$id": "2",
      "StartTime": "2024-05-20"
    }
  },
  "RelatedDetails": {
    "$ref": "1"
  }
}

如果$ref指向的$id不存在，或者格式写错了（比如少了$符号），反序列化肯定会失败。

4. 手动调试排查问题 #

要是还是没解决，可以在API的Action里手动调试反序列化过程，捕获具体错误：

[HttpPost]
public IActionResult SubmitData([FromBody] JObject rawJson)
{
    try
    {
        var serializerSettings = new JsonSerializerSettings
        {
            PreserveReferencesHandling = PreserveReferencesHandling.Objects,
            ReferenceLoopHandling = ReferenceLoopHandling.Serialize
        };
        var model = JsonConvert.DeserializeObject<YourRootModel>(rawJson.ToString(), serializerSettings);
        // 处理你的业务逻辑
        return Ok("数据解析成功");
    }
    catch (Exception ex)
    {
        // 这里可以看到具体的错误信息，比如引用找不到、模型不匹配等
        return BadRequest($"解析失败：{ex.Message}");
    }
}

通过捕获异常，你就能精准定位是引用识别的问题，还是模型结构不匹配导致的。

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