Mongoose创建Schema时设置的unique唯一约束不生效该如何解决？

问题原因与解决方法 #

Mongoose中的unique是数据库层面的索引约束，和required这类应用层校验器的实现逻辑完全不同，不生效问题通常是索引未成功创建或错误捕获逻辑遗漏导致的，具体排查解决方法如下：

• 检查Mongoose连接的autoIndex配置
  Mongoose自动创建索引依赖autoIndex配置项，开发环境默认开启，生产环境默认关闭，若你在连接数据库时手动配置了autoIndex: false，Mongoose不会自动为unique字段创建索引，约束自然不生效。
  解决方法：
  开发环境可在连接配置中开启autoIndex：

await mongoose.connect('你的MongoDB连接地址', {
  autoIndex: true,
  // 其余配置项
})

生产环境建议主动调用模型的createIndexes方法手动创建索引，避免启动时建索引影响服务性能：

const AdminModel = model<AdminDocument>('Admin', AdminSchema);
// 定义模型后主动触发索引创建
await AdminModel.createIndexes();
// 监听索引创建错误，排查问题
AdminModel.on('index', err => {
  if (err) console.error('Admin索引创建失败：', err);
})
export default AdminModel;

• 确认索引是否在数据库中成功创建
  你可以直接进入MongoDB Shell执行以下命令，查看admins集合的索引列表，确认是否存在username和email的唯一索引：

use 你的数据库名
db.admins.getIndexes()

如果查询结果中没有对应字段的unique: true索引，说明索引创建失败，可通过上述index事件监听的日志排查具体原因。

• 检查错误捕获逻辑
  unique约束触发的错误和required校验错误类型不同：
  • required校验失败抛出的是Mongoose的ValidationError，属于应用层校验错误
  • unique约束触发的是MongoDB原生的E11000错误，错误码为11000，不属于Mongoose校验错误范畴
    若你的错误捕获逻辑如果只处理了ValidationError，就会误以为约束没有生效，需要单独处理该类错误：

try {
  await AdminModel.create(用户数据);
} catch (err) {
  // 处理唯一键重复错误
  if (err.code === 11000) {
    const repeatField = Object.keys(err.keyPattern)[0];
    console.log(`${repeatField}字段值已存在，不可重复`);
  }
  // 处理其他错误
  if (err.name === 'ValidationError') {
    // 处理required等校验错误
  }
}

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