前言
JSON 是一种轻量级的数据交换格式，如今已经被广泛应用到Web前端开发中。在Web前端开发中，我们常常要校验前端向后端提交的JSON数据格式是否合法，这时候就需要一个方便快捷的工具来进行校验。
本文将介绍一款常见的 npm 包 json-format-check ，为大家提供详细的使用教程，并且包含示例代码以供大家学习参考。
json-format-check 简介
json-format-check 是一个可以快速验证输入的JSON文件校验的npm包，可以方便快捷地校验输入的JSON文件格式是否合法，且易于集成到您的项目中。
json-format-check 使用指南
安装
使用npm install命令安装 json-format-check:
npm install json-format-check --save-dev
引用
使用require命令引入json-format-check:
var jsonFormatCheck = require('json-format-check');注：如果您使用的是 TypeScript，可以通过以下方式引入
import * as jsonFormatCheck from 'json-format-check';
校验函数
json-format-check 提供了两个校验函数：
checkJsonValidity(json: string): booleancheckJson(json: string, schema: object): boolean
checkJsonValidity函数用于检测文件中的json是否合法，函数输入的参数仅为json字符串，返回值为布尔类型；checkJson函数用于检测文件中的json格式是否与指定的 schema 相符。函数输入的参数为两个参数，分别是要校验的json字符串和校验的schema。返回值为布尔类型。
下面分别对这两个函数进行说明。
格式校验
checkJsonValidity(json: string): boolean
- 输入
输入为 JSON 字符串。
- 功能
判断输入的 JSON 串是否合法。
- 输出
返回值为布尔类型：
true表示输入的 JSON 串合法false表示输入的 JSON 串不合法示例
下面示范一个校验 json 是否合法的示例：
var jsonString = '{"name": "Jack", "age": 28}';
var isJsonStringValid = jsonFormatCheck.checkJsonValidity(jsonString);
console.log(isJsonStringValid); //true下面再给大家展示一个不合法的示例：
var jsonString = '{"name": "Jack", "age", 28}';
var isJsonStringValid = jsonFormatCheck.checkJsonValidity(jsonString);
console.log(isJsonStringValid); //falseJSON Schema 校验
checkJson(json: string, schema: object): boolean
- 输入
输入为 JSON 字符串和 JSON Schema 对象。
- 功能
校验输入的 JSON 字符串是否符合指定的 JSON Schema。
- 输出
返回值为布尔类型：
true表示输入的 JSON 串符合指定的 schema。false表示输入的 JSON 串不符合指定的 schema。示例
下面示范一个校验JSON是否符合指定schema的示例：
-- -------------------- ---- -------
--- ------ - -
-------- ------- --------
------- ---------
------------- -
------- -
------- ---------
------------ --
------------ --
---------- -------------
--
------ -
------- ---------
---------- --
---------- ---
--
--------- -
------- ---------
------- -------- ---------
--
---------- -
------- ---------
------------- -
---------- -
------- ---------
------- --------- ------
--
------- -
------- --------
--
---------- -
------- ---------
---------- --------------
-
-
-
--
----------- -------- ------
--
--- ---------- - --------- ------ ------ --- --------- ---------
--- ----------------- - ------------------------------------- --------
------------------------------- ------下面再给大家展示一个不符合指定 schema 的示例：
-- -------------------- ---- -------
--- ------ - -
-------- ------- --------
------- ---------
------------- -
------- -
------- ---------
------------ --
------------ --
---------- -------------
--
------ -
------- ---------
---------- --
---------- ---
--
--------- -
------- ---------
------- -------- ---------
--
---------- -
------- ---------
------------- -
---------- -
------- ---------
------- --------- ------
--
------- -
------- --------
--
---------- -
------- ---------
---------- --------------
-
-
-
--
----------- -------- ------
--
--- ---------- - --------- ------ ------ ---- --------- ---------
--- ----------------- - ------------------------------------- --------
------------------------------- -------结语
json-format-check 是一个优秀的校验 JSON 数据的 npm 包，可以非常方便地验证前端向后端提交的 JSON 数据格式是否合法。
本文介绍了如何使用 json-format-check 以及其校验函数的使用方法。通过学习本文，相信读者们可以掌握如何快速地在自己的项目中使用此工具对 JSON 数据格式进行校验。
如果您对此文章还有什么问题或建议，请在下方发表您的评论，我们会认真聆听，并及时回复。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055af081e8991b448d8982