树结构工具 - TreeUtil

简介

在企业级开发中，树形结构广泛应用于菜单管理、分类管理等场景。TreeUtil 是 Hutool 提供的用于构建和处理树结构的工具类。它支持从数据库中的平面数据构建树形结构，并能灵活配置节点间的关系。这对于处理复杂的菜单、分类等树状结构数据非常方便。

使用场景

• 菜单管理：如系统管理、店铺管理等层级结构的菜单。
• 分类管理：如商品分类、权限管理等具有父子关系的数据。
• 组织架构：如公司内部的部门结构。

主要方法

1. 构建树形结构

TreeUtil.build 方法用于将平面结构的数据转换为树形结构。

示例：构建树形结构

假设有一个菜单结构如下：

系统管理
    |- 用户管理
    |- 用户添加
店铺管理
    |- 商品管理
    |- 商品添加

对应的数据库表结构如下：

id	parentId	name	weight
1	0	系统管理	5
11	1	用户管理	10
111	11	用户添加	11
2	0	店铺管理	5
21	2	商品管理	10
221	21	商品添加	11

可以通过以下代码构建树：

import cn.hutool.core.collection.CollUtil;
import cn.hutool.core.lang.tree.Tree;
import cn.hutool.core.lang.tree.TreeNode;
import cn.hutool.core.lang.tree.TreeUtil;

import java.util.List;

public class TreeExample {
    public static void main(String[] args) {
        // 构建节点列表
        List<TreeNode<String>> nodeList = CollUtil.newArrayList();
        nodeList.add(new TreeNode<>("1", "0", "系统管理", 5));
        nodeList.add(new TreeNode<>("11", "1", "用户管理", 10));
        nodeList.add(new TreeNode<>("111", "11", "用户添加", 11));
        nodeList.add(new TreeNode<>("2", "0", "店铺管理", 5));
        nodeList.add(new TreeNode<>("21", "2", "商品管理", 10));
        nodeList.add(new TreeNode<>("221", "21", "商品添加", 11));

        // 构建树形结构
        List<Tree<String>> treeList = TreeUtil.build(nodeList, "0");

        // 打印树形结构
        treeList.forEach(tree -> System.out.println(tree.toString()));
    }
}

关键点：

• TreeNode<String> 是树节点的基本元素，包含节点 ID、父节点 ID、名称和权重。
• TreeUtil.build 方法通过父子关系构建树形结构。

实际开发场景：在处理菜单、分类管理时，可以通过该方法将平面结构的数据快速转换为树形结构，便于前端展示和处理。

2. 自定义字段名

在实际业务中，数据库中的字段名可能与默认的 TreeNode 字段名不一致。通过 TreeNodeConfig 可以自定义字段名，如 id、parentId、weight 等。

示例：自定义字段名

import cn.hutool.core.collection.CollUtil;
import cn.hutool.core.lang.tree.Tree;
import cn.hutool.core.lang.tree.TreeNode;
import cn.hutool.core.lang.tree.TreeNodeConfig;
import cn.hutool.core.lang.tree.TreeUtil;

import java.util.List;

public class TreeExample {
    public static void main(String[] args) {
        // 构建节点列表
        List<TreeNode<String>> nodeList = CollUtil.newArrayList();
        nodeList.add(new TreeNode<>("1", "0", "系统管理", 5));
        nodeList.add(new TreeNode<>("11", "1", "用户管理", 10));
        nodeList.add(new TreeNode<>("111", "11", "用户添加", 11));
        nodeList.add(new TreeNode<>("2", "0", "店铺管理", 5));
        nodeList.add(new TreeNode<>("21", "2", "商品管理", 10));
        nodeList.add(new TreeNode<>("221", "21", "商品添加", 11));

        // 自定义配置
        TreeNodeConfig config = new TreeNodeConfig();
        config.setWeightKey("order");
        config.setIdKey("rid");
        config.setDeep(3); // 最大递归深度

        // 构建树形结构
        List<Tree<String>> treeList = TreeUtil.build(nodeList, "0", config, (treeNode, tree) -> {
            tree.setId(treeNode.getId());
            tree.setParentId(treeNode.getParentId());
            tree.setWeight(treeNode.getWeight());
            tree.setName(treeNode.getName());
            // 添加扩展属性
            tree.putExtra("extraField", "扩展信息");
        });

        // 打印树形结构
        treeList.forEach(tree -> System.out.println(tree.toString()));
    }
}

关键点：

• TreeNodeConfig 用于自定义字段名称和层级深度。
• 通过 build 方法的 TreeNodeMapper 参数可以将数据库字段映射到树节点字段。

实际开发场景：在需要与不同数据库字段名兼容时，可以通过自定义配置灵活适应不同的数据结构。

3. 扩展字段和自定义数据

TreeNode 支持扩展字段，通过 putExtra 方法可以在节点中存储自定义数据。

示例：添加扩展字段

tree.putExtra("extraField", "扩展信息");

实际开发场景：在构建树形结构时，如果需要在节点中存储额外的信息（如图标、链接等），可以使用扩展字段进行存储。

总结

• TreeUtil 是一个强大且灵活的树结构构建工具，适用于处理层级关系数据。通过自定义配置、扩展字段和灵活的映射机制，可以满足不同业务场景下的树形结构构建需求。
• 你可以根据具体需求灵活应用 TreeUtil，将数据库中的平面结构数据高效转换为树形结构，并在树节点中存储自定义信息，使数据展示和处理更加便捷。