正在反序列化具有未知元素顺序的XML

本文关键字：元素 顺序 XML 未知 反序列化 | 更新日期: 2023-09-27 18:20:22

我正试图为一个规范非常不足的服务实现一个客户端。它类似于SOAP，尽管它没有WSDL或等效文件。规范也没有提供任何关于元素正确顺序的信息——它们在规范中按字母顺序列出，但如果它们在请求中顺序不正确，服务会返回XML解析错误（所述顺序是通过检查示例得出的）。

我可以使用它来提交请求，即使这很痛苦。然而，我不知道如何正确处理回复。

对于SoapEnvelope和直接使用XmlSerializer，如果响应包含一个我尚未正确排序的元素，那么它在我的对象上显示为null。再一次，我可以处理这个问题，并手动使用Order属性对类属性进行排序，但我无法判断原始XML是否有一个我没有正确排序的字段，因此被保留为null。

这引出了当前的问题：如何检查XmlSerializer是否删除了字段？

正在反序列化具有未知元素顺序的XML

您可以在XmlSerializer上使用XmlSerializer.UnknownElement事件来捕获无序元素。这将允许您手动查找并修复反序列化中的问题。

更复杂的答案是在序列化时正确地排列元素的顺序，但在反序列化时忽略顺序。这需要使用XmlAttributes类和XmlSerializer(Type, XmlAttributeOverrides)构造函数。请注意，以这种方式构建的序列化程序必须缓存在哈希表中并重新悬浮，以避免严重的内存泄漏，因此此解决方案有点"错误"；挑剔的"；因为微软没有为CCD_ 11提供有意义的CCD_。以下是一种可能的实现方式，它依赖于提前知道需要忽略其XmlElementAttribute.Order和XmlArrayAttribute.Order属性的所有类型，从而避免创建复杂的自定义哈希方法：

 // https://stackoverflow.com/questions/33506708/deserializing-xml-with-unknown-element-order
public class XmlSerializerFactory : XmlOrderFreeSerializerFactory
{
    static readonly XmlSerializerFactory instance;
    // Use a static constructor for lazy initialization.
    private XmlSerializerFactory()
        : base(new[] { typeof(Type2), typeof(Type1), typeof(TestClass), typeof(Type3) }) // These are the types in your client for which Order needs to be ignored whend deserializing
    {
    }
    static XmlSerializerFactory()
    {
        instance = new XmlSerializerFactory();
    }
    public static XmlSerializerFactory Instance { get { return instance; } }
}
public abstract class XmlOrderFreeSerializerFactory
{
    readonly XmlAttributeOverrides overrides;
    readonly object locker = new object();
    readonly Dictionary<Type, XmlSerializer> serializers = new Dictionary<Type, XmlSerializer>();
    static void AddOverrideAttributes(Type type, XmlAttributeOverrides overrides)
    {
        if (type == null || type == typeof(object) || type.IsPrimitive || type == typeof(string))
            return;
        var mask = BindingFlags.DeclaredOnly | BindingFlags.Instance | BindingFlags.Public;
        foreach (var member in type.GetProperties(mask).Cast<MemberInfo>().Union(type.GetFields(mask)))
        {
            XmlAttributes overrideAttr = null;
            foreach (var attr in member.GetCustomAttributes<XmlElementAttribute>())
            {
                overrideAttr = overrideAttr ?? new XmlAttributes();
                overrideAttr.XmlElements.Add(new XmlElementAttribute { DataType = attr.DataType, ElementName = attr.ElementName, Form = attr.Form, IsNullable = attr.IsNullable, Namespace = attr.Namespace, Type = attr.Type });
            }
            foreach (var attr in member.GetCustomAttributes<XmlArrayAttribute>())
            {
                overrideAttr = overrideAttr ?? new XmlAttributes();
                overrideAttr.XmlArray = new XmlArrayAttribute { ElementName = attr.ElementName, Form = attr.Form, IsNullable = attr.IsNullable, Namespace = attr.Namespace };
            }
            foreach (var attr in member.GetCustomAttributes<XmlArrayItemAttribute>())
            {
                overrideAttr = overrideAttr ?? new XmlAttributes();
                overrideAttr.XmlArrayItems.Add(attr);
            }
            foreach (var attr in member.GetCustomAttributes<XmlAnyElementAttribute>())
            {
                overrideAttr = overrideAttr ?? new XmlAttributes();
                overrideAttr.XmlAnyElements.Add(new XmlAnyElementAttribute { Name = attr.Name, Namespace = attr.Namespace });
            }
            if (overrideAttr != null)
                overrides.Add(type, member.Name, overrideAttr);
        }
    }
    protected XmlOrderFreeSerializerFactory(IEnumerable<Type> types)
    {
        overrides = new XmlAttributeOverrides();
        foreach (var type in types.SelectMany(t => t.BaseTypesAndSelf()).Distinct())
        {
            AddOverrideAttributes(type, overrides);
        }
    }
    public XmlSerializer GetSerializer(Type type)
    {
        if (type == null)
            throw new ArgumentNullException("type");
        lock (locker)
        {
            XmlSerializer serializer;
            if (!serializers.TryGetValue(type, out serializer))
                serializers[type] = serializer = new XmlSerializer(type, overrides);
            return serializer;
        }
    }
}
public static class TypeExtensions
{
    public static IEnumerable<Type> BaseTypesAndSelf(this Type type)
    {
        while (type != null)
        {
            yield return type;
            type = type.BaseType;
        }
    }
}

然后，在反序列化类型时，请使用工厂提供的XmlSerializer。假设SoapEnvelope是XmlDocument的子类，您应该能够使用StringReader与XmlNodeReader沿着反序列化对象属性中的答案行反序列化主体节点。

注意——只是适度测试。在这里演示小提琴。

相关文章：