全栈项目|小书架|服务器开发-Koa2 参数校验处理

男娘i 2023-05-30 11:00 51阅读 0赞

### 为什么需要做参数校验 ###

在开发中，无论是`App`开发还是`服务器接口`开发， 我们无法去预测用户传入的数据，因此`参数(数据)校验`是开发中不可或缺的一环。

例如像`App`的注册登录表单提交页面，就要做好多层的判断。如：`用户名是否为空，用户密码是否为空，密码长度是否足够等等`。

那么有没有比较优雅的方式实现呢？

### 如何优雅实现 ###

这里使用的是基于[validator.js][]封装的`Lin-Validator`，源码是`七月老师`提供。

`Lin-Validator`拥有的功能：

*  参数校验，`header，query，path，body`中的所有参数校验

#### 参数校验 ####

验证器声明：

const { LinValidator, Rule } = require('lin-mizar');
    /**
     * 正整数 参数校验
     */
    class PositiveIntegerValidator extends LinValidator {
        constructor() {
            // 使用 this 一定要使用 super
            super()
            // 数组，且关系，也就是数组中所有都满足才能通过
            this.id = [
                new Rule('isInt', '需要是正整数', {
                    min: 1
                }),
            ]
        }
    }
    
    /**
     * 更新用户信息
     */
    class UpdateInfoValidator extends LinValidator {
      constructor () {
        super();
        this.email = [
          new Rule('isOptional'),
          new Rule('isEmail', '电子邮箱不符合规范，请输入正确的邮箱')
        ];
        this.nickname = [
          new Rule('isOptional'),
          new Rule('isLength', '昵称长度必须在2~10之间', 2, 10)
        ]
      }
    }
    module.exports = {
      PositiveIntegerValidator,
      UpdateInfoValidator
    };

自定义别名使用

// 获取书籍的喜欢状态
    router.get('/like', new Auth().m, async ctx => {
    	// 接口中传递的参数是`bkid`，为了复用 PositiveIntegerValidator 对 id 的校验
    	// 这里使用了自定义别名 id: 'bkid' 来完成验证器的调用
        const v =await new PositiveIntegerValidator().validate(ctx, {
            id: 'bkid'
        })
        const like = await Like.userLikeIt(
            ctx.auth.uid, v.get('query.bkid'))
        ctx.body = like
    })

#### 详细使用 ####

可通过`npm`安装使用[lin-mizar][]

在`package.json`中添加`lin-mizar`的初始化即可：

"dependencies": {
        "lin-mizar": "^0.2.1"
      }

在要使用校验器的文件引入

const { Rule, LinValidator, isNotEmpty } = require('lin-mizar');

【[详细使用参考：TaleLin/lin-cms-koa][TaleLin_lin-cms-koa]中的`/app/validators/`】，方便的话顺手点个`star`支持一波。

--------------------

> 咨询请加微信：轻撩即可。  
> ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0lUeGlhb2Rvbmc_size_16_color_FFFFFF_t_70]

[validator.js]: https://github.com/validatorjs/validator.js
[lin-mizar]: https://npm.taobao.org/package/lin-mizar/v/0.1.0-beta.1
[TaleLin_lin-cms-koa]: https://github.com/TaleLin/lin-cms-koa
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0lUeGlhb2Rvbmc_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20191104215406665.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0lUeGlhb2Rvbmc=,size_16,color_FFFFFF,t_70