XML反序列化时识别自定义NIL空值的最优方案问询

问题场景 #

现有旧XML数据如下：

<tag1>
  <subtag1>a string</subtag1>
  <subtag2>NIL</subtag2>
  <subtag3>14/06/2023</subtag3>
</tag1>
<tag1>
  <subtag1>another string</subtag1>
  <subtag2>12.33</subtag2>
  <subtag3>NIL</subtag3>
</tag1>
<tag2/>
...

反序列化时，<tag2/>能被正确识别为空值，但<subtag2>NIL</subtag2>、<subtag3>NIL</subtag3>这类节点会被反序列化为字符串"NIL"，对DateOnly类型的字段还会抛出解析异常——实际业务中这类"NIL"应被视为null。

你当前采用的代理属性方案虽然可行，但存在代码冗余问题：

[XmlIgnore]
public DateOnly? SomeDates { get; set; }

[XmlElement("subtag3")]
public string? SomeDatesString
{
    get { return SomeDates?.ToString("dd/MM/yyyy"); }
    set { SomeDates = (value == "NIL" || String.IsNullOrEmpty(value)) ? null : DateOnly.ParseExact(value, "dd/MM/yyyy", CultureInfo.InvariantCulture); }
}

更优的最佳实践方案 #

方案1：自定义类型转换器（TypeConverter） #

通过实现TypeConverter，为目标类型添加"NIL"转null的逻辑，无需编写冗余的代理属性，可复用性更强。

针对DateOnly?的转换器实现：

using System;
using System.ComponentModel;
using System.Globalization;

public class NilAwareDateOnlyConverter : TypeConverter
{
    public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType)
    {
        return sourceType == typeof(string) || base.CanConvertFrom(context, sourceType);
    }

    public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value)
    {
        if (value is string strValue)
        {
            // 忽略大小写匹配"NIL"，同时处理空字符串
            if (string.Equals(strValue, "NIL", StringComparison.OrdinalIgnoreCase) || string.IsNullOrEmpty(strValue))
                return null;
            return DateOnly.ParseExact(strValue, "dd/MM/yyyy", CultureInfo.InvariantCulture);
        }
        return base.ConvertFrom(context, culture, value);
    }

    public override object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value, Type destinationType)
    {
        if (destinationType == typeof(string) && value is DateOnly? dateValue)
        {
            return dateValue?.ToString("dd/MM/yyyy") ?? "NIL";
        }
        return base.ConvertTo(context, culture, value, destinationType);
    }
}

在实体类中使用：

直接在DateOnly?类型的属性上标记转换器即可：

public class Tag1
{
    public string Subtag1 { get; set; }
    
    // 若subtag2是decimal?类型，可编写类似的NilAwareDecimalConverter
    public decimal? Subtag2 { get; set; }

    [TypeConverter(typeof(NilAwareDateOnlyConverter))]
    public DateOnly? Subtag3 { get; set; }
}

方案2：自定义XmlSerializable实现 #

如果需要更精细控制XML的读写逻辑，可实现IXmlSerializable接口，适用于复杂场景：

using System;
using System.Globalization;
using System.Xml;
using System.Xml.Serialization;

public class DateOnlyNilWrapper : IXmlSerializable
{
    public DateOnly? Value { get; set; }

    public XmlSchema GetSchema() => null;

    public void ReadXml(XmlReader reader)
    {
        var content = reader.ReadElementContentAsString();
        Value = string.Equals(content, "NIL", StringComparison.OrdinalIgnoreCase) || string.IsNullOrEmpty(content)
            ? null
            : DateOnly.ParseExact(content, "dd/MM/yyyy", CultureInfo.InvariantCulture);
    }

    public void WriteXml(XmlWriter writer)
    {
        writer.WriteString(Value?.ToString("dd/MM/yyyy") ?? "NIL");
    }
}

在实体类中使用：

public class Tag1
{
    public string Subtag1 { get; set; }
    public decimal? Subtag2 { get; set; }
    public DateOnlyNilWrapper Subtag3 { get; set; }
}

方案对比 #

• 代理属性方案：适合单个字段的临时处理，但代码冗余，维护成本高。
• 类型转换器方案：符合DRY原则，一次定义可复用在多个属性/类型上，代码更简洁。
• IXmlSerializable方案：适合需要完全自定义XML序列化逻辑的复杂场景，灵活性最高。

内容的提问来源于stack exchange，提问作者Fariz Awi