如何让XmlSerializer忽略特定类型的所有成员？

Question

我可以帮您将XML反序列化为以下类：

```

我想将XML反序列化为以下类：

```

public partial class Delivery
{
    public System.Nullable<System.DateTime> sentDate { get; set; }
    public System.Nullable<System.DateTime> receivedDate { get; set; }
    public System.Nullable<System.DateTime> responseDueDate { get; set; }
}

然而，XML中的日期不符合XmlSerializer友好的格式。基于多个问题的答案，我添加了这个类：

public partial class DateSafeDelivery : Delivery
{
    [XmlElement("sentDate")]
    public string sentDateString
    {
        internal get { return sentDate.HasValue ? XmlConvert.ToString(sentDate.Value) : null; }
        set { sentDate = DateTime.Parse(value); }
    }
    [XmlElement("receivedDate")]
    public string receivedDateString
    {
        internal get { return receivedDate.HasValue ? XmlConvert.ToString(receivedDate.Value) : null; }
        set { receivedDate = DateTime.Parse(value); }
    }
    [XmlElement("responseDueDate")]
    public string responseDueDateString
    {
        internal get { return responseDueDate.HasValue ? XmlConvert.ToString(responseDueDate.Value) : null; }
        set { responseDueDate = DateTime.Parse(value); }
    }
}

我接下来会配置我的覆盖文件：

private static XmlAttributeOverrides GetOverrides()
{
    var overrides = new XmlAttributeOverrides();
    var attributes = new XmlAttributes();
    attributes.XmlElements.Add(new XmlElementAttribute(typeof(DateSafeDelivery)));
    overrides.Add(typeof(MyParent), "Delivery", attributes);
    var ignore = new XmlAttributes { XmlIgnore = true };
    overrides.Add(typeof(DateTime?), ignore);
    return overrides;
}

这会导致以下异常：

Message=The string '2010-06-12T00:00:00 -05:00' is not a valid AllXsd value.
Source=System.Xml.ReaderWriter
StackTrace:
    at System.Xml.Schema.XsdDateTime..ctor(String text, XsdDateTimeFlags kinds)
    at System.Xml.XmlConvert.ToDateTime(String s, XmlDateTimeSerializationMode dateTimeOption)
    at Microsoft.Xml.Serialization.GeneratedAssembly.XmlSerializationReaderDeserializedAudit.Read1_NullableOfDateTime(Boolean checkType)
    at Microsoft.Xml.Serialization.GeneratedAssembly.XmlSerializationReaderDeserializedAudit.Read15_DateSafeDelivery(Boolean isNullable, Boolean checkType)
    at Microsoft.Xml.Serialization.GeneratedAssembly.XmlSerializationReaderDeserializedAudit.Read16_MyParent(Boolean isNullable, Boolean checkType)

正在使用DateSafeDelivery，但是日期的XmlIgnore被忽略了。

如果我切换为：

    overrides.Add(typeof(DateTime?), ignore);

使用：

    new Dictionary<string, Type>()
    {
        { "sentDate", typeof(Delivery) },
        { "receivedDate", typeof(Delivery) },
        { "responseDueDate", typeof(Delivery) },
    }
        .ToList()
        .ForEach(t1 => overrides.Add(t1.Value, t1.Key, ignore));

对于一个类和三个属性来说，这样做是可以的。但我有14个类，总共有三打日期属性。我知道我必须为这14个类添加覆盖，但是否有一种方法可以让序列化程序忽略所有DateTime属性?

我以为XmlAttributeOverrides.Add 方法 (Type, XmlAttributes)可以实现这一点。但它并没有起作用。为什么？这个方法是干什么的？它是做什么用的？

- Rich Bennema

Answer 1

XmlAttributeOverrides.Add(Type, XmlAttributes)的设计是为了将XML覆盖属性添加到类型本身，而不是所有返回该类型值的属性。例如，如果您想要向DateSafeDelivery添加[XmlRoot("OverrideName")]属性，可以这样做：

overrides.Add(typeof(DateSafeDelivery),
    new XmlAttributes { XmlRoot = new XmlRootAttribute("OverrideName") });

没有动态覆盖属性可以忽略所有返回给定类型的属性，因为没有静态XML序列化属性可以抑制给定类型的所有属性的序列化。以下内容甚至无法编译，因为[XmlIgnore]只能应用于属性或字段：

[XmlIgnore] public class IgnoreAllInstancesOfMe { } // Fails to compile.

至于为什么微软没有实现对类型应用[XmlIgnore]的支持 - 您需要问他们。

因此，您需要引入以下类似的扩展方法：

public static partial class XmlAttributeOverridesExtensions
{
    public static XmlAttributeOverrides IgnorePropertiesOfType(this XmlAttributeOverrides overrides, Type declaringType, Type propertyType)
    {
        return overrides.IgnorePropertiesOfType(declaringType, propertyType, new HashSet<Type>());
    }

    public static XmlAttributeOverrides IgnorePropertiesOfType(this XmlAttributeOverrides overrides, Type declaringType, Type propertyType, HashSet<Type> completedTypes)
    {
        if (overrides == null || declaringType == null || propertyType == null || completedTypes == null)
            throw new ArgumentNullException();
        XmlAttributes attributes = null;
        for (; declaringType != null && declaringType != typeof(object); declaringType = declaringType.BaseType)
        {
            // Avoid duplicate overrides.
            if (!completedTypes.Add(declaringType))
                break;
            foreach (var property in declaringType.GetProperties(BindingFlags.Public | BindingFlags.DeclaredOnly | BindingFlags.Instance))
            {
                if (property.PropertyType == propertyType || Nullable.GetUnderlyingType(property.PropertyType) == propertyType)
                {
                    attributes = attributes ?? new XmlAttributes { XmlIgnore = true };
                    overrides.Add(declaringType, property.Name, attributes);
                }
            }
        }
        return overrides;
    }
}

并且执行：

    private static XmlAttributeOverrides GetOverrides()
    {
        var overrides = new XmlAttributeOverrides();

        var attributes = new XmlAttributes();
        attributes.XmlElements.Add(new XmlElementAttribute(typeof(DateSafeDelivery)));
        overrides.Add(typeof(MyParent), "Delivery", attributes);

        // Ignore all DateTime properties in DateSafeDelivery
        var completed = new HashSet<Type>();
        overrides.IgnorePropertiesOfType(typeof(DateSafeDelivery), typeof(DateTime), completed);
        // Add the other 14 types as required

        return overrides;
    }

请注意，DateSafeDelivery上的DateString属性必须具有public的get和set方法，例如：

public partial class DateSafeDelivery : Delivery
{
    [XmlElement("sentDate")]
    public string sentDateString
    {
        get { return sentDate.HasValue ? XmlConvert.ToString(sentDate.Value, XmlDateTimeSerializationMode.Utc) : null; }
        set { sentDate = DateTime.Parse(value); }
    }

XmlSerializer 无法序列化非完全公开的属性。

顺便提一下，请注意您必须静态缓存任何使用重写构建的 XmlSerializer，以避免严重的内存泄漏，如 this answer 中所述。

- dbc

---

所以XmlAttributeOverrides.Add(Type, XmlAttributes)仅适用于正在反序列化的类型。明白了。最后，我在代码中列出了每个属性。我考虑过反射，但不想让计算机每次都花3分钟来弄清楚我可以告诉它的事情。此外，我已经看到了有关内存泄漏的答案，并且正在静态地使用XmlSerializer。对于反序列化，内部获取正在工作。这是我关心这个类的唯一方向。谢谢。 - Rich Bennema