java树结构工具-TreeUtil
一、定义结构
我们假设要构建一个菜单,可以实现系统管理和店铺管理,菜单的样子如下:
系统管理
|- 用户管理
|- 添加用户
店铺管理
|- 商品管理
|- 添加商品
那这种结构如何保存在数据库中呢?一般是这样的:
id | parentId | name | weight |
---|---|---|---|
1 | 0 | 系统管理 | 5 |
11 | 1 | 用户管理 | 10 |
111 | 1 | 用户添加 | 11 |
2 | 0 | 店铺管理 | 5 |
21 | 2 | 商品管理 | 10 |
221 | 2 | 添加添加 | 11 |
这里需要注意:(如果是多个省份的店铺,需要根据城市使用不同的id)
菜单 parentId
-----------------------------------------
系统管理 0
|- 用户管理 1
|- 添加用户 1
店铺管理 # 北京 0
|- 商品管理 2
|- 添加商品 2
店铺管理 # 天津 0
|- 商品管理 3 # 这里不能使用2
|- 添加商品 3 # 这里不能使用2
我们看到,每条数据根据parentId
相互关联并表示层级关系,parentId
在这里也叫外键。
二、构建Tree
public TreeNode(T id, T parentId, String name, Comparable<?> weight)
注:id和parentId需要类型一致(基本数据类型Integer、String、Long。。均可)
例子中使用String
// 构建node列表
List<TreeNode<String>> nodeList = CollUtil.newArrayList();
nodeList.add(new TreeNode<>("1", "0", "系统管理", 5));
nodeList.add(new TreeNode<>("11", "1", "用户管理", 222222));
nodeList.add(new TreeNode<>("111", "11", "用户添加", 0));
nodeList.add(new TreeNode<>("2", "0", "店铺管理", 1));
nodeList.add(new TreeNode<>("21", "2", "商品管理", 44));
nodeList.add(new TreeNode<>("221", "2", "商品管理2", 2));
TreeNode表示一个抽象的节点,也表示数据库中一行数据。 如果有其它数据,可以调用
setExtra
添加扩展字段。
// 0表示最顶层的id是0
List<Tree<String>> treeList = TreeUtil.build(nodeList, "0");
因为两个Tree是平级的,再没有上层节点,因此为List。
三、自定义字段名
//配置
TreeNodeConfig treeNodeConfig = new TreeNodeConfig();
// 自定义属性名 都要默认值的
treeNodeConfig.setWeightKey("order");
treeNodeConfig.setIdKey("rid");
// 最大递归深度
treeNodeConfig.setDeep(3);
//转换器
List<Tree<String>> treeNodes = TreeUtil.build(nodeList, "0", treeNodeConfig,
(treeNode, tree) -> {
tree.setId(treeNode.getId());
tree.setParentId(treeNode.getParentId());
tree.setWeight(treeNode.getWeight());
tree.setName(treeNode.getName());
// 扩展属性 ...
tree.putExtra("extraField", 666);
tree.putExtra("other", new Object());
});
通过TreeNodeConfig我们可以自定义节点的名称、关系节点id名称,这样就可以和不同的数据库做对应。