C# XML序列化：无需特性/ShouldSerialize，忽略可空值类型null值

可以通过XmlAttributeOverrides动态配置序列化规则，无需修改目标类或添加任何特性，就能让可空值类型的null属性不被序列化。核心思路是给可空值类型属性设置XmlElementAttribute.IsNullable = false，这样当属性值为null时，XmlSerializer会直接跳过该元素。

实现步骤 #

1. 构建XmlAttributeOverrides对象，遍历目标类的所有公共属性：
   • 通过Nullable.GetUnderlyingType判断属性类型是否为Nullable<T>（可空值类型）；
   • 为这类属性添加XmlElementAttribute并设置IsNullable = false。
2. 使用配置好的XmlAttributeOverrides创建XmlSerializer实例（建议缓存该实例，避免重复生成动态程序集影响性能）。
3. 执行序列化操作，此时null状态的可空值类型属性不会出现在XML输出中。

完整代码示例 #

using System.Xml;
using System.Xml.Serialization;
using System.Reflection;
using System.Collections.Generic;

public class SomeObject
{
    public int? Foo { get; set; }
    public string? Bar { get; set; }
}

public class XmlSerializerHelper
{
    // 缓存XmlSerializer实例，避免重复生成动态程序集
    private static readonly Dictionary<string, XmlSerializer> _serializerCache = new();

    public static string CreateXML<T>(T objToSerialize)
    {
        var type = typeof(T);
        var cacheKey = type.FullName ?? type.Name;

        if (!_serializerCache.TryGetValue(cacheKey, out var xmlSerializer))
        {
            var overrides = new XmlAttributeOverrides();
            
            // 遍历类的所有公共实例属性
            foreach (var property in type.GetProperties(BindingFlags.Public | BindingFlags.Instance))
            {
                // 判断当前属性是否为可空值类型
                if (Nullable.GetUnderlyingType(property.PropertyType) != null)
                {
                    var xmlElementAttr = new XmlElementAttribute
                    {
                        IsNullable = false
                    };
                    overrides.Add(type, property.Name, xmlElementAttr);
                }
            }

            // 创建带自定义配置的XmlSerializer
            xmlSerializer = new XmlSerializer(type, overrides);
            _serializerCache[cacheKey] = xmlSerializer;
        }

        using StringWriter stringWriter = new();
        using XmlWriter xmlWriter = XmlWriter.Create(stringWriter, new XmlWriterSettings 
        { 
            OmitXmlDeclaration = true,
            Indent = true // 可选，让XML输出格式化对齐
        });
        xmlSerializer.Serialize(xmlWriter, objToSerialize, new XmlSerializerNamespaces(new[] { XmlQualifiedName.Empty }));
        return stringWriter.ToString();
    }
}

// 使用示例
var testObj = new SomeObject { Foo = null, Bar = "Something" };
var resultXml = XmlSerializerHelper.CreateXML(testObj);
/* 输出的XML内容：
<SomeObject>
    <Bar>Something</Bar>
</SomeObject>
*/

关键说明 #

• 对于string?这类引用类型，XmlSerializer默认不会序列化null值的属性，因此无需额外配置；
• 缓存XmlSerializer实例是必要的：每次通过XmlAttributeOverrides创建新实例都会生成动态程序集，频繁创建会导致内存占用过高；
• 该方案完全满足你的限制条件：不需要修改目标类、不需要添加ShouldSerialize*方法或任何[Xml*]特性，仅通过控制XmlSerializer的配置实现需求。

内容的提问来源于stack exchange，提问作者Scott DePouw