在前端开发中,数据校验是非常重要的一环,而 egg-validator 是一个方便、易用的数据校验工具。本文将介绍如何安装和使用这个 npm 包。
安装
在项目中安装 egg-validator,需要先安装 egg-validate:
npm i egg-validate -S
接着安装 egg-validator:
npm i egg-validator -S
使用
egg-validator 的使用分为两个部分:定义校验规则和应用校验规则。
定义校验规则
在 app/validate
目录下新建文件 user.js
,定义校验规则:
-- -------------------- ---- ------- -------------- - - ----------- - ------- - ----- --------- --------- ---- -- --------- - ----- ----------- --------- ---- -- -- ----------- - --- - ----- --------- --------- ---- -- ------- - ----- --------- --------- ---- -- --------- - ----- ----------- --------- ---- -- -- --
这里定义了两个校验规则:createRule
和 updateRule
。createRule
规则包含了 mobile
和 password
两个字段,类型分别为字符串和密码。updateRule
规则还包含了一个 id
字段,类型为数字。
应用校验规则
在控制器中使用定义好的校验规则:
-- -------------------- ---- ------- ----- ---------- - -------------------------- ----- -------------- ------- ---------- - ----- -------- - ----- - --- - - ----- ----- ---- - ----------------- ---------------------------------------------- ------ ----- ------ - ----- ------------------------------ -------- - ------- - ----- -------- - ----- - --- - - ----- ----- ---- - ----------------- ---------------------------------------------- ------ ----- ------ - ----- ------------------------------ -------- - ------- - - -------------- - ---------------
在 create
和 update
方法中,首先获取请求体中的数据,然后使用 ctx.validate
方法校验数据是否符合所定义的规则。如果校验失败,会抛出一个错误,如果校验成功,会继续执行下面的代码。
示例代码
完整的示例代码可以在 GitHub 上查看。
结论
egg-validator 是一个非常成熟、易用的数据校验工具,它能帮助我们迅速地验证数据是否符合定义的规则,避免在数据处理中出现错误。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600555df81e8991b448d2ee9