在现代 web 应用开发中，多数应用几乎都需要处理 JSON 数据。但是，经常会遇到不一致的 JSON 数据，这可能是由于 API 数据返回不一致，读取数据源的错误，或者数据在传输过程中发生损坏等诸多原因造成的。在发现数据问题时，我们需要快速定位并解决这些问题。这就需要使用一个 npm 包，即 json_sanity_checks。
什么是 json_sanity_checks？
json_sanity_checks 是一个用于构建健壮性检验系统的 npm 包。如果你正在使用多个不同的数据源，并且想要确保所读取的 JSON 数据具有一致的结构，那么你就需要一个健壮性检验解决方案，json_sanity_checks 就是这样一个解决方案。它提供了一组 API，用于检查 JSON 数据的结构和完整性，帮助我们确保不同数据源读入的数据均具有一致的结构。
如何使用 json_sanity_checks？
json_sanity_checks 可以非常容易地通过 npm 安装：
npm install json_sanity_checks
然后，在你的应用代码中引入它，并使用下列的命令进行初始化：
var jsonSanityChecks = require('json_sanity_checks');
var validator = jsonSanityChecks.createValidator();这样你就可以使用 validator 对象来进行 JSON 健壮性检验了。
下面是该 npm 包提供的 API：
isType(obj, type): 检查类型是否正确，obj是要检查的对象，type是期望的数据类型。假如类型不正确，将会抛出一个错误。
validator.isType(21, 'number'); // 此操作不会有任何异常抛出
validator.isType('123', 'number'); // 这将会抛出一个错误hasProperty(obj, property): 检查对象是否具有某个属性，obj是要检查的对象，property是需要检查的属性名称。假如没有该属性，将会抛出一个错误。
var testObject = {
'name': 'Tony Stark',
'alias': 'Iron Man'
};
validator.hasProperty(testObject, 'name'); // 此操作不会有任何异常抛出
validator.hasProperty(testObject, 'nickname'); // 这将会抛出一个错误isObject(obj): 检查对象是否是一个 JSON 对象。假如不是，将会抛出一个错误。
validator.isObject({}); // 此操作不会有任何异常抛出
validator.isObject([]); // 这将会抛出一个错误isArray(obj): 检查对象是否是一个 JSON 数组。假如不是，将会抛出一个错误。
validator.isArray([]); // 此操作不会有任何异常抛出
validator.isArray({}); // 这将会抛出一个错误isValidEmail(email): 检查电子邮件地址是否有效，email是要检查的电子邮件地址。假如不是一个有效的电子邮件地址，将会抛出一个错误。
validator.isValidEmail('mschaeffner@microsoft.com'); // 此操作不会有任何异常抛出
validator.isValidEmail('I am not an e-mail!'); // 这将会抛出一个错误以上的这些 API 是使用 json_sanity_checks 以及其 validator 对象所提供的所有的 API。你可以根据你的数据需要来使用它们的任何组合。当你开始使用时，你会发现这些 API 非常简单易用，并且它们能帮助你使你的应用更加健壮。
案例分析
我们来看一个具体的案例分析，使用 json_sanity_checks 进行数据校验。
我们有一个应用程序，需要读取三个 API 的数据。API1 返回以下的 JSON 数据：
-- -------------------- ---- -------
-
------- ----- -------
---------------- -
------ ---
-------- ------------------------
--
---------- -
-
------- -------
-------- ------------------
--
-
------- -----
-
-
-API2 返回以下的 JSON 数据：
-- -------------------- ---- -------
-
------- ----- -------
------ ---
-------- -------------------------
---------- -
-
------- -------
-------- ------------------
--
-
------- -----
-
-
-API3 返回以下的 JSON 数据：
-- -------------------- ---- -------
-
------- ----- -------
------ ---
-------- -------------------------
---------- -
-
------- -------
------ --
--
-
------- ------
-------- -----------------
-
-
-我们需要整合这三个 API 返回的数据，并对它们进行检验，确保我们在使用此数据时不会遇到问题。
首先，我们需要使用 json_sanity_checks 中的 isObject 方法检查每一个 API 返回的 JSON 是否是一个对象：
validator.isObject(api1_data); validator.isObject(api2_data); validator.isObject(api3_data);
由于这三个 API 返回的数据都是 JSON 对象，所以这些校验都不会抛出异常。
然后，我们需要使用 json_sanity_checks 中的 hasProperty 方法检查每一个 API 返回的 JSON 是否具有以下的属性：
nameageemailfriends
我们可以像下面这样对每一个数据源使用 hasProperty 方法：
-- -------------------- ---- ------- -------------------------------- -------- -------------------------------- ----------------- ---------------------------------------------- ------- ---------------------------------------------- --------- -------------------------------- ----------- ------------------------------------------- -------- ------------------------------------------- --------- ------------------------------------------- -------- -------------------------------- -------- -------------------------------- ------- -------------------------------- --------- -------------------------------- ----------- ------------------------------------------- -------- ------------------------------------------- --------- ------------------------------------------- -------- -------------------------------- -------- -------------------------------- ------- -------------------------------- --------- -------------------------------- ----------- ------------------------------------------- -------- ------------------------------------------- ------- ------------------------------------------- -------- ------------------------------------------- ---------
由于每一个数据源都符合我们的预期，因此这些校验操作都不会抛出异常。
最后，我们需要使用 json_sanity_checks 中的 isType 方法检查数据类型：
-- -------------------- ---- ------- -------------------------------- ---------- --------------------------------------------- ---------- ----------------------------------------------- ---------- ------------------------------------------- ---------- -------------------------------- ---------- ------------------------------- ---------- --------------------------------- ---------- ------------------------------------------- ---------- -------------------------------- ---------- ------------------------------- ---------- --------------------------------- ---------- ------------------------------------------- ---------- ------------------------------------------ ---------- ------------------------------------------- ---------- -------------------------------------------- ----------
由于每一个值的数据类型都符合我们的预期，因此这些校验操作也都不会抛出异常。
现在，我们可以将这三个数据源的数据进行整合，而不必担心这些数据在读取时出现任何问题。
总结
在这篇文章中，我们介绍了一个 npm 包，即 json_sanity_checks。这个 npm 包可以用来校验 JSON 数据的完整性和结构，确保我们在使用数据时不会遇到问题。我们学习了如何安装和使用这个 npm 包，并提供了一个具体的案例分析，展示了如何使用这个 npm 包对多个数据源中的 JSON 数据进行校验。无论你是一个初学者还是一个有经验的开发人员，json_sanity_checks 都可以帮助你确保你的代码在使用 JSON 数据时具有一致的结构，并且在出现问题时快速帮你定位问题的根源。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005663781e8991b448e22db