前言
在前端开发中,我们经常需要对于用户输入进行校验和验证。这个时候,一个好用的验证库可以帮助我们大大提高开发效率。今天我们要介绍一个 npm 包 trailpack-validator,它是一个用于在 sails 中进行数据验证的轻量级 trailpack。使用它可以将数据验证逻辑从控制器中移除,大大简化代码逻辑。
安装
使用 npm 命令进行安装:
npm install --save trailpack-validator
使用
- 在 config/trailpack.js 中配置 trailpack-validator:
module.exports = { //... packs: [ require('trailpack-validator') ] //... };
- 在 api/controllers 中创建 UserController.js 文件:
-- -------------------- ---- ------- -------------- - - ----------- ---- - -- ---- ----- ------ ------ --------- - ---------------- -- ---- -------------- ----- --------- ------ ------ -------- --------- ------ --------- ------ --------- ---------- -- -- -------- -- - -- ----------- ---------------- ------- ----------- -- ----------------- -- - -- ------------- ----------------------- --- - --
在上述示例中,我们使用 req.validate() 方法执行数据验证。第一个参数是要验证的规则,其中规则支持多种语法,可以是一个简单的字符串类型(基础类型,如 string, number, boolean),也可以是一个对象,包含 type, required 等属性,还可以是一个同步或异步返回 Boolean 类型的自定义函数。
在执行验证之后,我们可以通过 then() 方法获取验证成功后的结果,通过 catch() 方法获取验证失败后的错误信息。
规则
在 trailpack-validator 中有丰富的规则语法,以下为常用的规则语法:
1. 基础类型
trailpack-validator 内置了一些基础类型的验证规则,如下:
- string: 字符串类型
- number: 数字类型
- boolean: 布尔类型
- array: 数组类型
- json: JSON 对象
通过基础类型可以简单地对数据类型进行校验:
{ name: 'string', age: 'number', male: 'boolean', tags: 'array', address: 'json', }
2. 高级类型
trailpack-validator 中还支持一些高级类型的验证规则,如下:
- email: 邮箱
- url: 网址
- uuid: UUID
- ip: IP 地址
- creditcard: 信用卡号码
- date: 日期
这些规则在实际开发中也比较常见:
{ email: {type: 'email', required: true}, website: {type: 'url', required: true}, id: {type: 'uuid', required: true}, ip: {type: 'ip', required: true}, card: {type: 'creditcard', required: true}, birth: {type: 'date', required: true}, }
3. 自定义函数
有时候我们需要对数据进行一些自定义验证,比如对密码的强度进行验证等。这个时候,我们可以传入一个同步或异步返回 Boolean 类型的验证函数进行自定义验证:
{ password: function (password) { // 规定密码长度必须大于 6 并且包含数字、字母、特殊字符 const regExp = /^(?=.*[A-Za-z])(?=.*\d)(?=.*[!@#$%^&*()_+])[A-Za-z\d!@#$%^&*()_+]{6,}$/; return regExp.test(password); }, }
结语
通过使用 trailpack-validator,我们可以将复杂数据校验逻辑从控制器移除,将其统一管理,提高代码质量和易读性。本文简单介绍了 trailpack-validator 的使用和规则语法,希望对于读者在实际开发中有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60057c4e81e8991b448ebd20