MongoDB3.6与.NETCore2.0下Bson字段唯一映射序列化技术问询

我明白你想要像使用[Required]特性一样，通过实体类的特性来配置MongoDB字段的唯一约束，但这里得先明确一点：MongoDB的唯一约束并不是通过实体特性直接实现的，[Required]属于数据验证特性，而唯一约束是数据库层面的索引规则，需要通过创建唯一索引来实现。下面我给你详细讲讲具体的实现方式：

1. 核心原理：唯一约束依赖数据库索引 #

MongoDB的唯一约束是通过在集合上创建唯一索引来生效的，不管是手动在数据库创建，还是通过C#驱动在代码中创建，本质都是给目标字段添加唯一索引。

2. 通过C#驱动代码创建唯一索引 #

在代码优先的开发模式下，推荐在应用启动阶段（比如Startup.cs的ConfigureServices里，或者专门的数据初始化类中）创建这个索引，确保应用运行时索引已经存在。示例代码如下：

// 假设你已经获取了MongoDatabase实例
var userCollection = mongoDatabase.GetCollection<UserAccount>("UserAccounts");

// 定义索引键：针对Username字段创建升序索引
var indexKeys = Builders<UserAccount>.IndexKeys.Ascending(u => u.Username);
// 创建索引模型，设置Unique为true开启唯一约束
var indexModel = new CreateIndexModel<UserAccount>(indexKeys, new CreateIndexOptions { Unique = true });

// 执行索引创建操作
userCollection.Indexes.CreateOne(indexModel);

3. 结合实体映射与验证 #

如果你习惯用BsonClassMap来做实体映射，可以继续保持[Required]特性或者在映射中配置必填，同时配合索引实现唯一约束：

BsonClassMap.RegisterClassMap<UserAccount>(cm =>
{
    cm.AutoMap();
    // 配置Username为必填，等价于[Required]特性
    cm.MapMember(u => u.Username)
        .SetIsRequired(true);
    // 注意：这里无法直接配置唯一约束，唯一约束还是要靠上面的索引创建代码
});

4. 处理重复数据的异常 #

当尝试插入或更新重复的Username时，MongoDB会抛出MongoWriteException，你可以在业务代码中捕获这个异常并处理：

try
{
    await userCollection.InsertOneAsync(newUserAccount);
}
catch (MongoWriteException ex) when (ex.WriteError.Category == ServerErrorCategory.DuplicateKey)
{
    // 这里可以自定义业务异常，或者返回友好提示
    throw new InvalidOperationException("用户名已被占用，请更换其他用户名", ex);
}

补充说明 #

• 如果你是手动管理数据库，也可以直接在MongoDB Shell中创建唯一索引：

  db.UserAccounts.createIndex({ Username: 1 }, { unique: true })
  

• 唯一索引会自动阻止重复值的插入/更新，但需要注意：如果字段存在null值，唯一索引只允许一个null值（除非设置了sparse: true）。

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