4

我正在尝试编写一组类来表示一个特别复杂的对象，在其中一个类中，我有一个属性被设置为三个可能的派生类的基（抽象）类。我正在设置一个 ASP.NET Web API 来处理序列化和反序列化，这意味着默认情况下，它使用 Json.NET 处理 JSON。如何让 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 格式化程序无法填充派生类，留下 property null。

问题

我可以将 XmlSerializer 属性与 DataContractSerializer 同一类的属性混合吗？ 我使用 xml 是XmlSerializer因为我在设计的 xml 中使用了 xml 属性，但如果有必要，可以更改它，因为我自己正在开发 xml 模式。

Json.NET 中的等价物是什么 [KnownType()] ？DataContractSerializerJson.NET似乎不尊重KnownType. 我需要滚动自己的 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）。

4

3 回答 3

3

你可以像已经提到的那样混合，但我认为你不需要，我自己没有使用过 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);
        }
    }
于 2012-08-29T18:47:21.310 回答
2

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

代码优先

我生成了一个类来继承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;

现在，每当我将序列化为MyClassJSON 时，我都会得到以下信息：

{ 
    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那么第二个示例将开始发送不同的名称。这可能是也可能不是什么大问题，这取决于您是否使用这些类型。

最后的想法

AliasedTypes 的优点是我可以给它任何我想要的字符串，我重构代码的多少都没有关系，.NET 和 JavaScript（或任何消费者）之间的通信是不间断的。

注意不要将具有完全相同的类名的AliasedTypes 和s 混在一起，因为编写的代码会胜过. 当活页夹无法识别类型（别名或已知）时，它将提供该类型的完整程序集名称。KnownTypeAliasTypeKnownType

于 2013-07-25T14:04:36.527 回答
0

最后，我分解并将 .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"
    }
}
于 2012-09-16T19:37:31.993 回答