在给定XSD的情况下如何在C#中进行多态反序列化?

时间:2015-01-22 10:49:36

标签: c# serialization xsd polymorphism

我有以下给出:

1)使用XSD.EXE工具编译为C#类的XML Schema,XSD文件。

2)RabbitMQ消息队列,包含XML Schema中定义的任何类型的XML格式良好的消息。以下是两个不同消息的片段:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<UserReport xmlns=".../v5.1"; ... >
    ... User report message content... 
</UserReport>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CaptureReport xmlns=".../v5.1"; ...>
    ... Capture report message content... 
</CaptureReport>

3)在知道类型时,使用XmlSerializer .Net类进行反序列化的经验。

问题是当类型未知时,如何将消息从XML反序列化为对象。无法实例化XmlSerializer,因为类型未知。

一种方法是遍历所有可能的类型,直到反序列化成功,这是一个糟糕的解决方案,因为XML Schema中定义了许多不同的类型。

还有其他选择吗?

3 个答案:

答案 0 :(得分:4)

根据您在XML本身中如何实现多态性,您可以采取一些方法。

元素名称是类型名称(反射方法)

您可以像这样获取根元素名称:

string rootElement = null;

using (XmlReader reader = XmlReader.Create(xmlFileName))
{
    while (reader.Read())
    {
        // We won't have to read much of the file to find the root element as it will be the first one found
        if (reader.NodeType == XmlNodeType.Element)
        {
            rootElement = reader.Name;
            break;
        }
    }
}

然后你可以像这样通过反射找到类型(如果你的类在不同的程序集中,根据需要调整反射):

var serializableType = Type.GetType("MyApp." + rootElement);
var serializer = new XmlSerializer(serializableType);

如果性能很重要,建议您将映射从元素名称缓存到XML序列化程序。

元素名称映射到类型名称

如果XML元素名称与类型名称不同,或者您不想进行反射,则可以创建从XML中的元素名称到{{1}的Dictionary映射。对象,但仍然使用上面的代码片段查找根元素名称。

通过xsi:type

具有多态性的公共根元素

如果您的XML消息都具有相同的根元素名称,并且通过使用xsi:type标识类型来实现多态性,那么您可以执行以下操作:

XmlSerializer

请注意using System; using System.Xml.Serialization; namespace XmlTest { public abstract class RootElement { } public class TypeA : RootElement { public string AData { get; set; } } public class TypeB : RootElement { public int BData { get; set; } } class Program { static void Main(string[] args) { var serializer = new System.Xml.Serialization.XmlSerializer(typeof(RootElement), new Type[] { typeof(TypeA), typeof(TypeB) }); RootElement rootElement = null; string axml = "<RootElement xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"TypeA\"><AData>Hello A</AData></RootElement>"; string bxml = "<RootElement xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"TypeB\"><BData>1234</BData></RootElement>"; foreach (var s in new string[] { axml, bxml }) { using (var reader = new System.IO.StringReader(s)) { rootElement = (RootElement)serializer.Deserialize(reader); } TypeA a = rootElement as TypeA; if (a != null) { Console.WriteLine("TypeA: {0}", a.AData); } else { TypeB b = rootElement as TypeB; if (b != null) { Console.WriteLine("TypeB: {0}", b.BData); } else { Console.Error.WriteLine("Unexpected type."); } } } } } } 构造函数的第二个参数,它是您希望.NET序列化程序了解的其他类型的数组。

答案 1 :(得分:1)

这是基于@softwariness的答案,但它提供了一些自动化。

如果您的课程是通过xsd生成的,则所有根类型都会使用XmlRootAttribute进行修饰,以便我们可以使用它:

public class XmlVariantFactory
{
    private readonly Dictionary<string, Type> _xmlRoots;

    public XmlVariantFactory() : this(Assembly.GetExecutingAssembly().GetTypes())
    {
    }

    public XmlVariantFactory(IEnumerable<Type> types)
    {
        _xmlRoots = types
                    .Select(t => new {t, t.GetCustomAttribute<XmlRootAttribute>()?.ElementName})
                    .Where(x => !string.IsNullOrEmpty(x.ElementName))
                    .ToDictionary(x => x.ElementName, x => x.t);
    }

    public Type GetSerializationType(XmlReader reader)
    {
        while (reader.Read())
        {
            if (reader.NodeType == XmlNodeType.Element)
            {
                return _xmlRoots[reader.LocalName];
            }
        }
        throw new ArgumentException("No known root type found for passed XML");
    }
}

它会扫描执行程序集中的所有类型,并查找所有可能的XML根。您可以为所有程序集执行此操作:

public XmlVariantFactory() : this(AppDomain.CurrentDomain.SelectMany(a => a.GetTypes())
{
}

然后你juse使用它:

var input = new StringReader(TestResource.firstRequestResponse);
var serializationType = new XmlVariantFactory().GetSerializationType(XmlReader.Create(input));
var xmlReader = XmlReader.Create(input);
bool canDeserialize = new XmlSerializer(serializationType).CanDeserialize(xmlReader);
Assert.True(canDeserialize);

答案 2 :(得分:0)

负责XML Schema已将xml-tag添加到RabbitMQ协议头中的内容字段。标头包含dto,数据传输对象的标记,发送和序列化为xml。这意味着IOC容器变得方便。我已经编写了一个dto builder接口及其通用构建器的实现。因此,当为通用部件指定dto类时,构建器将构建dto。请注意,dto-class由xsd-tool生成。在像MS Unity这样的IOC容器中,我为所有类注册了构建器接口实现,并将xml-tag添加到寄存器调用中。使用来自RabbitMQ头的实际接收的xml-tag调用IOC容器的解析器函数,以实例化dto的特定构建器。