Mongoose 之文档验证的使用及常见错误场景分析-JavaScript中文网-JavaScript教程资源分享门户

在使用 MongoDB 数据库时，我们经常使用 Mongoose 这个 ODM(对象文档映射) 工具来操作数据。Mongoose 在操作 MongoDB 数据库时，非常方便和灵活。其中，Mongoose 的文档验证，可以很好地保证数据的正确性和完整性。本文主要介绍 Mongoose 的文档验证的使用方法和常见错误场景的分析。

文档验证基础

在定义 Mongoose Schema 时，我们可以定义字段的类型、默认值、必选项等属性。除此之外，我们还可以使用 Mongoose 提供的验证器，对字段值进行验证。常见的验证类型如下所示：

String：字符串类型
Number：数字类型
Date：日期类型
Buffer：二进制数据类型
Boolean：布尔类型
Mixed：混合类型（可以存储任意数据类型）
ObjectId：对象 ID 类型
Array：数组类型

在 Mongoose 中，定义文档验证规则，需要使用 Schema 的 validate API。 validate API 接受两个参数：第一个参数是验证逻辑函数，第二个参数是错误提示信息。在验证逻辑函数中，需要使用 callback 回调返回验证结果。下面是一个使用 validate API 定义的验证逻辑示例代码：

// javascriptcn.com 代码示例
const mongoose = require('mongoose');

const userSchema = new mongoose.Schema({
  name: {
    type: String,
    required: true,
    validate: [function(value) {
      return value && value.length > 0;
    }, 'Name cannot be empty!']
  },
  age: {
    type: Number,
    required: true,
    max: 100
  }
});

const User = mongoose.model('User', userSchema);

const user = new User({ name: '', age: 101 });
user.save(function(error) {
  console.log(error); // Name cannot be empty!, age must be less than or equal to 100
});

在上面示例代码中，我们定义了 User 模型的 name 和 age 字段的验证规则。name 字段必须非空，age 字段必须小于等于 100。如果在 save 方法中，无法通过验证，Mongoose 会返回错误信息。

需要注意的是，文档验证只在保存数据时进行校验，而不会在更新数据时执行。如果需要在更新数据时也执行验证操作，需要在更新操作前，先执行 validate 方法。

常见错误场景分析

在 Mongoose 的文档验证过程中，会遇到一些特定的错误类型。下面是常见的错误场景和解决方法：

错误信息没有输出

在使用 Mongoose 进行文档验证时，如果校验出现错误，Mongoose 会输出错误信息到控制台。但是，在某些情况下，错误信息会没有输出。这种情况通常出现在 validate 函数中使用箭头函数的情况下。解决方法是使用 function 关键字定义 validate 函数，而不是使用箭头函数。

验证器对 null 值不起作用

在使用 Mongoose 进行文档验证时，如果字段类型是 string、number 或者 date 类型，那么当字段类型为 null 时，对应的验证器并不会执行验证操作。解决方法是在定义 Schema 的时候，使用类型为 Schema.Types.Mixed 的验证器进行验证操作。

验证器函数中的 this 指向错误

在 Mongoose 中，编写文档验证逻辑时，我们可以使用 this 指向当前文档对象。但是，在使用箭头函数定义逻辑函数时，this 指向错误。解决方法是使用 function 关键字定义逻辑函数，或者使用 bind 进行绑定。

文档验证不生效

在 Mongoose 中，文档验证需要在 Model 的 save 方法调用前进行校验。如果从数据库中读取已有数据进行操作，或者使用 update 或者 updateOne 等方法，文档验证不会执行。解决方法是使用官方建议的方式，在调用 update 或者 updateOne 方法前，先调用 validate 方法，对文档进行校验。

// javascriptcn.com 代码示例
const user = await User.findById(userId);
user.name = '';
const validationError = user.validateSync();
if(validationError) {
  console.log(validationError); // ValidationError: User validation failed: name: Name cannot be empty!
  return;
}

user.age = 101;
user.updateOne({ name: user.name, age: user.age }, function(error) {
  console.log(error); // age must be less than or equal to 100
});

总结

Mongoose 的文档验证功能可以很好地保证数据的正确性和完整性。在使用文档验证过程中，需要避免使用箭头函数，使用类型为 Schema.Types.Mixed 的验证器来处理 null 值，正确绑定 this 指向，使用 validate 方法对文档进行校验。通过本文的介绍和示例代码，相信读者可以更好地掌握 Mongoose 的文档验证的使用方法和常见错误场景的分析。

来源：JavaScript中文网，转载请注明来源本文地址：https://www.javascriptcn.com/post/652da11c7d4982a6ebedfc6e