使用未知元素顺序反序列化XML

时间:2015-11-03 18:43:20

标签: c# serialization soap xml-serialization xmlserializer

我正在尝试使用非常缺乏规范的服务实现客户端。虽然它没有WSDL或等效文件,但它类似于SOAP。规范也没有提供有关元素正确排序的任何信息 - 它们在规范中按字母顺序列出,但如果请求中的服务出现故障,服务将返回XML解析错误(所述顺序由检查例子。)

我可以工作用于提交请求,即使这很痛苦。但是,我不知道如何正确处理答案。

同时使用SoapEnvelope和直接使用XmlSerializer,如果响应包含我尚未正确排序的元素,则会在我的对象上显示为null。再一次,我可以设法使用它,并手动命令类属性with Order attributes,但我无法判断原始XML是否有一个我没有正确排序的字段,因此保留为{ {1}}。

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

1 个答案:

答案 0 :(得分:3)

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

更复杂的答案是在序列化时正确排序元素,但在反序列化时忽略顺序。这需要使用XmlAttributes类和XmlSerializer(Type, XmlAttributeOverrides)构造函数。请注意,以这种方式构造的序列化程序must be cached in a hash table and resused可以避免严重的内存泄漏,因此这种解决方案有点“挑剔”,因为Microsoft没有为GetHashCode()提供有意义的XmlAttributeOverrides。以下是一种可能的实现,它依赖于事先知道所有需要忽略XmlElementAttribute.OrderXmlArrayAttribute.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 };
            }
            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。鉴于SoapEnvelopeXmlDocument的子类,您应该能够在Deserialize object property with StringReader vs XmlNodeReader中沿着答案行反序列化正文节点。