复杂对象的 Json.Net 反序列化 - 包含基类作为属性的基类

Question

我已经尝试解决这个问题几个小时了。我尝试了很多方法并阅读了很多帖子。我似乎找不到解决办法。

我有一个对象层次结构，其中我有包含另一个派生类型的派生类型。我正在使用 Json.Net 的 TypeNameHandling 设置。我在序列化和反序列化时都设置为Auto。

生成的 JSON 是：

"[\r\n  {\r\n    \"$type\": \"Common.Monitors.HeartbeatMonitor, Common\",\r\n    \"ClassName\": \"HeartbeatMonitor\",\r\n    \"ServerGroupMonitorId\": 1,\r\n    \"Instructions\": {\r\n      \"$type\": \"Common.Monitors.HeartbeatMonitorInstructions, Common\",\r\n      \"RunIntervalInMinutes\": 1\r\n    },\r\n    \"LastExecutionDateTime\": \"2016-03-22T16:35:18.7458519\"\r\n  },\r\n  {\r\n    \"$type\": \"Common.Monitors.DiskSpaceMonitor, Common\",\r\n    \"ClassName\": \"DiskSpaceMonitor\",\r\n    \"ServerGroupMonitorId\": 2,\r\n    \"Instructions\": {\r\n      \"$type\": \"Common.Monitors.DiskSpaceMonitorInstructions, Common\",\r\n      \"DriveLetter\": \"C:\\\",\r\n      \"AlertWhenPercentFreeLessThan\": 20,\r\n      \"RunIntervalInMinutes\": 30\r\n    },\r\n    \"LastExecutionDateTime\": \"2016-03-22T16:15:18.7458519\"\r\n  }\r\n]"

当尝试使用以下反序列化时：

string json = response.Content.ReadAsStringAsync().Result;

IEnumerable<MonitorBase> monitors = JsonConvert.DeserializeObject<IEnumerable<MonitorBase>>(json, new JsonSerializerSettings
            {
                TypeNameHandling = TypeNameHandling.Auto
            });

我收到以下异常：

Newtonsoft.Json.dll 中出现“Newtonsoft.Json.JsonSerializationException”类型的异常，但未在用户代码中处理。

附加信息：转换值时出错

"[
   {
     "$type": "Common.Monitors.HeartbeatMonitor, Common",
     "ClassName": "HeartbeatMonitor",
     "ServerGroupMonitorId": 1,
     "Instructions": {
       "$type": "Common.Monitors.HeartbeatMonitorInstructions, Common",
       "RunIntervalInMinutes": 1
     },
     "LastExecutionDateTime": "2016-03-22T16:35:18.7458519"
   },
   {
     "$type": "Common.Monitors.DiskSpaceMonitor, Common",
     "ClassName": "DiskSpaceMonitor",
     "ServerGroupMonitorId": 2,
     "Instructions": {
       "$type": "Common.Monitors.DiskSpaceMonitorInstructions, Common",
       "DriveLetter": "C:\\",
       "AlertWhenPercentFreeLessThan": 20,
       "RunIntervalInMinutes": 30
     },
     "LastExecutionDateTime": "2016-03-22T16:15:18.7458519"
   }
]" 

键入“System.Collections.Generic.IEnumerable`1[Common.Monitors.MonitorBase]”。 路径 ''，第 1 行，位置 943。

HeartbeatMonitor 和 DiskSpaceMonitor 类型派生自 MonitorBase，它们各自的 Instructions 类型派生自 MonitorInstructionBase。

我不禁假设我遗漏了一些明显的东西，因为我无法想象这不是一个相当常见的情况。

Answer 1

我认为问题可能在于您的 JSON 是双重序列化的，转义引号 \"、可见换行符 \r\n 以及整个 JSON 都被引用的事实证明了这一点。当你反序列化双序列化的 JSON 时，结果是一个字符串，而不是一个对象，它显然不能转换为任何类型的 IEnumerable<T>。因此出现错误。

如果您控制 JSON 的来源，请确保您只对对象进行一次序列化。问题的一个常见原因是没有意识到某些框架（例如 Web API）会自动为您进行序列化，因此如果您在返回对象之前先手动序列化对象，那么您最终会得到双重序列化的 JSON。

如果您不控制 JSON 的来源，并且/或者您无法让所有者修复它，那么您可以通过两次反序列化 JSON 在客户端进行更正：首先获取“真正的”JSON字符串，然后第二个从中生成您的对象。例如：

string escapedJson = response.Content.ReadAsStringAsync().Result;

string realJson = JsonConvert.DeserializeObject<string>(escapedJson);

IEnumerable<MonitorBase> monitors = 
    JsonConvert.DeserializeObject<IEnumerable<MonitorBase>>(realJson, 
        new JsonSerializerSettings
        {
            TypeNameHandling = TypeNameHandling.Auto
        });

编辑

我从您的评论中看到，您正在手动序列化您的对象以利用 Json.Net 的 TypeNameHandling 设置，并且您正在寻找一种避免双重序列化的方法。

你基本上有两种选择：

1. 将 TypeNameHandling 设置添加到 Web API 的全局序列化设置中，并从您的方法中删除手动序列化代码。为此，请在 global.asax 的 Application_Start() 方法中添加以下内容。

   var settings = GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings;
   settings.TypeNameHandling = TypeNameHandling.Auto;
   

2. 或者，您可以更改您的 Web API 方法以创建并返回一个 HttpResponseMessage，其中包含您的 JSON 的 StringContent 对象，并将 mediaType 设置为 application/json。这应该可以防止 Web API 尝试重新序列化结果。

   string json = JsonConvert.SerializeObject(monitors, new JsonSerializerSettings 
   {
       TypeNameHandling = TypeNameHandling.Auto,
       Formatting = Formatting.Indented
   }); 
   HttpResponseMessage response = Request.CreateResponse(HttpStatusCode.OK);
   response.Content = new StringContent(json, Encoding.UTF8, "application/json");
   return response;