简介
前端开发中，我们经常需要向后端接口发送请求，这时候就需要对请求参数进行校验。在 Node.js 中，有一个非常实用的 npm 包叫做 req-check，它可以轻松地对 HTTP 请求参数进行校验，一旦请求参数不符合规范就会抛出错误。本文就来介绍一下如何使用 req-check 包进行请求参数校验。
安装
安装 req-check 包非常简单，只需要在终端输入下面的命令即可：
npm install req-check
基本用法
接下来我们就开始使用 req-check 来校验请求参数。
引入包
我们首先需要在代码中引用 req-check 包，可以使用 require() 函数引入：
const reqcheck = require('req-check');构造校验规则
req-check 通过一个 rules 对象来定义校验规则，下面是一个示例的 rules 对象：
-- -------------------- ---- -------
----- ----- - -
----- ------------------
---- -------------------
------- ----------------
------ -
--------- -----
-------------- -
-------- ---------
-
-
--可以看到，rules 对象采用了 JSON 的格式进行构造，其中每个元素都是一个键值对，键表示参数名称，值表示该参数对应的校验规则。这里的校验规则也非常简单，使用了像 required、string、integer、in 等几个简单的规则。
执行校验
当我们有了校验规则之后，就可以开始执行校验了。req-check 提供了一个 check() 函数来执行校验，check() 函数接受两个参数：req 和 rules。
-- -------------------- ---- -------
----- --- - -
------ -
----- -----
---- -----
------- ----
------ -------------
-
--
----- ------ - ------------------- -------这里的 req 对象代表了一个 HTTP 请求对象，其中的 query 对象就是请求参数。当我们调用 check() 函数并传入 req 和 rules 时，req-check 就会根据 rules 对象来对请求参数进行校验。如果校验失败，check() 函数会返回一个包含错误信息的数组 errors。
处理错误信息
最后，我们需要在代码中处理校验错误的情况。根据返回的 errors 数组，我们可以判断请求的参数有哪些不符合规范，进而做出相应的处理。下面是一个简单的处理错误信息的示例代码：
if (errors.length > 0) {
const error = errors[0];
console.log(`参数 ${error.param} 校验失败：${error.msg}`);
}这里只是简单地输出了第一个错误信息，实际使用时还需要根据具体情况进行相应的处理。
高级用法
除了上面介绍的基础用法，req-check 还提供了一些高级功能，本节将对其中比较常用的两个功能进行介绍。
手动添加校验规则
有时候我们需要对一些自定义的参数进行校验，此时可以使用 addRule() 函数手动添加校验规则。addRule() 函数接受两个参数：rule 和 validator。
reqcheck.addRule('username', (paramValue) => {
if (!/^[a-z]+$/.test(paramValue)) {
throw new Error('用户名必须为纯小写字母');
}
});这里我们使用 addRule() 函数添加了一个新的校验规则，它可以确保用户名只包含小写字母。当我们执行 check() 函数时，req-check 会自动调用这个新添加的规则进行校验。
自定义错误处理器
req-check 的默认错误处理器只是简单地将错误信息放入一个数组中返回，有时候我们需要对错误信息进行自定义处理，比如抛出异常或者使用日志记录。此时我们可以使用自定义错误处理器来实现这个功能。
-- -------------------- ---- -------
----- ------------- - -------- -- -
-- -------------- - -- -
----- ----- - ----------
----- --- --------- -------------- --------------------
-
--
----- --- - -
------ -
----- -----
---- -----
------- ----
------ -------------
-
--
----- ------ - ------------------- ------ ---------------这里我们定义了一个 customHandler() 函数来自定义错误处理方式，它将第一个错误信息抛出为异常。当我们执行 check() 函数时，将这个处理函数作为第三个参数传入即可。这个处理函数会在校验失败时被调用，它可以接收一个包含错误信息的数组作为参数。
示例代码
最后，附上一个基于 req-check 的示例代码，它模拟了一个简单的 HTTP 请求并对请求参数进行了校验。
-- -------------------- ---- -------
----- -------- - ---------------------
----- ----- - -
----- ------------------
---- -------------------
------- ----------------
------ -
--------- -----
-------------- -
-------- ---------
-
-
--
---------------------------- ------------ -- -
-- ------------------------------ -
----- --- ---------------------
-
---
----- ------------- - -------- -- -
-- -------------- - -- -
----- ----- - ----------
----- --- --------- -------------- --------------------
-
--
----- --- - -
------ -
----- -----
---- -----
------- ----
------ -------------
-
--
----- ------ - ------------------- ------ ---------------
-- -------------- - -- -
----- ----- - ----------
--------------- -------------- --------------------
- ---- -
--------------------
-总结
本文介绍了 npm 包 req-check 的使用教程，包括了基本用法和高级用法两部分内容。req-check 可以帮助我们轻松地对 HTTP 请求参数进行校验，减少了代码中的冗余逻辑，提高了开发效率。需要注意的是，req-check 只能用于 Node.js 环境，浏览器端需要使用其他方案进行请求参数校验。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005632581e8991b448e0ec5