MongoDB自定义IBsonSerializer兼容DateTime与Nullable<DateTime>问题

我之前也碰到过一模一样的问题，完全懂你不想写两个几乎重复的序列化器的心情！其实只需要稍微改造一下现有实现，就能让同一个序列化器兼容两种类型，不用重复造轮子。

1. 改造现有序列化器，兼容可空类型 #

你需要让序列化器实现IBsonSerializer接口（而不是仅泛型版本），并重写CanSerialize方法来明确告诉MongoDB这个序列化器能处理DateTime和Nullable<DateTime>。同时在序列化/反序列化逻辑里加上对可空值的判断处理。

给你个示例实现：

public class CustomDateTimeSerializer : IBsonSerializer
{
    // 这里ValueType还是设为DateTime，但通过CanSerialize扩展支持可空类型
    public Type ValueType => typeof(DateTime);

    public bool CanSerialize(Type type)
    {
        // 明确支持两种类型
        return type == typeof(DateTime) || type == typeof(DateTime?);
    }

    public object Deserialize(BsonDeserializationContext context, BsonDeserializationArgs args)
    {
        var currentBsonType = context.Reader.GetCurrentBsonType();
        
        // 处理null值的情况
        if (currentBsonType == BsonType.Null)
        {
            context.Reader.ReadNull();
            // 如果目标是可空类型就返回null，否则抛异常（因为非可空DateTime不能为null）
            return args.NominalType == typeof(DateTime?) ? (object)null : throw new InvalidOperationException("无法将null反序列化为非可空DateTime类型");
        }

        // 这里替换成你原来的DateTime反序列化逻辑
        var timestamp = context.Reader.ReadDateTime();
        return DateTime.FromBinary(timestamp);
    }

    public void Serialize(BsonSerializationContext context, BsonSerializationArgs args, object value)
    {
        // 处理null值
        if (value == null)
        {
            // 只有目标是可空类型时才允许序列化null
            if (args.NominalType != typeof(DateTime?))
                throw new InvalidOperationException("无法将非可空DateTime序列化为null");
            context.Writer.WriteNull();
            return;
        }

        // 把值转成DateTime，不管是DateTime还是DateTime?都能处理
        var dateTime = value is DateTime dt ? dt : ((DateTime?)value).Value;
        
        // 这里替换成你原来的DateTime序列化逻辑
        context.Writer.WriteDateTime(dateTime.ToBinary());
    }
}

2. 配置使用序列化器 #

不管你的实体成员是DateTime还是Nullable<DateTime>，直接用同一个BsonSerializerAttribute标记就行：

public class EventLog
{
    [BsonSerializer(typeof(CustomDateTimeSerializer))]
    public DateTime OccurrenceTime { get; set; }

    [BsonSerializer(typeof(CustomDateTimeSerializer))]
    public DateTime? UpdateTime { get; set; }
}

为什么这个方案可行？ #

• CanSerialize方法相当于给MongoDB开了绿灯，告诉它这个序列化器能处理两种类型，不会再抛出“类型不匹配”的异常。
• 我们在序列化/反序列化时加了对null值的判断，针对可空和非可空类型做了不同处理，保证数据的正确性，不会出现非可空DateTime被赋值null的情况。

备选方案：泛型序列化器 #

如果你更偏爱泛型实现，也可以写一个泛型版本，让它支持DateTime和DateTime?：

public class GenericDateTimeSerializer<T> : SerializerBase<T> where T : struct, IConvertible
{
    public override T Deserialize(BsonDeserializationContext context, BsonDeserializationArgs args)
    {
        var bsonType = context.Reader.GetCurrentBsonType();
        if (bsonType == BsonType.Null)
        {
            context.Reader.ReadNull();
            // 只有T是可空DateTime时才返回默认值（即null）
            if (typeof(T) == typeof(DateTime?))
                return default;
            throw new InvalidOperationException("无法将null反序列化为非可空DateTime");
        }

        var dateTime = DateTime.FromBinary(context.Reader.ReadDateTime());
        return (T)Convert.ChangeType(dateTime, typeof(T));
    }

    public override void Serialize(BsonSerializationContext context, BsonSerializationArgs args, T value)
    {
        if (EqualityComparer<T>.Default.Equals(value, default))
        {
            if (typeof(T) != typeof(DateTime?))
                throw new InvalidOperationException("无法将非可空DateTime的默认值序列化为null");
            context.Writer.WriteNull();
            return;
        }

        var dateTime = (DateTime)Convert.ChangeType(value, typeof(DateTime));
        context.Writer.WriteDateTime(dateTime.ToBinary());
    }
}

使用时分别指定泛型参数：

[BsonSerializer(typeof(GenericDateTimeSerializer<DateTime>))]
public DateTime OccurrenceTime { get; set; }

[BsonSerializer(typeof(GenericDateTimeSerializer<DateTime?>))]
public DateTime? UpdateTime { get; set; }

不过第一种方案更简洁，不需要维护两个泛型实例，推荐优先用第一种。

内容的提问来源于stack exchange，提问作者Andrei Barbolin