简介
@cloudflare/json-schema-walker 是一个可以深入遍历 JSON Schema 对象的 npm 包，它有以下特点：
- 基于 json-schema-traverse 构建；
- 支持同步与异步操作；
- 支持任意深度遍历；
- 可以方便地使用 ajv 完成 JSON Schema 校验。
本篇文章将讲解如何使用 @cloudflare/json-schema-walker 这个 npm 包，详细讲解它的用法和示例代码，并附上一些指导性的建议和注意事项。
安装
在使用 @cloudflare/json-schema-walker 之前，需要先安装它。我们可以在终端上运行以下命令，通过 npm 安装该包：
npm install @cloudflare/json-schema-walker
使用
我们先看一下如何使用同步的方法来使用 @cloudflare/json-schema-walker。
使用同步方法
-- -------------------- ---- -------
----- - ---- - - ------------------------------------------
----- ------ - -
----- ---------
----------- -
----- - ----- -------- --
---- - ----- -------- --
------- - ----- -------- --------- -
--
--------- -------- ------
--
----- ----- - ---
------------ -------- ----- -------- ---------- -------------- -------------- ---- -
-- ---------------------------------- -
-------------- - ---------------
-
---
-------------------
-- ------- - -------- --------- ------------------------ --------- ----------------------- -------- -在这个示例中，我们定义了一个名为 schema 的 JSON Schema 对象，然后使用 walk() 方法对它进行了遍历。walk() 方法接受两个参数：
- 第一个参数是需要被遍历的 JSON Schema 对象；
- 第二个参数是遍历时执行的回调函数。
在回调函数中，我们可以对正在遍历的对象进行操作。在这个示例中，我们在回调函数中通过 schemaPtr.hasOwnProperty('type') 判断了当前遍历到的对象是否包含了 type 属性，如果包含的话，我们就将它存入 types 对象中。
最终，我们可以输出 types 对象来查看遍历结果。这里我们得到了一个对象，它的 key 代表 JSON Schema 中的指针，value 则代表该指针所对应对象的 type 属性。
使用异步方法
除了同步方法之外，@cloudflare/json-schema-walker 还支持异步方法。如果你的 JSON Schema 对象比较大，或者需要从网络上获取的话，异步方法可以提高程序的效率。
我们来看一下如何使用异步方法：
-- -------------------- ---- -------
----- - ---- - - ------------------------------------------
----- -------- ------ -
----- ------ - -
----- ---------
----------- -
----- - ----- -------- --
---- - ----- -------- --
------- - ----- -------- --------- -
--
--------- -------- ------ ---------
--
----- ------------ - ---
----- ------------ ----- -------- ----- -------- ---------- -------------- -------------- ---- -
-- -------------- --- ----------- -
-----------------------
-
---
--------------------------
-- ------- - ------- ------ -------- -
-
----------------------------在这个示例中，我们使用了一个 async 函数 main() 来调用异步方法 walk()。在 walk() 的第二个参数传入的回调函数中，我们使用了 async 和 await 关键字来处理异步操作。在此示例中，我们使用了一个 requiredKeys 数组，用来存储 JSON Schema 中定义的 required 属性的 key。最终，我们通过输出该数组的结果来验证异步方法的执行结果。
关于如何处理异步操作，你需要注意的是：
- 回调函数必须是
async函数； - 必须在
walk()前添加async关键字，以定义异步函数。
指导与建议
使用 @cloudflare/json-schema-walker 时，需要注意以下几点：
- 回调函数中的
parentKeyword和idx参数代表了当前遍历到的对象在其父对象中的位置。你可以使用这两个参数来获取当前对象的信息。 - “同步和异步方法各有利弊”，这句话在使用
@cloudflare/json-schema-walker中也同样适用。 - 如果你在回调函数中使用了
throw抛出异常，会导致遍历立即停止，所以请确保自己完全掌握了程序的运行逻辑。 - 限制回调函数的执行频率，以免出现性能瓶颈。
结论
@cloudflare/json-schema-walker 是一个非常有用的 npm 包，它可以方便你快捷地遍历 JSON Schema 对象，节省编写同一类型代码的时间。同时，它的使用方法也非常简单，挑战不大。使用之前，建议先熟悉一下 JSON Schema 的结构，这样可以更好地理解本文所示的示例代码。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/157342