在编写前端项目时，经常需要处理层级关系的数据，如目录树、分类等。在处理这些数据时，我们通常需要先将它们转换成一种易于管理和遍历的数据结构。npm 包 tree-indexer 就提供了一种高效且易于使用的处理方式。
安装和引入
tree-indexer 是一个 Node.js 模块，可以通过 npm 进行安装：
npm install tree-indexer
安装完成后，就可以在项目中引入它了：
const TreeIndexer = require('tree-indexer');基本用法
tree-indexer 提供的主要功能是将一个包含层级关系的数组转换成一棵树状结构，并提供一系列的方法来操作这棵树。下面我们就通过一个实例来介绍它的基本用法。
首先，假设我们有这样一个包含城市信息的数组：
-- -------------------- ---- ------- ----- ------ - - ---- -- ----- ----- --------- ------ ---- -- ----- ----- --------- ------ ---- -- ----- ----- --------- --- ---- -- ----- ----- --------- --- ---- -- ----- ----- --------- ------ ---- -- ----- ----- --------- ------ ---- -- ----- ----- --------- ------ ---- -- ----- ----- --------- --- ---- -- ----- ----- --------- --- -- --- --
每个元素都表示一个城市，其中 id 是唯一标识符，name 是城市名，parentId 是其所属的上级城市的 id，如果没有上级城市则为 null。
接下来，我们就要使用 tree-indexer 将这个数组转换成一棵树：
const indexer = new TreeIndexer({idKey: 'id', parentIdKey: 'parentId'});
const tree = indexer.index(cities);这里我们实例化了一个 TreeIndexer，并指定了 id 和 parentId 的键名。然后我们调用 index 方法，将原始数组传入即可。
转换完成后，我们就可以通过 tree 的各种方法来遍历和操作这棵树了。比如，我们可以列出所有顶层城市的 name：
tree.getRoots().forEach(city => console.log(city.name));
这里 getRoots 方法可以获取所有顶层城市的节点，我们只需遍历这些节点并打印出 name 即可。
tree-indexer 还提供了一些其他有用的方法，如：
- getParent(node): 获取节点的父节点。
- getChildren(node): 获取节点的所有子节点。
- findNode(id): 在树中查找指定 id 的节点并返回。
- findNodes(callback): 遍历树中的所有节点，并将满足指定条件的节点返回成数组。
更多方法可以参考文档：https://github.com/dazhizhi/node-tree-indexer#api。
高级用法
除了基本的转换和遍历功能，tree-indexer 还提供了一些高级功能。比如，我们可以通过传入自定义的处理函数来实现更复杂的转换。
假设我们有一个包含商品信息的数组：
const goods = [
{id: 1, name: 'iPhone 11', category: '手机/电信', price: 5499},
{id: 2, name: '华为 MateBook X', category: '电脑/周边', price: 7999},
{id: 3, name: 'MacBook Pro', category: '电脑/周边', price: 13899},
{id: 4, name: 'AirPods Pro', category: '耳机/音箱', price: 1999},
// ...
];每个元素都表示一个商品，其中 id 是唯一标识符，name 是商品名，category 是商品所属的类别，price 是商品价格。
现在我们想要将这个数组转换成一个类别结构的树状数据，即每个节点的 name 表示一个类别名，children 表示该类别下的所有商品（不包含子类别）。我们可以使用 tree-indexer 提供的 toTree 方法，并传入自定义的处理函数：
const indexer = new TreeIndexer({idKey: 'id', parentIdKey: 'parentId'});
const tree = indexer.toTree(
goods,
node => ({ name: node.category, children: [node] }),
node => ({ name: node.category, children: [] }),
(parent, child) => parent.name === child.name
);这里我们传入了三个参数：
- nodeToTreeNode(node): 自定义处理函数，将原始节点转换成一棵子树。
- createRootNode(node): 自定义处理函数，用于将非根节点创建为一个树节点。
- equal(node1, node2): 自定义比较函数，用于判断两个节点是否相等。
经过上述处理，我们就可以得到一个类别结构的树状数据了。我们可以使用 getChildren 方法，获取每个节点下的所有商品：
tree.forEach(node => {
console.log(node.name + ':');
node.children.forEach(goods => console.log(` ${goods.name}：${goods.price}元`));
});除了 toTree，tree-indexer 还提供了其他的高级功能。比如，我们可以使用 treeDiff 方法来计算两棵树之间的差异。更详细的使用方法可以参考文档。
总结
tree-indexer 是一个非常实用的 npm 包，它提供了一种高效且易于使用的方式来处理包含层级关系的数据。在实际开发中，我们可以将其应用于目录树、分类、权限体系等场景中，并通过自定义处理函数来实现更灵活的数据处理。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005589a81e8991b448d5dcc