C#/.NET中MongoDB字段向后兼容：避免写入废弃字段为null

要解决废弃字段写入null的问题，同时兼容数据库中的旧数据，有两种简单有效的方法：

方法一：使用[BsonIgnoreIfNull]特性 #

直接给废弃的字段添加[BsonIgnoreIfNull]特性，MongoDB驱动会自动忽略值为null的字段，不将其写入数据库，但读取旧数据时仍能正常映射这些字段。

修改后的实体类代码：

public class Profile
{
    [BsonId]
    [BsonRepresentation(BsonType.ObjectId)]
    public string Id { get; set; } = null!;

    // Deprecate
    [Obsolete]
    [BsonElement("FirstName")]
    [JsonPropertyName("FirstName")]
    [BsonIgnoreIfNull] // 新增：值为null时忽略写入
    public string? FirstName { get; set; }

    // Deprecate
    [Obsolete]
    [BsonElement("LastName")]
    [JsonPropertyName("LastName")]
    [BsonIgnoreIfNull] // 新增：值为null时忽略写入
    public string? LastName { get; set; }

    // New field
    [BsonElement("FullName")]
    [JsonPropertyName("FullName")]
    public string? FullName { get; set; }
}

方法二：通过BsonClassMap全局配置 #

如果不想在实体类中添加额外特性，可以在应用启动时通过BsonClassMap统一配置序列化规则：

// 在应用启动代码中（如Program.cs）添加
BsonClassMap.RegisterClassMap<Profile>(cm =>
{
    cm.AutoMap();
    // 配置废弃字段为null时不写入数据库
    cm.MapMember(p => p.FirstName).SetIgnoreIfNull(true);
    cm.MapMember(p => p.LastName).SetIgnoreIfNull(true);
});

效果说明 #

两种方案都能实现：

• 写入新的Profile对象时，不会将FirstName和LastName的null值写入数据库
• 读取数据库中的旧数据时，依然能正确映射FirstName和LastName字段的值，完全兼容历史数据

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