Json.NET自定义JsonConverter与数据类型

时间:2016-05-01 17:14:39

标签: c# json json.net deserialization

我偶然发现了一种以下列格式输出JSON的服务:

{
    "Author": "me",
    "Version": "1.0.0",
    "data.Type1": {
        "Children": [
            {
                "data.Type1": {
                    "Children": [
                        {
                            "data.Type2": {
                                "name": "John",
                                "surname": "Doe"
                            }
                        }
                    ]
                }
            },
            {
                "data.Type3": {
                    "dob": "1990-01-01"
                }
            }
        ]
    }
}

数据类型名称保留为属性名称,其值是实际对象。它们都以data.前缀开头。

我之后想要得到的是:

{ // Root
    "Author": "me",
    "Version": "1.0.0",
    "Children": [ // Type1
        {
            "Children": [ // Type1
                { // Type2
                    "Name": "John",
                    "Surname": "Doe"
                }
            ]
        },
        { // Type3
            "DoB": "1990-01-01"
        }
    ]
}

使用以下类:

class Type1 {
    ICollection<object> Children { get; set; }
}

class Type2 {
    public string Name { get; set; }
    public string Surname { get; set; }
}

class Type3 {
    public DateTime DoB { get; set; }
}

class Root 
{
    public string Author { get; set; }
    public string Version { get; set; }
    public Type1 Children { get; set; }
}

问题

如何将其反序列化为添加的C#类,同时考虑数据类型并将其从树中删除?

我尝试使用自定义JsonConverter,但我正在努力选择转换器,因为最简单的方法是在属性上添加属性,但不支持。< / p>

一个小例子很棒。

2 个答案:

答案 0 :(得分:8)

虽然这种JSON格式有点不寻常并且由于动态属性名称而拒绝使用属性,但仍然可以通过一个小的改动使JsonConverter反序列化为您喜欢的类结构:我会建议您将Children类中的Root属性更改为ICollection<object>,以镜像Children类中的Type1属性。就像现在一样,它与所需输出的结构不匹配(其中Children显示为数组,而不是对象),否则需要转换器中的其他代码才能正确处理。

class Root
{
    public string Author { get; set; }
    public string Version { get; set; }
    public ICollection<object> Children { get; set; }
}

以下是我为转换器提出的建议(假设进行了上述更改):

class CustomConverter : JsonConverter
{
    public override bool CanConvert(Type objectType)
    {
        return (objectType == typeof(Root));
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        JObject obj = JObject.Load(reader);
        Root root = new Root();
        root.Author = (string)obj["Author"];
        root.Version = (string)obj["Version"];
        root.Children = ((Type1)DeserializeTypeX(obj, serializer)).Children;
        return root;
    }

    private object DeserializeTypeX(JObject obj, JsonSerializer serializer)
    {
        JProperty prop = obj.Properties().Where(p => p.Name.StartsWith("data.")).First();
        JObject child = (JObject)prop.Value;
        if (prop.Name == "data.Type1")
        {
            List<object> children = new List<object>();
            foreach (JObject jo in child["Children"].Children<JObject>())
            {
                children.Add(DeserializeTypeX(jo, serializer));
            }
            return new Type1 { Children = children };
        }
        else if (prop.Name == "data.Type2")
        {
            return child.ToObject<Type2>(serializer);
        }
        else if (prop.Name == "data.Type3")
        {
            return child.ToObject<Type3>(serializer);
        }
        throw new JsonSerializationException("Unrecognized type: " + prop.Name);
    }

    public override bool CanWrite
    {
        get { return false; }
    }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        throw new NotImplementedException();
    }
}

使用此转换器,您可以反序列化到您的类:

Root root = JsonConvert.DeserializeObject<Root>(json, new CustomConverter());

然后您可以序列化为这样的新格式:

JsonSerializerSettings settings = new JsonSerializerSettings
{
    DateFormatString = "yyyy-MM-dd",
    Formatting = Formatting.Indented
};

Console.WriteLine(JsonConvert.SerializeObject(root, settings));

小提琴:https://dotnetfiddle.net/ESNMLE

答案 1 :(得分:0)

不确定这是否有效,但您是否尝试使用Newtonsoft.Json序列化对象并在类属性中包含JsonProperty标记?我知道将Json反序列化为类时会有效。

<JsonProperty("user_id")>
Public Property UserID As String
//Converts Json {user_id: 123} to class.UserID = 123

要使用Newtonsoft进行序列化,首先将Newtonsoft包含在项目中

Dim stringJson As String = Newtonsoft.Json.JsonConvert.SerializeObject(root)