JSON Schema 是一种用于描述 JSON 数据的格式约束标准，它能够完整地描述一个 JSON 数据的结构、属性以及其它元数据，从而使得 JSON 数据更加结构化、规范化，便于自动化处理和验证。json-schema-middleware 包是一款 JavaScript 库，它提供了一种简单高效的方式来检验 Express 应用程序中的 JSON 数据是否符合预定的 JSON Schema 规范。
为什么选择 json-schema-middleware
使用 json-schema-middleware 可以让我们在处理 JSON 格式数据时更加规范和方便，特点如下：
- 使用简单，只需要几段代码就可以快速集成到 Express 应用程序中。
- 支持自定义 JSON Schema 规范，开发人员可以自行定义所需的 JSON Schema 并整体应用到全局，提高了数据的规范性和格式化程度。
- 检验规范全面，json-schema-middleware 支持多种数据类型、数据格式的检验，包括数组、字符串、对象等，并提供了丰富的判断方式，例如 minLength、maximum 等。
json-schema-middleware 安装
可以通过 npm 包管理器来获取，使用以下命令进行安装：
npm install --save json-schema-middleware
json-schema-middleware 使用
-- -------------------- ---- -------
----- ------- - -------------------
----- --- - ----------
----- ---------- - -----------------------
----- -------------------- - ----------------------------------
------------------------------- --------- ----- ----
---------------------------
-- -- ---- ------ --
--- ---------- - -
---------- ------------------------------------------
------- ---------
------------- -
----- -
------- ---------
------------ --
------------ ---
-------------- ----- --- - ------ ------ ------ -- ------------
--
------- -
------- ---------
------------ --
------------ ---
-------------- ----- ----- - ------ ------ -- ------------
-
--
----------- ------ -------
--
-- -- ---- ------ ---
---------------------------------------------------------
---------------------------------------------- ----- ---------- ----
-- ------
----------------- ----- ---- -- -
-- --------------- --- --------
-- ---------------------- -
-------------------------------------------
-------
-
-- ------------------------
--- - --- ---- - - --------------
--- ------ - - --- ---- --
-----------------
---
---------------- -- -- ------------------- -- --------- -- ---- ---------上述代码实现了以下步骤：
- 添加了 bodyParser 中间件，用于解析 POST 请求的 JSON 数据。
- 定义了一个 userSchema，它描述了一个用户数据的基本结构，包括 id 和 name 两个属性。
- 添加了 JsonSchemaMiddleware.validateRequest 中间件，在用户请求 /user 路由时，会自动检验 REQUEST BODY 中的 user 字段是否符合定义的 userSchema 规范，如果不符合，则返回 400 错误码及相关错误信息，否则继续执行下一步。
- 处理 /user 路由的 POST 请求，如果数据格式合法，则可以对请求参数进行相关操作和处理，否则直接返回错误信息。
json-schema-middleware 配置详解
在上面的示例代码中，我们使用了 JsonSchemaMiddleware.validateRequest 中间件来对请求数据进行检验，这里对 json-schema-middleware 的常用配置进行详细解释：
JsonSchemaMiddleware.validateENV 环境检验
app.use(JsonSchemaMiddleware.validateENV(env));
- env：可选字符串参数，指定当前环境名称，例如 "development", "production"。
JsonSchemaMiddleware.validateRequest 请求检验
app.use(JsonSchemaMiddleware.validateRequest(requestSchema, responseSchema, errorSchema));
- requestSchema：可选参数，JSON Schema 格式的数据结构，用于验证请求的 body 参数是否满足规范。默认值为 {}，即无需进行验证。支持字符串和数组类型，表示多个 JSON Schema 的合并验证。
- responseSchema：可选参数，JSON Schema 格式的数据结构，用于验证响应的 body 参数是否满足规范。默认值为 {}，即无需进行验证。支持数字和字符串类型，表示根据响应状态进行验证（例如 200、400、500 等）。
- errorSchema：可选参数，JSON Schema 格式的数据结构，用于验证错误响应的 body 参数是否满足规范。默认值为 {}，即无需进行验证。支持数字和字符串类型，表示根据响应状态进行验证（例如 400、500 等）。
结语
json-schema-middleware 提供了一种非常方便的方式来验证数据结构的格式化和规范性。通过使用 json-schema-middleware，我们可以在实际的开发过程中，更加方便、快捷地处理数据格式的问题，从而减轻了开发人员在数据处理上的负担。同时，json-schema-middleware 包也提供了配置丰富、易于使用的特性，可以帮助我们更好地利用各种技术手段，优化我们的应用程序的效率和性能。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005564381e8991b448d3267