在前端项目中，我们经常需要对对象进行处理，包括遍历、筛选等。而在处理对象的过程中，经常需要知道对象的结构，以方便我们在代码中调用。这时，一个简单易用的工具就十分必要了。build-object-paths 就是这样一个工具，它可以帮助我们快速获取对象的结构信息，并且支持多种遍历方式。
安装
要使用 build-object-paths，你需要先在项目中安装它：
npm install build-object-paths --save
基本使用
获取对象所有键
在使用 build-object-paths 之前，我们先定义一个对象，作为后续的示例：
-- -------------------- ---- -------
----- --- - -
----- -----
---- ---
-------- -
--------- -----
----- ----
--
------ ------ ----- -----
-要获取这个对象的所有键，我们可以使用 buildObjectPaths 方法：
const buildObjectPaths = require('build-object-paths')
const paths = buildObjectPaths(obj)
console.log(paths)
// ['name', 'age', 'address', 'address.province', 'address.city', 'hobby', 'hobby.0', 'hobby.1', 'hobby.2']可以看到，buildObjectPaths 方法返回了一个数组，其中包含了该对象的所有键，包括嵌套对象的键和数组中的下标。
获取对象指定键
如果我们只需要获取对象的某些键，可以使用 filter 参数，比如只获取 name 和 address.province 两个键的路径：
const paths = buildObjectPaths(obj, ({path}) => path === 'name' || path === 'address.province')
console.log(paths)
// ['name', 'address.province']获取对象指定类型的键
有时候我们需要获取对象中某种类型的键，比如只获取字符串类型的键：
const paths = buildObjectPaths(obj, ({value}) => typeof value === 'string')
console.log(paths)
// ['name', 'address.province', 'address.city', 'hobby.0', 'hobby.1', 'hobby.2']获取对象指定路径的值
要获取对象指定路径的值，可以使用 getValueByPath 方法：
const {getValueByPath} = require('build-object-paths')
const province = getValueByPath(obj, 'address.province')
console.log(province) // '山东'遍历方式
build-object-paths 支持多种遍历方式，包括前序遍历（默认）、后序遍历、广度优先遍历和深度优先遍历。你可以通过传递 traversal 参数指定遍历方式。比如，下面我们指定使用后序遍历：
const paths = buildObjectPaths(obj, {traversal: 'postorder'})
console.log(paths)
// ['name', 'age', 'address.province', 'address.city', 'address', 'hobby.0', 'hobby.1', 'hobby.2', 'hobby']广度优先遍历
const paths = buildObjectPaths(obj, {traversal: 'breadth'})
console.log(paths)
// ['name', 'age', 'address', 'hobby', 'address.province', 'address.city', 'hobby.0', 'hobby.1', 'hobby.2']深度优先遍历
const paths = buildObjectPaths(obj, {traversal: 'depth'})
console.log(paths)
// ['name', 'age', 'address.province', 'address.city', 'address', 'hobby.0', 'hobby.1', 'hobby.2', 'hobby']应用场景
build-object-paths 可以帮助我们快速获取对象的结构信息，应用场景非常广泛，下面介绍一些常见的应用场景。
表单校验
在表单校验过程中，我们需要校验某些输入框是否为空。如果输入框数量很多，手动设置每个输入框的校验规则是非常繁琐和耗时的。通过获取对象的结构信息，我们可以很方便的筛选出所有输入框的键，然后遍历校验即可。
-- -------------------- ---- -------
----- --- - -
----- ---
---- -----
-------- -
--------- -----
----- --
--
------ ------ --- -----
-
----- ---------- - --------------------- --------- -- ------ ----- --- -------- -- ------------ --- ---
-----------------------
-- -------- --------------- ----------列表渲染
在列表渲染过程中，我们经常需要遍历数组来渲染列表项。如果数组中有嵌套对象，我们还需要获取嵌套对象的信息来渲染。build-object-paths 可以帮助我们快速获取嵌套对象的键，从而遍历渲染列表项。
-- -------------------- ---- -------
----
--- ------------- ------ -- ----- -------------
-- -----------------------
-- -----------------------------------
-- -------------------------------
----
--- -------------- ---- -- ----------- ---------- --------------------
-----
-----
------- -------------------- ---- -------
----- ---- - -
-
----- -----
---- ---
-------- -
--------- -----
----- ----
--
------ ------ ----- -----
--
-
----- -----
---- ---
-------- -
--------- -----
----- ----
--
------ ------ --- ------
-
-
----- ----------------- - ------------------------- --------- -- ------ ----- --- ---------
------------------------------
-- ----------- ------------------- --------------- --------
-- -------
--- ------ ---- -- ----- -
-------------------- ----------
------------------------ ----------------------
-------------------- ------------------
--------------------- ---------------------
-总结
build-object-paths 是一个非常实用、简单易用的对象处理工具。它可以帮助我们快速获取对象的结构信息，并支持多种遍历方式，应用场景非常广泛。希望本文能够帮助你更好地理解和使用这个工具。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066c8dccdc64669dde54fe