Java构建树形菜单工具类,递归写法

原创

已于 2022-05-01 11:43:53 修改 · 1.7k 阅读

15 ·

CC 4.0 BY-SA版权

文章标签：

#java

于 2021-10-06 01:48:12 首次发布

本文介绍了一个用于构建树形菜单的工具类，通过实现TreeNode接口并配合递归算法，可以快速生成菜单结构，适用于SpringSecurity风格的数据。示例展示了如何将数据库数据转化为菜单结构并提供两种使用场景：默认根节点和指定特定节点。

树形菜单构建工具类(递归写法)

1. 工具类源码

模型定义,这里受Spring Security的UserService启发,给model设置接口.想要使用此工具类的话，实现此接口即可.

package xyz.yq56.easytool.abs;

import java.util.List;

/**
 * @author yi qiang
 * @date 2021/10/5 14:35
 */
public interface TreeNode {
   
   

    /**
     * 获取id
     *
     * @return id
     */
    String getId();

    /**
     * 获取父类id
     *
     * @return 父类id
     */
    String getPid();

    /**
     * 获取子类集合
     *
     * @return 子类集合
     */
    <T extends TreeNode> List<T> getChildren();

    /**
     * 设置子类集合
     *
     * @param children 子类集合
     */
    <T extends TreeNode> void setChildren(List<T> children);

}

工具类源码:

package xyz.yq56.easytool.utils.recursion;

import java.util.ArrayList;
import java.util.List;
import java.util.Objects;

import xyz.yq56.easytool.abs.TreeNode;
import xyz.yq56.easytool.utils.collection.CollectUtil;

/**
 * @author yi qiang
 * @date 2021/10/5 14:33
 */
public class RecursionUtil {
   
   

    private RecursionUtil() {
   
   }

    /**
     * 使用时,只要node实现TreeNode接口即可实现树形菜单
     * <br> 实现逻辑很简单：
     * <br> 找到子类，并给children设值
     * <br> 由于子类可能还有子类，故在子类内部递归调用，找到子类的子类
     *
     * @param list 树形结构的扁平数据
     * @param node 根节点
     * @param <T>  泛型,只要实现TreeNode接口即可生成树形结构
     */
    public static <T extends TreeNode> void buildTree(List<T> list, T node) {
   
   
        if (CollectUtil.isEmpty(list)) {
   
   
            return;
        }
        List<T> children = new ArrayList<>();
        for (T menu : list) {
   
   
            if (Objects.equals(menu.getPid(), node.getId())) {
   
   
                children.add(menu);
                buildTree(getRemainList(list, menu.getPid()), menu);
            }
        }
        if(!CollectUtil.isEmpty(children)){
   
   
            node.setChildren(children);
        }

    }

    /**
     * 获取到的剩余集合会越来越少,避免堆栈溢出
     *
     * @param list list
     * @param pid  pid
     * @return 剩余集合
     */
    private static <T extends TreeNode> List<T> getRemainList(List<T> list, String pid) {
   
   
        return CollectUtil.filter(list,item -> !Objects.equals(item.getPid(), pid));
    }
}

2. 使用示例

实现TreeNode接口

package xyz.yq56.sm.module.menu.model;

import java.util.List;

import lombok.Data;
import xyz.yq56.easytool.abs.TreeNode;

/**
* @author yi qiang
* @date 2021/10/4 0:03
*/
@Data
public class MenuVo implements TreeNode {
   
   

  private String id;

  private String pid;

  private String name;

  private String path;

  private String icon;

  private List<MenuVo> children;