使用 Web API 反序列化为具有抽象属性的类

Question

我正在尝试编写一组类来表示一个特别复杂的对象，在其中一个类中，我有一个属性被设置为三个可能的派生类的基(抽象(类。 我正在设置一个 ASP.NET Web API 来处理序列化和反序列化，这意味着默认情况下，它使用 JSON 的 Json.NET。 如何让 Web API 正确地反序列化通过 POST 或 PUT 发送的 JSON 到正确的派生类中？

具有抽象成员的类如下所示(为了清楚起见，我包括了 Xml 装饰器，因为它们非常适合使用 XmlSerializer 反序列化 xml(

[Serializable]
public class FormulaStructure {
    [XmlElement("column", typeof(ColumnStructure))]
    [XmlElement("function", typeof(FunctionStructure))]
    [XmlElement("operand", typeof(OperandStructure))]
    public AFormulaItemStructure FormulaItem;
}

抽象类是非常基本的：

[Serializable]
public abstract class AFormulaItemStructure { }

抽象类有三个衍生物：

[Serializable]
public class ColumnStructure: AFormulaItemStructure {
    [XmlAttribute("type")]
    public string Type;
    [XmlAttribute("field")]
    public string Field;
    [XmlAttribute("display")]
    public string Display;
}
[Serializable]
public class FunctionStructure: AFormulaItemStructure {
    [XmlAttribute("type")]
    public string Type;
    [XmlAttribute("name")]
    public string Name;
    [XmlElement("parameters")]
    public string Parameters;
}

[Serializable]
public class OperandStructure: AFormulaItemStructure {
    [XmlAttribute("type")]
    public string Type;
    [XmlElement("left")]
    public string Left;
    [XmlElement("right")]
    public string Right;
}

目前，使用 [DataContract] 属性时，Json.NET 格式化程序无法填充派生类，从而使属性null。

---

问题

我可以在同一类上将XmlSerializer属性与DataContractSerializer属性混合使用吗？ 我之所以使用XmlSerializer，是因为我在设计的 xml 中使用了 xml 属性，但由于我自己正在开发 xml 架构，因此可以根据需要进行更改。

Json.NET [KnownType()]等价物是什么？ Json.NET 似乎不尊重KnownType的DataContractSerializer版本。 我是否需要使用自己的 JsonConverter 来确定正确的类型？

我将如何装饰类，以便DataContractSerializer或DataContractJsonSerializer将正确反序列化 Xml 和 JSON 中的对象？ 我的目标是将其放入 ASP.NET Web API 中，因此我希望能够灵活地生成 Xml 或 Json，具体取决于请求的类型。 如果 Json.NET 不起作用，我是否需要使用替代格式化程序来处理这个复杂的类？

我需要能够在客户端生成对象，而不必将 .NET 类名包含在对象中。

---

测试和改进

在我对 Web API 的测试中，默认序列化向下发送到客户端：

{"FormulaItem":{"type":"int","field":"my_field","display":"My Field"}}

这对我的目的来说是理想的。 但是，将其返回到 API 并反序列化为正确的派生类型是行不通的(它为属性生成 null(。

测试Tommy Grovnes的答案如下，他用于测试的DataContractSerializer生成：

{"FormulaItem":{"__type":"column:#ExpressionStructureExperimentation.Models","display":"My Field","field":"my_field","type":"int"}}

这对我或代码可维护性都不起作用(如果我将整个命名空间硬编码到 JavaScript 中以生成这些对象，重构就会成为 PITA(。

Answer 1

你可以像前面提到的那样混合，但我认为你不需要，你自己没有使用WEB api，但WCF Rest从DataContracts生成xml和json(没有Xml..标签(，像这样标记你的类：

[DataContract]
public class FormulaStructure
{
    [DataMember]
    public AFormulaItemStructure FormulaItem;
}
[DataContract]
[KnownType(typeof(ColumnStructure))]
[KnownType(typeof(FunctionStructure))]
[KnownType(typeof(OperandStructure))]
public abstract class AFormulaItemStructure { }
[DataContract(Name="column")]
public class ColumnStructure : AFormulaItemStructure
{
    [DataMember(Name="type")]
    public string Type;
    [DataMember(Name = "field")]
    public string Field;
    [DataMember(Name = "display")]
    public string Display;
}
[DataContract(Name="function")]
public class FunctionStructure : AFormulaItemStructure
{
    [DataMember(Name = "type")]
    public string Type;
    [DataMember(Name = "name")]
    public string Name;
    [DataMember(Name = "parameters")]
    public string Parameters;
}
[DataContract(Name = "operand")]
public class OperandStructure : AFormulaItemStructure
{
    [DataMember(Name = "type")]
    public string Type;
    [DataMember(Name = "left")]
    public string Left;
    [DataMember(Name = "right")]
    public string Right;
}

如果您需要对生成的 XML/JSON 进行更多控制，则可能需要进一步调整。我用这段代码来测试：

    public static string Serialize(FormulaStructure structure)
    {
        using (MemoryStream memoryStream = new MemoryStream())
        using (StreamReader reader = new StreamReader(memoryStream))
        {
            var serializer = new DataContractSerializer(typeof(FormulaStructure));
            serializer.WriteObject(memoryStream, structure);
            memoryStream.Position = 0;
            return reader.ReadToEnd();
        }
    }
    public static FormulaStructure Deserialize(string xml)
    {
        using (Stream stream = new MemoryStream())
        {
            byte[] data = System.Text.Encoding.UTF8.GetBytes(xml);
            stream.Write(data, 0, data.Length);
            stream.Position = 0;
            var deserializer = new DataContractSerializer(typeof(FormulaStructure));
            return (FormulaStructure)deserializer.ReadObject(stream);
        }
    }

Answer 2

在我们之前

回答进一步遇到一些问题之后，我发现了 JSON 可用于序列化/反序列化命名空间的SerializationBinder类。

代码优先

我生成了一个类来继承SerializationBinder：

public class KnownTypesBinder : System.Runtime.Serialization.SerializationBinder {
    public KnownTypesBinder() {
        KnownTypes = new List<Type>();
        AliasedTypes = new Dictionary<string, Type>();
    }
    public IList<Type> KnownTypes { get; set; }
    public IDictionary<string, Type> AliasedTypes { get; set; }
    public override Type BindToType(string assemblyName, string typeName) {
        if (AliasedTypes.ContainsKey(typeName)) { return AliasedTypes[typeName]; }
        var type = KnownTypes.SingleOrDefault(t => t.Name == typeName);
        if (type == null) {
            type = Type.GetType(Assembly.CreateQualifiedName(assemblyName, typeName));
            if (type == null) {
                throw new InvalidCastException("Unknown type encountered while deserializing JSON.  This can happen if class names have changed but the database or the JavaScript references the old class name.");
            }
        }
        return type;
    }
    public override void BindToName(Type serializedType, out string assemblyName, out string typeName) {
        assemblyName = null;
        typeName = serializedType.Name;
    }
}

工作原理

假设我有一组定义如下的类：

public class Class1 {
    public string Text { get; set; }
}
public class Class2 {
    public int Value { get; set; }
}
public class MyClass {
    public Class1 Text { get; set; }
    public Class2 Value { get; set; }
}

别名类型

这样做允许我为将序列化/反序列化的类生成自己的名称。 在我的global.asax文件中，我按如下方式应用活页夹：

KnownTypesBinder binder = new KnownTypesBinder()
binder.AliasedTypes["Class1"] = typeof(Project1.Class1);
binder.AliasedTypes["WhateverStringIWant"] = typeof(Project1.Class2);
var json = GlobalConfiguration.Configuration.Formatters.JsonFormatter;
json.SerializerSettings.Binder = binder;

现在，每当我序列化(例如MyClass JSON 时(，我都会得到以下内容：

{ 
    item: { 
        $type: "Project1.MyClass",  
        Text: {
            $type: "Class1",
            Text: "some value"
        },
        Value: {
            $type: "WhateverStringIWant",
            Value: 88
        }
    } 
}

已知类型

我也可以选择去掉汇编信息，通过向KnownTypesBinder添加信息来严格使用类名：

KnownTypesBinder binder = new KnownTypesBinder()
binder.KnownTypes.Add(typeof(Project1.Class1));
binder.KnownTypes.Add(typeof(Project1.Class1));

在给出的两个示例中，Class1以相同的方式引用。 但是，如果我重构Class1，比如说，NewClass1，那么第二个示例将开始发送不同的名称。 这可能是也可能不是什么大问题，具体取决于您是否使用这些类型。

结语

AliasedType 的优点是我可以给它任何我想要的字符串，而且无论我重构代码多少，.NET 和 JavaScript(或任何消费者(之间的通信都是不间断的。

注意不要混合AliasedType具有完全相同类名的 s 和 KnownType，因为编写的代码是AliasType将胜过 KnownType 。 当绑定程序无法识别类型(别名或已知(时，它将提供该类型的完整程序集名称。

Answer 3

最后，我分解并将 .NET 类信息添加到字符串变量中的模块中，以使重构更容易。

module.net = {};
module.net.classes = {};
module.net.classes['column'] = "ColumnStructure";
module.net.classes['function'] = "FunctionStructure";
module.net.classes['operand'] = "OperandStructure";
module.net.getAssembly = function (className) {
    return "MyNamespace.Models." + module.net.classes[className] + ", MyAssembly";
}

并将 JSON 生成为

{
    "FormulaItem": {
        "$type": module.net.getAssembly('column'),
        "type": "int",
        "field": "my_field",
        "display": "My Field"
    }
}