C# XML反序列化时如何处理枚举类型的Null值？

我们通过XSD生成C#模型，其中包含枚举类型。第三方提供的XML中部分属性（包括枚举属性）允许缺失（支持Null），但使用XmlSerializer反序列化时，缺失的枚举属性会被自动设为枚举的第一个值。我们需要无需手动修改生成模型、可全局应用的处理方式，避免逐个版本逐个枚举属性修改，目前考虑手动修改版本化模型，但这并非最优方案。

相关代码示例 #

生成的C#模型代码 #

[System.CodeDom.Compiler.GeneratedCodeAttribute("xsd", "4.8.3928.0")]
[System.SerializableAttribute()]
[System.Diagnostics.DebuggerStepThroughAttribute()]
[System.ComponentModel.DesignerCategoryAttribute("code")]
[System.Xml.Serialization.XmlTypeAttribute(Namespace="urn:iso:std:iso:20022:tech:xsd:head.001.001.02")]
public partial class PostalAddress24
{
    public AddressType3Choice? AdrTp {
        get {
            return this.adrTpField;
        }
        set {
            this.adrTpField = value;
        }
    }
}

/// <remarks/>
[System.CodeDom.Compiler.GeneratedCodeAttribute("xsd", "4.8.3928.0")]
[System.SerializableAttribute()]
[System.Diagnostics.DebuggerStepThroughAttribute()]
[System.ComponentModel.DesignerCategoryAttribute("code")]
[System.Xml.Serialization.XmlTypeAttribute(Namespace="urn:iso:std:iso:20022:tech:xsd:head.001.001.02")]
public partial class AddressType3Choice {
    
    private object itemField;
    
    /// <remarks/>
    [System.Xml.Serialization.XmlElementAttribute("Cd", typeof(AddressType2Code))]
    [System.Xml.Serialization.XmlElementAttribute("Prtry", typeof(GenericIdentification30))]
    public object Item {
        get {
            return this.itemField;
        }
        set {
            this.itemField = value;
        }
    }
}

/// <remarks/>
[System.CodeDom.Compiler.GeneratedCodeAttribute("xsd", "4.8.3928.0")]
[System.SerializableAttribute()]   
[System.Xml.Serialization.XmlTypeAttribute(Namespace="urn:iso:std:iso:20022:tech:xsd:head.001.001.02")]
public enum AddressType2Code {
        
        /// <remarks/>
        ADDR,
        
        /// <remarks/>
        PBOX,
        
        /// <remarks/>
        HOME,
        
        /// <remarks/>
        BIZZ,
        
        /// <remarks/>
        MLTO,
        
        /// <remarks/>
        DLVY,
} 

第三方XML示例（AdrTp属性缺失） #

<PstlAdr>
   <Ctry>GB</Ctry>
</PstlAdr>

可行解决方案 #

方案1：使用XmlAttributeOverrides全局配置可空规则 #

XmlSerializer支持通过XmlAttributeOverrides动态修改序列化/反序列化行为，无需修改生成的模型代码。可以全局为枚举类型的属性添加IsNullable = true配置，让缺失元素时返回Null而非枚举默认值。

示例代码

// 全局配置覆盖规则
var overrides = new XmlAttributeOverrides();

// 配置AddressType3Choice的Item属性，允许枚举元素为空
var itemAttrs = new XmlAttributes();
itemAttrs.XmlElements.Add(new XmlElementAttribute("Cd", typeof(AddressType2Code)) { IsNullable = true });
itemAttrs.XmlElements.Add(new XmlElementAttribute("Prtry", typeof(GenericIdentification30)) { IsNullable = true });
overrides.Add(typeof(AddressType3Choice), "Item", itemAttrs);

// 配置PostalAddress24的AdrTp属性，确保可空处理
var adrTpAttrs = new XmlAttributes();
adrTpAttrs.XmlElement = new XmlElementAttribute { IsNullable = true };
overrides.Add(typeof(PostalAddress24), "AdrTp", adrTpAttrs);

// 创建带配置的XmlSerializer（注意：缓存该实例避免重复创建导致内存泄漏）
var serializer = new XmlSerializer(typeof(PostalAddress24), overrides);

// 执行反序列化
using (var reader = new StringReader(xmlContent))
{
    var address = (PostalAddress24)serializer.Deserialize(reader);
}

如果要实现完全自动化的全局配置，可以通过反射遍历所有生成的类，自动识别枚举类型的属性并添加IsNullable = true的规则，无需逐个类手动配置。

方案2：自定义XmlSerializationReader（底层全局处理） #

通过继承XmlSerializationReader并重写枚举读取逻辑，让缺失元素时返回Null。这种方式需要自定义序列化程序集，步骤稍复杂，但能实现完全全局的生效：

1. 使用Sgen.exe生成默认的序列化程序集；
2. 反编译该程序集，找到读取枚举的方法，修改逻辑使其在元素缺失时返回Null；
3. 重新编译自定义的序列化程序集并替换默认程序集。

方案3：全局注册枚举类型转换器 #

创建通用的可空枚举转换器，在程序启动时为所有枚举类型注册，让XmlSerializer在遇到缺失元素时返回Null：

示例代码

// 通用可空枚举转换器
public class NullableEnumConverter<T> : TypeConverter where T : struct, Enum
{
    public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType)
    {
        if (sourceType == typeof(string))
            return true;
        return base.CanConvertFrom(context, sourceType);
    }

    public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value)
    {
        if (value is string str && string.IsNullOrEmpty(str))
            return null;
        return Enum.Parse(typeof(T), (string)value);
    }
}

// 程序启动时批量注册所有枚举类型的转换器
var enumTypes = Assembly.GetExecutingAssembly().GetTypes().Where(t => t.IsEnum);
foreach (var enumType in enumTypes)
{
    var converterType = typeof(NullableEnumConverter<>).MakeGenericType(enumType);
    TypeDescriptor.AddAttributes(enumType, new TypeConverterAttribute(converterType));
}

该方案需配合XmlAttributeOverrides使用，确保XmlSerializer会调用类型转换器处理枚举属性。

内容的提问来源于stack exchange，提问作者Tim Butterfield