58

我正在尝试决定如何处理 Mongoose 中的验证错误。

使用节点验证器的自定义错误消息

我已经使用node-validator定义了自己的验证规则，例如：

UserSchema.path('username')
  .validate(function (username) {
    return validator.check(username).notEmpty()
  }, 'Username cannot be blank')

这将生成如下所示的错误：

  username: 
   { message: 'Validator "Username cannot be blank" failed for path username',
     name: 'ValidatorError',
     path: 'username',
     type: 'Username cannot be blank' },

使用猫鼬验证器

但是，node-validator 提供了自己的错误消息。如果我使用mongoose-validator Node 模块将 node-validator 直接插入到我的架构中，那么我可以直接使用这些错误消息：

var UserSchema = new Schema({
  name: { type: String, validate: [validate('notEmpty')] }
});

这将生成如下所示的错误消息：

  name: 
   { message: 'Validator "String is empty" failed for path name',
     name: 'ValidatorError',
     path: 'name',
     type: 'String is empty' } }

我也可以在这里提供自定义错误消息：

var UserSchema = new Schema({
  name: { type: String, validate: [validate({message: 'Name cannot be blank' }, 'notEmpty')] }
});

猫鼬required旗

Mongoose 允许您根据需要定义一个字段：

var UserSchema = new Schema({
  name: { type: String, required: true }
});

这将生成如下所示的错误消息：

  name: 
   { message: 'Validator "required" failed for path name',
     name: 'ValidatorError',
     path: 'name',
     type: 'required' } }

问题

感觉好像这些验证器希望您使用它们的内置错误消息。例如，我想声明一个required如上所示的字段，但我找不到自定义错误消息的方法。而且 mongoose-validator 模块直到最近才支持自定义消息，这让我认为它们是模型级别的反模式。

实现这些验证器的最佳方式是什么？我应该让他们产生自己的错误，然后以某种方式解释它们吗？

4

9 回答 9

36

在这一点上，相信猫鼬如何处理错误似乎是合乎逻辑的。

您不希望您的模型处理错误消息。表示层（控制器？）应该依赖于type决定哪个是最好的用户友好消息显示（考虑 i18n）。

还有一种情况是使用中间件进行验证。在这种情况下，将出现在您的控制器上的错误消息是您传递给next()回调的任何内容。

因此，对于中间件，虽然没有记录，但为了在您的模型中保持一致的验证 API，您应该直接使用 Mongoose 的 Error 构造函数：

var mongoose = require('mongoose');
var ValidationError = mongoose.Error.ValidationError;
var ValidatorError  = mongoose.Error.ValidatorError;

schema.pre('save', function (next) {
  if (/someregex/i.test(this.email)) {
    var error = new ValidationError(this);
    error.errors.email = new ValidatorError('email', 'Email is not valid', 'notvalid', this.email);
    return next(error);
  }

  next();
});

这样，即使验证错误源自中间件，也可以保证一致的验证错误处理。

为了正确地将错误消息与类型匹配，我将创建一个枚举，它将充当所有可能类型的静态映射：

// my controller.js

var ValidationErrors = {
  REQUIRED: 'required',
  NOTVALID: 'notvalid',
  /* ... */
};


app.post('/register', function(req, res){
  var user = new userModel.Model(req.body);

  user.save(function(err){
    if (err) {
      var errMessage = '';

      // go through all the errors...
      for (var errName in err.errors) {
        switch(err.errors[errName].type) {
          case ValidationErrors.REQUIRED:
            errMessage = i18n('Field is required');
            break;
          case ValidationErrors.NOTVALID:
            errMessage = i18n('Field is not valid');
            break;
        }
      }
      res.send(errMessage);

    }
  });
});
于 2013-06-10T12:43:33.273 回答
22

我知道验证器插件可能很有帮助，但我认为猫鼬验证的东西比它真正的复杂更令人生畏。从外面看它肯定看起来很复杂，但一旦你开始撕开它，它并没有那么糟糕。

如果您查看下面的代码，您将看到如何使用内置验证器返回自定义错误消息的示例。

您所要做的就是在设置字段时使用您自己的自定义错误消息设置第二个参数。

查看下面的required和minlength和maxlength字段以查看我如何设置自定义错误消息，然后查看以下方法以了解如何访问错误对象或将其发送到前端：

// Grab dependencies:
var mongoose = require('mongoose');

// Setup a schema:
var UserSchema = new mongoose.Schema (
    {
        username: {
            type: String,
            minlength: [2, 'Username must be at least 2 characters.'],
            maxlength: [20, 'Username must be less than 20 characters.'],
            required: [true, 'Your username cannot be blank.'],
            trim: true,
            unique: true,
            dropDups: true,
        }, // end username field
    },
    {
        timestamps: true,
    },
);

// Export the schema:
module.exports = mongoose.model('User', UserSchema);

以上设置我们的字段以具有自定义错误消息。但是我们如何访问它们或将它们发送到我们的前端？我们可以在我们的服务器控制器中设置以下方法，其响应数据被发送回 Angular：

var myControllerMethods = {
    register : function(req, res) {
        // Create a user based on the schema we created:
        User.create(req.body)
            .then(function(newUser) {
                console.log('New User Created!', newUser);
                res.json(newUser);
            })
            .catch(function(err) {
                if (err.name == 'ValidationError') {
                    console.error('Error Validating!', err);
                    res.status(422).json(err);
                } else {
                    console.error(err);
                    res.status(500).json(err);
                }
            })
    },
};

如果你运行上面的代码，并且我们的任何 mongoose 验证器没有通过，error( err) 对象将被 Promise.catch()中的 抓取。如果您在控制台记录此错误，您将在该对象中看到我们的自定义消息，具体取决于标记的错误。

注意：上面的例子只是为了向 Mongoose 拥有的已经内置的验证添加自定义验证消息（如required、minlength等maxlength）。

如果您想创建更高级的验证，例如根据正则表达式模式验证字段等，那么您必须创建自定义validator函数。

请参阅此链接中的“自定义验证器”部分，了解如何在您的字段中添加验证器的一个很好的示例：http: //mongoosejs.com/docs/validation.html。

注意：您也可以使用“预保存挂钩”和“实例方法”，但这超出了本问题的范围，内置验证器和“自定义验证器”（上述链接）是更简单的路线。

希望这可以帮助！

于 2017-01-31T10:23:56.257 回答
4

来自猫鼬：https ://github.com/leepowellcouk/mongoose-validator

错误消息自定义错误消息现在回到 0.2.1 并且可以通过选项对象设置：

validate({message: "String should be between 3 and 50 characters"}, 'len', 3, 50)

我是如何实现的：

var emailValidator = [validate({message: "Email Address should be between 5 and 64 characters"},'len', 5, 64), validate({message: "Email Address is not correct"},'isEmail')];

var XXXX = new Schema({
email : {type: String, required: true, validate: emailValidator} });

我的前端处理的是必需的，所以我从没想过猫鼬的“必需”错误会出现在用户面前，更像是后端的安全防护。

于 2013-04-07T13:36:14.210 回答
3

您需要问自己的问题是，谁首先对导致错误负责？

如果这种情况发生在您的系统中，您可以控制，只需像往常一样让错误发生在您身上，并在您进行过程中清除错误，但我怀疑您正在做一个面向现实世界用户的应用程序和你想清理他们的输入。

我建议客户端在将输入发送到服务器之前检查输入是否正确，并显示很好的帮助消息，例如“您的用户名必须介于 x 和 y 字符之间”。

然后在服务器端，您希望在 99% 的情况下输入将直接来自您的清理客户端，因此您仍然使用您已经建议的技术对其进行验证，但如果出现错误，您只需返回一般错误消息到用户界面 - 因为您相信您的用户界面会显示帮助消息，所以验证错误必须是由错误或黑客攻击引起的。

请记住记录所有服务器端验证错误，因为它们可能是严重的错误或正在寻找漏洞的人。

于 2013-03-07T20:54:17.963 回答
2

警告：从 Mongoose 4.1.3 开始，函数 ValidatorError 的签名已经完全改变，以下信息不再适用：

从 Mongoose 3.8.12 开始，函数 ValidatorError 的签名是：

function ValidatorError (path, msg, type, val)

其中 type 可以是“notvalid”或“required”

例如，如果您的“电子邮件”字段验证引发验证错误，您可以简单地执行以下操作：

var error = new ValidationError(this);
error.errors.email = 
      new ValidatorError('email', "Your err message.", 'notvalid', this.email);
于 2014-11-04T10:57:00.627 回答
2

请参阅hmv包，它可以帮助您自定义 mongoose 错误消息模板，包括唯一索引错误：

template : {PATH_NAME} must be at least {MIN_LENGTH} characters long
schema   : { fullname : { type : String, min : 3, $name : 'Full name' } }
message  : Full name must be at least 3 characters long

template : {PATH_NAME} {VALUE} have been used, please choose another
schema   : { username : { type : String, unique : true } }
message  : username MrBean have been used, please choose another

并且特别支持本地化，例如越南语：

template : {PATH_NAME} dài ít nhất {MIN_LENGTH} kí tự
schema   : { fullname : { type : String, min : 3, $name : 'tên tài khoản' } }
message  : Tên tài khoản dài ít nhất 5 kí tự

好处是您只需要自定义一次消息模板，而不是像以前的方法那样自定义每个模式的每个字段。

于 2018-12-16T06:33:57.163 回答
2

从 mongoose 4.5.0 开始，Document#invalidate 返回一个 ValidationError。看到这个 https://github.com/Automattic/mongoose/issues/3964

此外，当尝试使 findOneAndUpdate 查询挂钩无效时，您可以执行以下操作：

// pass null because there is no document instance
let err = new ValidationError(null)
err.errors[path] = new ValidatorError({
    path: 'postalCode',
    message: 'postalCode not supported on zones',
    type: 'notvalid',
    value,
})
throw(err)
于 2016-06-18T00:17:57.300 回答
1

你也可以在这里使用 joi 。对于验证节点应用程序中的模式，它实际上是非常有用的包。

例如：

const Joi = require("joi");

const validateUser = user => {

 const Schema = {
  email: Joi.string().email().required(),
  name: Joi.string().min(3).max(20).required(),
  password: Joi.string().min(8).max(25).required()
 }

 return Joi.validate(user, Schema);

}
于 2019-09-17T11:37:20.300 回答
0

// 我的 controller.js 或任何你的路由处理程序文件
// 这在 1 行中处理多个模式级别验证

// user object created from model
let user = new Users({
firstName: req.body.firstName,
lastName: req.body.lastName 
...

});

  // Since the Error response are in <Model Name>:<Schema Name>:<Error Message>, ... 
  var err = user.validateSync();
  if (err && err.message) return res.send(err.message.split(':')[2].split(',')[0]);
于 2020-05-14T23:28:20.680 回答