Mongoose 是一个用于在 Node.js 中操作 MongoDB 的 ORM 框架,它能够帮助我们快速创建模型、定义 Schema、进行 CRUD 操作等,非常方便。
在开发中,经常需要验证用户输入的数据的合法性,这时我们就需要用到 Mongoose 中的验证(validation)功能。Mongoose 支持在 Schema 中定义验证器来验证文档的合法性,包括必填、类型、长度等等。本文将详细介绍如何使用 Mongoose 实现文档级别的验证。
定义 Schema 并添加验证器
在 Mongoose 中,Schema 是定义数据结构的一种方式。可以通过以下方式来定义一个 Schema:
const mongoose = require('mongoose'); const UserSchema = new mongoose.Schema({ username: { type: String, required: true }, password: { type: String, required: true }, email: { type: String, required: true } });
上面的代码定义了一个名为 UserSchema
的用户 Schema,该 Schema 包含了用户的用户名、密码和邮箱属性。其中,用户名、密码和邮箱都是必填的属性,对应的验证器分别是 { type: String, required: true }
。
接下来,我们将详细介绍常用的 Mongoose 验证器。
必填验证器
使用 required
字段可以将一个属性定义为必填项。例如:
const UserSchema = new mongoose.Schema({ username: { type: String, required: true }, password: { type: String, required: true }, email: { type: String, required: true } });
上面的代码中,username
、password
和 email
都是必填项,如果未传入该属性或者传入了一个空字符串,保存操作都会失败。
类型验证器
Mongoose 内置了多种数据类型验证器,例如:
- String
- Number
- Date
- Boolean
- ObjectID
- Buffer
- Mixed
你可以通过以下方式使用类型验证器:
const UserSchema = new mongoose.Schema({ age: { type: Number, required: true }, birthday: { type: Date, required: true }, isVip: { type: Boolean, required: true }, userId: { type: mongoose.Schema.Types.ObjectId, required: true }, photo: { type: Buffer, required: true }, info: { type: mongoose.Schema.Types.Mixed, required: true } });
上面的代码中,age
属性必须是 Number
类型,birthday
属性必须是 Date
类型,isVip
属性必须是 Boolean
类型,userId
属性必须是 ObjectID
类型,photo
属性必须是 Buffer
类型,info
属性必须是 Mixed
类型。
长度验证器
使用 minlength
和 maxlength
字段可以设置字符串属性的最小长度和最大长度。例如:
const UserSchema = new mongoose.Schema({ username: { type: String, required: true, minlength: 3, maxlength: 10 } });
上面的代码中,username
属性必须是长度在 3 到 10 之间的字符串,如果长度小于 3 或者大于 10,保存操作都会失败。
正则表达式验证器
使用 match
字段可以定义一个正则表达式,用于验证字符串属性的格式。例如:
const UserSchema = new mongoose.Schema({ mobile: { type: String, required: true, match: /^1[3-9]\d{9}$/ } });
上面的代码中,mobile
属性必须是符合手机号码格式的字符串,否则保存操作会失败。
自定义验证器
除了内置的验证器之外,你还可以自定义验证器。例如:
-- -------------------- ---- ------- ----- ---------- - --- ----------------- ---- - ----- ------- --------- - ---------- ----------- - ------ - -- - -- - -- --- -- -------- ---- ---- -- ------- - --- --- - - ---
上面的代码中,age
属性必须是大于等于 0 小于等于 99 的数字,否则保存操作会失败。其中,validator
是一个验证函数,如果 validator
返回 false
,则验证失败,返回 true
则验证通过。message
字段是验证失败时返回的错误信息。
验证文档并处理错误
在使用 Mongoose 验证器时,需要在保存文档之前进行验证。可以通过文档实例的 validate
方法来验证文档,例如:
const user = new UserModel({ username: 'alice', password: '', email: 'alice@example.com' }); user.validate(function(error) { console.log(error); });
上面的代码中,我们创建了一个新的 User 模型,并将参数传递给构造函数来初始化用户,然后使用 validate
方法来验证用户数据是否符合 Schema 规则。如果有任何验证错误,Mongoose 将返回一个包含所有错误的数组,我们可以查看 error
参数并处理错误。
在使用 Mongoose 验证器时,通常我们需要声明一个统一的错误处理程序来集中处理错误,例如:
const user = new UserModel({ username: 'alice', password: '', email: 'alice@example.com' }); user.validate(function(error) { if (error) { // 处理错误 } else { // 保存文档 } });
上面的代码中,如果存在验证错误,则在错误处理程序中处理该错误。否则,保存文档方法将被调用。
总结与推荐
本文介绍了如何在 Mongoose 中实现文档级别的验证。我们了解了 Mongoose 的验证器,包括必填、类型、长度、正则表达式和自定义验证器。验证器可以保护我们的数据,避免了不合法的数据被插入和查询。同时,我们介绍了如何验证文档并处理错误的方法,希望可以帮助读者更好地了解 Mongoose 中的验证器并应用它们。
如果你想深入学习 Mongoose 的相关知识,推荐阅读官方文档:
示例代码:
-- -------------------- ---- ------- ----- -------- - -------------------- ----- ---------- - --- ----------------- --------- - ----- ------- --------- ---- -- --------- - ----- ------- --------- ---- -- ------ - ----- ------- --------- ---- - --- ----- --------- - ---------------------- ------------ ----- ---- - --- ----------- --------- -------- --------- --- ------ ------------------- --- ----------------------------- - -- ------- - -- ---- - ---- - -- ---- - ---
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/65b495deadd4f0e0ffd7bf8e