Json.net序列化/反序列化派生类型?

时间:2011-12-14 23:07:16

标签: c# json serialization json.net

json.net(newtonsoft)
我正在浏览文档,但我找不到任何关于这个或最好的方法。

public class Base
{
    public string Name;
}
public class Derived : Base
{
    public string Something;
}

JsonConvert.Deserialize<List<Base>>(text);

现在我在序列化列表中有Derived对象。如何反序列化列表并返回派生类型?

4 个答案:

答案 0 :(得分:85)

您必须启用类型名称处理并将其作为设置参数传递给(反)序列化程序。

Base object1 = new Base() { Name = "Object1" };
Derived object2 = new Derived() { Something = "Some other thing" };
List<Base> inheritanceList = new List<Base>() { object1, object2 };

JsonSerializerSettings settings = new JsonSerializerSettings { TypeNameHandling = TypeNameHandling.All };
string Serialized = JsonConvert.SerializeObject(inheritanceList, settings);
List<Base> deserializedList = JsonConvert.DeserializeObject<List<Base>>(Serialized, settings);

这将导致派生类的正确反序列化。它的一个缺点是它将命名您正在使用的所有对象,因此它将命名您放置对象的列表。

答案 1 :(得分:33)

如果您要将类型存储在text中(就像您应该在此方案中那样),则可以使用JsonSerializerSettings

请参阅:how to deserialize JSON into IEnumerable<BaseType> with Newtonsoft JSON.NET

但要小心。使用TypeNameHandling = TypeNameHandling.None以外的任何内容可能会让您自己打开a security vulnerability

答案 2 :(得分:4)

由于这个问题很受欢迎,因此如果您想控制类型属性名称及其值,添加一些操作可能会很有用。

长途跋涉是编写自定义JsonConverter来通过手动检查和设置type属性来处理(反序列化)。

一种更简单的方法是使用JsonSubTypes,它通过属性处理所有样板:

[JsonConverter(typeof(JsonSubtypes), "Sound")]
[JsonSubtypes.KnownSubType(typeof(Dog), "Bark")]
[JsonSubtypes.KnownSubType(typeof(Cat), "Meow")]
public class Animal
{
    public virtual string Sound { get; }
    public string Color { get; set; }
}

public class Dog : Animal
{
    public override string Sound { get; } = "Bark";
    public string Breed { get; set; }
}

public class Cat : Animal
{
    public override string Sound { get; } = "Meow";
    public bool Declawed { get; set; }
}

答案 3 :(得分:3)

使用此JsonKnownTypes,使用方法非常相似,只是将鉴别符添加到json:

[JsonConverter(typeof(JsonKnownTypeConverter<BaseClass>))]
[JsonKnownType(typeof(Base), "base")]
[JsonKnownType(typeof(Derived), "derived")]
public class Base
{
    public string Name;
}
public class Derived : Base
{
    public string Something;
}

现在,当您在json中序列化对象时,将添加"$type""base""derived"值,并将其用于反序列化

序列化列表示例:

[
    {"Name":"some name", "$type":"base"},
    {"Name":"some name", "Something":"something", "$type":"derived"}
]