在前端开发中，参数校验是常见的任务。虽然有多种方法可以实现参数校验，在 Express 或 Koa 等后端框架中，我们更常使用 Middleware（中间件）进行参数校验操作。本文将会介绍使用 npm 包 middleware-params-validator 进行参数校验的使用教程。
什么是 middleware-params-validator？
middleware-params-validator 是 Node.js 的中间件库，提供了一种方便的方法来校验 HTTP 请求的参数。它使用了 Joi 这个强大的校验库，可以通过简单的配置来校验请求参数，支持自定义错误信息和自定义函数校验器。
安装 middleware-params-validator
npm install middleware-params-validator --save
在 Express 中使用 middleware-params-validator
假设我们的应用程序是通过 Express 来实现的。middleware-params-validator 的最基本示例代码如下：
-- -------------------- ---- ------- ----- ------- - ------------------- ----- --------- - --------------------------------------- ----- --- - ---------- ------------------------ --------------------- ------------------ ----- ---- -- - --------------------- --- ---------------- -- -- - ---------------------- -- ---- -------- ---
这个示例中，我们使用了 JSON 解析器，然后使用了 middleware-params-validator 中间件，并将其应用到了所有路由中。这意味着无论我们访问哪个路由，middleware-params-validator 都会先执行来校验参数。当参数不符合规则时，middleware-params-validator 会自动抛出一个错误信息，否则就继续执行后面的中间件。
配置 middleware-params-validator
现在我们需要校验参数，使其符合我们的要求。middleware-params-validator 支持具有细粒度的参数规则校验：
-- -------------------- ---- -------
----- ------ - -
------ ------------
----- -------------------------------
---- -------------------------------
------ --------------------------------
---
----- ------------
--------- -------------------------------
---
------- ------------
--- ---------------------------------------
---
--
-- -- ------ -----
---------------------------这个示例中，我们使用了 Joi，声明了查询参数 (query)、请求体 (body)、路由参数 (params) 的规则。当请求中没有包含指定的参数或参数不符合规则时，middleware-params-validator 将不会放行请求，并自动抛出一个错误。
自定义校验器
在某些情况下，我们可能需要使用自定义函数来校验参数。middleware-params-validator 支持使用自定义函数，来检查请求参数是否合法。示例代码如下：
-- -------------------- ---- -------
----- ------ - ------------
--------- -----------------------
---
----- --------------- - ----- ---- ----- -- -
----- -------- - ------------------
-- --------- --- -------- -
------ -------
-
----- ----- - --- ----------- ------ --- -----------
---------------- - ----
------------
--
------------------------ ----------------- ----------------- ----- ---- -- -
-------------- -----------
---在这个示例中，我们定义了一个自定义校验器 customValidator，并将其传递给了 middleware-params-validator。当参数符合说明且自定义校验器返回 true 时，会执行后面的路由，否则会抛出一个 403 错误。
结论
middleware-params-validator 是一个简单而功能强大的参数校验中间件库。它使用 Joi 来校验参数，支持细粒度规则配置和自定义校验函数，使它成为你开发中必不可缺的工具之一。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066b5251ab1864dac668f9