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

Json.Net Deserialization of Complex Objects - Base Class that Contains a Base Class as a Property

几个小时以来,我一直在尝试解决这个问题。我尝试了很多方法并阅读了很多帖子。我似乎找不到解决方案。

我有一个对象层次结构,其中我有包含另一个派生类型的派生类型。我正在使用 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
            });

我收到以下异常:

An exception of type 'Newtonsoft.Json.JsonSerializationException' occurred in Newtonsoft.Json.dll but was not handled in user code.

Additional information: Error converting value

"[
   {
     "$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"
   }
]" 

to type 'System.Collections.Generic.IEnumerable`1[Common.Monitors.MonitorBase]'. Path '', line 1, position 943.

HeartbeatMonitorDiskSpaceMonitor 类型派生自 MonitorBase,它们各自的 Instructions 类型派生自 MonitorInstructionBase.

我忍不住假设我遗漏了一些明显的东西,因为我无法想象这不是一个相当普遍的场景。

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

如果您控制 JSON 的来源,请确保您只序列化对象一次。该问题的一个常见原因是没有意识到某些框架,例如 Web API,会自动为您进行序列化,因此如果您在 returning 对象之前先手动序列化它们,那么您将以双重序列化结束 JSON.

如果您不控制 JSON 的来源,and/or 您无法让所有者修复它,那么您可以通过反序列化 [=54] 在客户端更正它=] 两次:首先获取 "real" 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 方法来创建和 return 一个 HttpResponseMessage 以及包含您的 [=54] 的 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;