树结构工具-TreeUtil

介绍

考虑到菜单等需求的普遍性，有用户提交了一个扩展性极好的树状结构实现。这种树状结构可以根据配置文件灵活的定义节点之间的关系，也能很好的兼容关系数据库中数据。实现

  1. 关系型数据库数据  <->  Tree  <->  JSON

树状结构中最大的问题就是关系问题，在数据库中，每条数据通过某个字段关联自己的父节点，每个业务中这个字段的名字都不同，如何解决这个问题呢？

PR的提供者提供了一种解决思路：自定义字段名，节点不再是一个bean，而是一个map，实现灵活的字段名定义。

使用

定义结构

我们假设要构建一个菜单，可以实现系统管理和店铺管理，菜单的样子如下：

  1. 系统管理
  2.     |- 用户管理
  3.     |- 添加用户
  5. 店铺管理
  6.     |- 商品管理
  7.     |- 添加商品

那这种结构如何保存在数据库中呢？一般是这样的：

idparentIdnameweight
10系统管理5
111用户管理10
1111用户添加11
20店铺管理5
212商品管理10
2212添加添加11

我们看到，每条数据根据parentId相互关联并表示层级关系，parentId在这里也叫外键。

构建Tree

  1. // 构建node列表
  2. List<TreeNode<String>> nodeList = CollUtil.newArrayList();
  4. nodeList.add(new TreeNode<>("1", "0", "系统管理", 5));
  5. nodeList.add(new TreeNode<>("11", "1", "用户管理", 222222));
  6. nodeList.add(new TreeNode<>("111", "11", "用户添加", 0));
  7. nodeList.add(new TreeNode<>("2", "0", "店铺管理", 1));
  8. nodeList.add(new TreeNode<>("21", "2", "商品管理", 44));
  9. nodeList.add(new TreeNode<>("221", "2", "商品管理2", 2));

TreeNode表示一个抽象的节点，也表示数据库中一行数据。 如果有其它数据，可以调用setExtra添加扩展字段。

  1. // 0表示最顶层的id是0
  2. List<Tree<String>> treeList = TreeUtil.build(nodeList, "0");

因为两个Tree是平级的，再没有上层节点，因此为List。

自定义字段名

  1. //配置
  2. TreeNodeConfig treeNodeConfig = new TreeNodeConfig();
  3. // 自定义属性名 都要默认值的
  4. treeNodeConfig.setWeightKey("order");
  5. treeNodeConfig.setIdKey("rid");
  6. // 最大递归深度
  7. treeNodeConfig.setDeep(3);
  9. //转换器
  10. List<Tree<String>> treeNodes = TreeUtil.build(nodeList, "0", treeNodeConfig,
  11.         (treeNode, tree) -> {
  12.             tree.setId(treeNode.getId());
  13.             tree.setParentId(treeNode.getParentId());
  14.             tree.setWeight(treeNode.getWeight());
  15.             tree.setName(treeNode.getName());
  16.             // 扩展属性 ...
  17.             tree.putExtra("extraField", 666);
  18.             tree.putExtra("other", new Object());
  19.         });

通过TreeNodeConfig我们可以自定义节点的名称、关系节点id名称，这样就可以和不同的数据库做对应。