在前端开发中，对于传输和接收的 JSON 字符串格式是否合法，我们通常需要做数据校验。而 npm 包 assert-my-json-valid 可以帮助我们快速进行 JSON 格式校验。
本文将介绍 assert-my-json-valid 的使用教程，包括安装、引入、校验规则定义、使用方式以及常用选项等内容，同时提供代码示例以帮助读者更加深入地了解该工具。
安装
在使用 assert-my-json-valid 前，需要先进行安装。
npm install assert-my-json-valid --save
引入
安装成功后，我们需要在代码中引入 assert-my-json-valid：
const Ajv = require('ajv');
const ajv = new Ajv({ allErrors: true });
const validate = ajv.compile(schema); // schema 为校验规则定义其中，Ajv 是 JSON 格式校验工具的名称；allErrors 选项为启用所有错误消息返回；schema 为 JSON 校验规则定义。
校验规则定义
JSON 格式校验需要提供校验规则定义。定义的方式可以是 JSON Schema。
下面是一个简单的 JSON 校验规则定义示例：
-- -------------------- ---- -------
----- ------ - -
----- ---------
----------- -
----- - ----- -------- --
---- - ----- ---------- -------- - --
-------- -
----- ---------
----------- -
----- - ----- -------- --
------- - ----- -------- --
--
--------- -------- ----------
--
--
--------- -------- ------ -----------
--这个示例定义了一个包含 name、age 和 address 三个属性的对象。其中，name 属性是必须的字符串类型、age 是必须的整数类型，且不能小于 0，address 是必须的 object 类型，包含 city 和 street 两个必须的字符串类型属性。
使用
有了校验规则定义和 JSON 格式校验工具，我们就可以进行 JSON 格式校验了。
在应用中，我们可以将 JSON 格式的数据作为参数传入校验方法，直接获得其校验结果。下面是具体的示例：
-- -------------------- ---- -------
----- ------------ - ------ -- -
----- ----- - ---------------
-- -------- -
-------------------- ----------------------------
------ ------
-
-------------------- ------
------ -----
--
----- ---------- - --
------- -----
------ ---
---------- -
------- -----
--------- -----
-
---
-------------------------在示例中，我们定义了一个 validateJson() 函数，参数为 JSON 格式字符串。函数内部调用 validate() 方法给传入的参数进行校验，如果校验失败，则调用 console.log() 输出错误信息。如果校验成功，则输出“校验成功”信息和查询到的 JSON 数据。
执行以上代码后，控制台将输出“校验失败： property age must be >= 0”。
常用选项
assert-my-json-valid 提供了一些常用的选项，方便用户根据自己的需要进行裁剪。下面是常用选项详细说明：
- removeAdditional: 启用后，用于从数据中删除未定义的属性。
- useDefaults: 启用后，用于使用默认值在数据不完整时自动填充数据。
- coerceTypes: 启用后，用于强制在数据匹配时进行强制转换。
下面是一个示例，演示如何定义 useDefaults 选项：
const ajv = new Ajv({ allErrors: true, useDefaults: true, coerceTypes: 'array' });在创建 Ajv 实例时，我们给 allErrors 选项传入了 true 值，表示我们需要显示所有校验错误，并为 useDefaults 选项传入了 true 值，表示我们需要使用默认值自动填充缺失的数据。
总结
本文介绍了 npm 包 assert-my-json-valid 的使用教程，包括安装、引入、校验规则定义、使用方式以及常用选项。希望读者能够通过这篇文章，掌握 assert-my-json-valid 的使用技巧，提高 JSON 格式校验的效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600553ac81e8991b448d0e80