C#中使用MongoDB序列化协变重写属性的问题如何解决？

MongoDB .NET驱动默认会扫描类继承链上的所有属性，协变重写的同名Id属性会被识别为两个独立属性，均尝试映射到BSON的_id字段，因此抛出映射冲突异常。

以下方案均为持久化层配置调整，无需修改现有实体的继承结构和协变重写逻辑。 #

方案1：显式注册BSON类映射（适合实体数量少的场景） #

在应用初始化阶段配置序列化规则即可：

// 注册基类映射，取消基类Id属性的默认映射
BsonClassMap.RegisterClassMap<Entity>(cm =>
{
    cm.AutoMap();
    cm.UnmapProperty(e => e.Id);
});

// 注册子类映射，显式指定子类重写的Id作为主键
BsonClassMap.RegisterClassMap<User>(cm =>
{
    cm.AutoMap();
    cm.MapIdProperty(u => u.Id);
});

如果存在多个继承自Entity的子类，可编写反射逻辑批量注册类映射。 #

方案2：全局自定义约定（适合实体数量多的场景） #

通过自定义序列化约定全局处理所有继承自Entity的子类，一次配置永久生效：

// 自定义协变Id处理约定
public class CovariantIdConvention : ConventionBase, IClassMapConvention
{
    public void Apply(BsonClassMap classMap)
    {
        // 仅处理Entity的子类
        if (!typeof(Entity).IsAssignableFrom(classMap.ClassType))
            return;
        
        // 查找子类自身声明的重写Id属性
        var idProperty = classMap.ClassType.GetProperty(
            nameof(Entity.Id), 
            BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly
        );

        if (idProperty != null)
        {
            // 移除基类Id的映射规则
            classMap.UnmapProperty(nameof(Entity.Id));
            // 将子类Id映射为主键字段
            classMap.MapIdProperty(idProperty.Name);
        }
    }
}

// 应用启动时全局注册约定
ConventionRegistry.Register(
    "CovariantIdHandler",
    new ConventionPack { new CovariantIdConvention() },
    type => typeof(Entity).IsAssignableFrom(type)
);

配置完成后子类的具体类型Id会正确序列化到BSON的_id字段，反序列化也能正常赋值，基类通过协变访问Id属性的逻辑不受影响。

内容的提问来源于stack exchange，提问作者Gur Galler