验证 Mongoose Schema 并显示自定义错误消息的最佳实践

Posted

技术标签:

【中文标题】验证 Mongoose Schema 并显示自定义错误消息的最佳实践【英文标题】:Best practice to validate Mongoose Schema and display custom error message 【发布时间】:2016-04-07 09:32:57 【问题描述】:

我已经开始学习 Node.js,而让我有点困惑的一件事是 Schema 验证。

验证数据并向用户显示自定义错误消息的最佳做法是什么?

假设我们有这个简单的架构:

var mongoose = require("mongoose");

// create instance of Schema
var Schema = mongoose.Schema;

// create schema
var Schema  = 
    "email" :  type: String, unique: true ,
    "password" : String,
    "created_at" : Date,
    "updated_at" : Date
;

// Create model if it doesn't exist.
module.exports = mongoose.model('User', Schema);

我希望注册用户拥有独特的电子邮件,因此我已将unique: true 添加到我的架构中。现在,如果我想向用户显示错误消息,说明他为什么没有注册,我会收到如下响应:

    "code": 11000,
    "index": 0,
    "errmsg": "E11000 duplicate key error index: my_db.users.$email_1 dup key:  : \"test@test.com\" ",
    "op": 
      "password": "xxx",
      "email": "test@test.com",
      "_id": "56895e48c978d4a10f35666a",
      "__v": 0
    

这有点乱,我想显示发送到客户端,就像这样:

"status": 
  "text": "Email test@test.com is already taken.",
  "code": 400

如何做到这一点?

【问题讨论】:

关闭code值11000,然后解析errmsg值以获取详细信息。没有你想要的那么干净,但你就是这样做的。 【参考方案1】:
const mongoose = require('mongoose')
const Schema = mongoose.Schema
const  hash  = require('../helpers/bcrypt')

const userSchema = new Schema(

email: 
    type: String,
    required: [true, 'email is required'],
    match: [/^([\w-\.]+@([\w-]+\.)+[\w-]2,4)?$/, 'Invalid email format'],
    validate: 
        validator: function(v)
            return this.model('User').findOne( email: v ).then(user => !user)
        ,
        message: props => `$props.value is already used by another user`
    ,
,
password: 
    type: String,
    required: [true, 'password is required']


)

userSchema.pre('save', function(done)
    this.password = hash(this.password)
    done()
)


module.exports = mongoose.model('User', userSchema)

【讨论】:

【参考方案2】:

处理 mongoose 中唯一约束的错误消息的最简单方法是使用插件,例如 mongoose-beautiful-unique-validation。它使错误消息看起来像普通的验证错误消息。

【讨论】:

以上是关于验证 Mongoose Schema 并显示自定义错误消息的最佳实践的主要内容,如果未能解决你的问题,请参考以下文章

为啥 Mongoose 不验证空文档?

为啥 Mongoose 不验证空文档?

Mongoose Schema 类型作为 TypeScript 的自定义接口?

Mongoose 所需的验证器失败值未定义

Mongoose 所需的验证器失败值未定义

使用 JSON-Schema 定义模式并使用 Mongoose?