介绍
egg-validation是一款用于Egg.js平台的验证器,例如用户密码、邮箱地址、电话号码等,此外它还能解决一些其他常见验证需求。
在实际开发中,通过egg-validation提供的校验方式,可以大大提高代码的可读性和可维护性,减少bug出现的概率。
安装
使用npm命令安装egg-validation,命令如下:
npm i egg-validation --save
使用
在config中配置egg-validation
在config/config.default.js
中添加以下配置:
exports.validate = { enable: true, package: 'egg-validation', };
编写校验规则文件
在app/validate
目录下创建user.js
文件,编写校验规则。例如,我们要实现用户注册功能,需要验证用户名和密码。
-- -------------------- ---- ------- -- -------------------- ---- -------- -------------- - --- -- - ----- -------- - - --------- - ----- --------- --------- ----- -------- ---------- ---- -- ---- --- ------- ------------------------ -- --------- - ----- --------- --------- ----- -------- --------- ---- -- ---- --- ------- ------------------------ -- -- ------ - --------- -- --
在Controller中使用
通过egg-validation提供的ctx.validate()方法,可以使用刚刚定义的规则进行校验。
-- -------------------- ---- ------- -- ---------------------- ---- -------- ----- ---------- - -------------------------- ----- -------------- ------- ---------- - ----- ------------ - ----- - --- - - ----- ----- - --------- -------- - - ----------------- -- -------- ------------------------------- - --------- -------- --- -- ------- - - -------------- - ---------------
示例代码
Controller
-- -------------------- ---- ------- ---- -------- ----- ---------- - -------------------------- ----- -------------- ------- ---------- - ----- ------------ - ----- - --- - - ----- ----- - --------- -------- - - ----------------- -- -------- ------------------------------- - --------- -------- --- -- ------- - - -------------- - ---------------
校验规则
-- -------------------- ---- ------- ---- -------- -------------- - --- -- - ----- -------- - - --------- - ----- --------- --------- ----- -------- ---------- ---- -- ---- --- ------- ------------------------ -- --------- - ----- --------- --------- ----- -------- --------- ---- -- ---- --- ------- ------------------------ -- -- ------ - --------- -- --
结论
npm包egg-validation提供了Egg.js平台中便捷的校验方法,使用它能够更好地保证代码的可读性和可维护性,减少bug出现的概率。本文介绍了npm包egg-validation的安装、使用以及示例代码,相信通过学习本文,你已能够快速上手并灵活运用egg-validation进行校验。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055b1281e8991b448d8bd7