有时是数组有时是对象时反序列化 JSON

Question

我在使用 JSON.NET 库反序列化从 Facebook 返回的数据时遇到了一些麻烦。

从简单的墙贴返回的 JSON 看起来像：

{
    "attachment":{"description":""},
    "permalink":"http://www.facebook.com/permalink.php?story_fbid=123456789"
}

照片返回的 JSON 看起来像：

"attachment":{
        "media":[
            {
                "href":"http://www.facebook.com/photo.php?fbid=12345",
                "alt":"",
                "type":"photo",
                "src":"http://photos-b.ak.fbcdn.net/hphotos-ak-ash1/12345_s.jpg",
                "photo":{"aid":"1234","pid":"1234","fbid":"1234","owner":"1234","index":"12","width":"720","height":"482"}}
        ],

一切都很好，我没有任何问题。我现在遇到了来自移动客户端的带有以下 JSON 的简单墙贴，并且反序列化现在因这一篇帖子而失败：

"attachment":
    {
        "media":{},
        "name":"",
        "caption":"",
        "description":"",
        "properties":{},
        "icon":"http://www.facebook.com/images/icons/mobile_app.gif",
        "fb_object_type":""
    },
"permalink":"http://www.facebook.com/1234"

这是我要反序列化的类：

public class FacebookAttachment
    {
        public string Name { get; set; }
        public string Description { get; set; }
        public string Href { get; set; }
        public FacebookPostType Fb_Object_Type { get; set; }
        public string Fb_Object_Id { get; set; }

        [JsonConverter(typeof(FacebookMediaJsonConverter))]
        public List<FacebookMedia> { get; set; }

        public string Permalink { get; set; }
    }

如果不使用 FacebookMediaJsonConverter，我会收到错误： 无法反序列化JSON 对象转换为“System.Collections.Generic.List`1[FacebookMedia]”类型。 这是有道理的，因为在 JSON 中，Media 不是一个集合。

我发现这篇文章描述了类似的问题，所以我尝试走这条路线： 反序列化 JSON，有时值是一个数组，有时是“”（空白字符串）

我的转换器看起来像：

public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
{
     if (reader.TokenType == JsonToken.StartArray)
          return serializer.Deserialize<List<FacebookMedia>>(reader);
     else
          return null;
}

工作正常，但我现在得到一个新的异常：

Inside JsonSerializerInternalReader.cs ，CreateValueInternal()：反序列化对象时出现意外标记：PropertyName

reader.Value 的值为“permalink”。我可以在开关中清楚地看到 JsonToken.PropertyName 没有大小写。

我需要在转换器中做一些不同的事情吗？感谢您的任何帮助。

Answer 1

有关如何处理这种情况的非常详细的说明，请访问 “使用用于修复错误 JSON 结果的自定义 JsonConverter”。

总而言之，您可以扩展默认的 JSON.NET 转换器，

1. 用问题注释属性

   [JsonConverter(typeof(SingleValueArrayConverter))]
   公共列表项目;
   

2. 扩展转换器以返回所需类型的列表，即使对于单个对象也是如此

   public class SingleValueArrayConverter; : JsonConverter
   {
       public override void WriteJson(JsonWriter writer, 对象值, JsonSerializer 序列化器)
       {
           抛出新的NotImplementedException（）；
       }
   
       公共覆盖对象ReadJson（JsonReader阅读器，类型objectType，对象existingValue，JsonSerializer序列化器）
       {
           对象 retVal = new Object();
           if (reader.TokenType == JsonToken.StartObject)
           {
               T 实例 = (T)serializer.Deserialize(reader, typeof(T));
               retVal = new List() { 实例 };
           } else if (reader.TokenType == JsonToken.StartArray) {
               retVal = serializer.Deserialize(reader, objectType);
           }
           返回retVal；
       }
   
       公共覆盖 bool CanConvert（类型 objectType）
       {
           返回真；
       }
   }
   

正如文章中提到的，此扩展并不完全通用，但如果您愿意获取列表，它就可以工作。

Answer 2

JSON.NET 的开发人员最终为项目 Codeplex 网站提供了帮助。解决方案如下：

问题是，当它是 JSON 对象时，我没有读取该属性。这是正确的代码：

public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
{
    if (reader.TokenType == JsonToken.StartArray)
    {
        return serializer.Deserialize<List<FacebookMedia>>(reader);
    }
    else
    {
        FacebookMedia media = serializer.Deserialize<FacebookMedia>(reader);
        return new List<FacebookMedia>(new[] {media});
    }
}

James 也很友善地为上述方法提供了单元测试。

Answer 3

根据上面 Camilo Martinez 的回答，这是一种更现代、类型安全、更精简和完整的方法，使用 JsonConverter 的通用版本和 C# 8.0 以及实现序列化部分。除了根据问题预期的两个标记之外，它还会引发异常。代码永远不应该做超出要求的事情，否则您将面临由于错误处理意外数据而导致未来错误的风险。

internal class SingleObjectOrArrayJsonConverter<T> : JsonConverter<ICollection<T>> where T : class, new()
{
    public override void WriteJson(JsonWriter writer, ICollection<T> value, JsonSerializer serializer)
    {
        serializer.Serialize(writer, value.Count == 1 ? (object)value.Single() : value);
    }

    public override ICollection<T> ReadJson(JsonReader reader, Type objectType, ICollection<T> existingValue, bool hasExistingValue, JsonSerializer serializer)
    {
        return reader.TokenType switch
        {
            JsonToken.StartObject => new Collection<T> {serializer.Deserialize<T>(reader)},
            JsonToken.StartArray => serializer.Deserialize<ICollection<T>>(reader),
            _ => throw new ArgumentOutOfRangeException($"Converter does not support JSON token type {reader.TokenType}.")
        };
    }
}

然后这样装饰属性：

[JsonConverter(typeof(SingleObjectOrArrayJsonConverter<OrderItem>))]
public ICollection<OrderItem> items;

我已将属性类型从 List<> 更改为 ICollection<>，因为 JSON POCO 通常只需要这种较弱的类型，但如果需要 List<>，则只需将上述所有代码中的 ICollection 和 Collection 替换为 List 。

Answer 4

阐述 Martinez 和 mfanto 对 Newtonsoft 的回答。它确实可以与 Newtonsoft 一起使用：

下面是一个使用数组而不是列表（并且命名正确）的示例。

public class SingleValueArrayConverter<T> : JsonConverter
{
    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        serializer.Serialize(writer, value);
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        if (reader.TokenType == JsonToken.StartObject 
            || reader.TokenType == JsonToken.String
            || reader.TokenType == JsonToken.Integer)
        {
            return new T[] { serializer.Deserialize<T>(reader) };
        }
        return serializer.Deserialize<T[]>(reader);
    }

    public override bool CanConvert(Type objectType)
    {
        return true;
    }
}

然后在属性上写下：

[JsonProperty("INSURANCE")]
[JsonConverter(typeof(SingleValueArrayConverter<InsuranceInfo>))]
public InsuranceInfo[] InsuranceInfo { get; set; }

Newtonsoft 将为您完成剩下的工作。

return JsonConvert.DeserializeObject<T>(json);

为马丁内斯和姆凡托干杯！

不管你相信与否，这适用于子项目。 （甚至可能必须这样做。）所以...在我的 InsuranceInfo 中，如果我有另一个对象/数组混合体，请在该属性上再次使用它。

这还允许您将对象重新序列化回 json。当它重新序列化时，它将始终是一个数组。

Answer 5

看一下 C# 框架中的 System.Runtime.Serialization 命名空间，它将带您快速到达您想要的位置。

如果需要，您可以查看此项目中的一些示例代码（不尝试插入我自己的工作，但我刚刚完成了与您正在做的几乎完全相同的工作，但使用了不同的源 API

希望它有所帮助。

Answer 6

.Net框架

using Newtonsoft.Json;
using System.IO;   

public Object SingleObjectOrArrayJson(string strJson)
{   
    if(String.IsNullOrEmpty(strJson))
    {
       //Example
       strJson= @"{
        'CPU': 'Intel',
        'PSU': '500W',
        'Drives': [
          'DVD read/writer'
          /*(broken)*/,
          '500 gigabyte hard drive',
          '200 gigabyte hard drive'
        ]
      }";
    }

    JsonTextReader reader = new JsonTextReader(new StringReader(strJson));
    
    //Initialize Read
    reader.Read();
    
        if (reader.TokenType == JsonToken.StartArray)
        {
            return JsonConvert.DeserializeObject<List<Object>>(strJson);
        }
        else
        {
            Object media = JsonConvert.DeserializeObject<Object>(strJson);
            return new List<Object>(new[] {media});
        }
}

注意：
“对象”必须根据您的响应的 Json 属性进行定义

Answer 7

我认为你应该这样写你的课程......！！！

public class FacebookAttachment
    {

        [JsonProperty("attachment")]
        public Attachment Attachment { get; set; }

        [JsonProperty("permalink")]
        public string Permalink { get; set; }
    }

public class Attachment
    {

        [JsonProperty("media")]
        public Media Media { get; set; }

        [JsonProperty("name")]
        public string Name { get; set; }

        [JsonProperty("caption")]
        public string Caption { get; set; }

        [JsonProperty("description")]
        public string Description { get; set; }

        [JsonProperty("properties")]
        public Properties Properties { get; set; }

        [JsonProperty("icon")]
        public string Icon { get; set; }

        [JsonProperty("fb_object_type")]
        public string FbObjectType { get; set; }
    }
 public class Media
    {
    }
 public class Properties
    {
    }