『博客开发日记-后台』之获取菜单树列表接口的实现

本文最后更新于 2026年4月27日 晚上

获取获取菜单树列表接口的实现

获取获取菜单树列表接口的需求

根据关键字(菜单名称)查询

只查询可见的菜单

按排序字段升序排列

代码实现

ConfigController 

1
2
3
4
5
6
7
8
9
10
11
@GetMapping
@SystemLog(businessName = "菜单树列表")
@ApiOperation(value = "菜单树列表", notes = "获取菜单树列表（不分页）", response = PageVo.class)
@ApiImplicitParams({
        @ApiImplicitParam(name = "keywords", value = "菜单名称关键字", dataType = "string", paramType = "query")
})
public ResponseResult getMenuList(@Valid MenuListDto menuListDto)
{
    return sysMenuService.getMenuList(menuListDto);
}

创建 MenuTreeListDto 

1
2
3
4
5
6
7
8
9
10
11
12
13
/**
 * 菜单树列表请求DTO
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
@ApiModel(description = "菜单树列表请求对象")
public class MenuListDto {

    @ApiModelProperty(value = "关键字（用于模糊搜索菜单名字）", example = "系统管理")
    private String keywords;
}

使用 MenuVo 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
/**
 * 菜单Vo
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
@Accessors(chain = true)
@ApiModel(description = "获取当前登录用户的菜单")
public class MenuListVo
{
    @TableId
    private Long id;
    //父菜单ID
    private Long parentId;
    //菜单名称
    private String name;
    //菜单类型（C-目录 M-菜单 B-按钮）
    private String type;
    //路由名称（前端路由名）
    private String routeName;
    //路由路径（可用于自定义路由字段）
    private String routePath;
    //跳转路径
    private String redirect;
    //组件路径
    private String component;
    //ICON
    private String icon;
    //排序
    private Integer sort;
    //菜单是否可见(1:显示;0:隐藏)
    private String visible;
    //菜单范围(1=平台 2=业务)
    private String scope;
    //权限标识
    private String perm;

    @TableField(exist = false)
    private List<MenuListVo> children;
}

在 SysMenuServiceImpl 中实现方法

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
//获取菜单列表
@Override
public ResponseResult getMenuList(MenuListDto menuListDto)
{
    //构建查询条件
    LambdaQueryWrapper<SysMenu> queryWrapper = new LambdaQueryWrapper<>();

    //如果有关键字，则进行模糊查询
    if (StringUtils.hasText(menuListDto.getKeywords())) {
        queryWrapper.like(SysMenu::getName, menuListDto.getKeywords());
    }

    //只查询可见的菜单
    queryWrapper.eq(SysMenu::getVisible, SystemConstants.VISIBLE);

    //按排序字段升序排列
    queryWrapper.orderByAsc(SysMenu::getSort);

    //查询所有符合条件的菜单
    List<SysMenu> menuList = list(queryWrapper);

    //转换为 MenuListVo 列表
    List<MenuListVo> menuListVo = BeanCopyUtils.copyBeanList(menuList, MenuListVo.class);

    //构建菜单树
    List<MenuListVo> menuTree = builderMenuListTree(menuListVo, 0L);

    //返回结果
    return ResponseResult.okResult(menuTree);
}


//创建MenuList的菜单树
private List<MenuListVo> builderMenuListTree(List<MenuListVo> menuListVos, Long parentId)
{
    List<MenuListVo> menuTree = menuListVos.stream()
            .filter(menuListVo -> menuListVo.getParentId().equals(parentId))
            .map(menuListVo -> menuListVo.setChildren(getChildrenByMenuList(menuListVo, menuListVos)))
            .collect(Collectors.toList());
    return menuTree;
}

//获取传入参数的 子菜单（MenuList）集合
private List<MenuListVo> getChildrenByMenuList(MenuListVo menuListVo, List<MenuListVo> menuListVos)
{
    List<MenuListVo> childrenList = menuListVos.stream()
            .filter(m -> m.getParentId().equals(menuListVo.getId()))
            .map(m -> m.setChildren(getChildrenByMenuList(m, menuListVos)))
            .collect(Collectors.toList());
    return childrenList;
}

还要配置几个常量

由于在写的时候修改了修改了一些字段，涉及到的 SysMenuMapper.xml 也要重新写一下

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="com.mengze.mapper.SysMenuMapper">
    <select id="selectPermByUserId" resultType="java.lang.String">
        SELECT DISTINCT m.perm
        FROM sys_user_role ur
                 LEFT JOIN sys_role_menu rm ON ur.role_id = rm.role_id
                 LEFT JOIN sys_menu m ON m.id = rm.menu_id
        WHERE ur.user_id = #{userId}
          AND m.type IN ('M', 'B')
          AND m.visible = 0
          AND m.del_flag = 0
    </select>

    <select id="selectAllRouterMenu" resultType="com.mengze.domain.vo.MenuRoutesVo">
        SELECT DISTINCT
            m.id,
            m.parent_id,
            m.name,
            m.type,
            m.path,
            m.route_name,
            m.redirect,
            m.component,
            m.icon
        FROM sys_menu m
        WHERE m.type IN ('M', 'C')
          AND m.visible = 0
          AND m.del_flag = 0
        ORDER BY m.parent_id, m.sort
    </select>

    <select id="selectRouterMenuTreeByUserId" resultType="com.mengze.domain.vo.MenuRoutesVo">
        SELECT DISTINCT
            m.id,
            m.parent_id,
            m.name,
            m.type,
            m.path,
            m.route_name,
            m.redirect,
            m.component,
            m.icon
        FROM sys_user_role ur
                 LEFT JOIN sys_role_menu rm ON ur.role_id = rm.role_id
                 LEFT JOIN sys_menu m ON m.id = rm.menu_id
        WHERE ur.user_id = #{userId}
          AND m.type IN ('M', 'C')
          AND m.visible = 0
          AND m.del_flag = 0
        ORDER BY m.parent_id, m.sort
    </select>
</mapper>

测试接口

还有一点就是我前台系统中还没有关于系统配置的接口

到时候还要改 改完了再做这个接口了

PS:该系列只做为作者学习开发项目做的笔记用

不一定符合读者来学习，仅供参考

预告

后续会记录博客的开发过程

每次学习会做一份笔记来进行发表

“一花一世界，一叶一菩提”

版权所有 © 2026 云梦泽
欢迎访问我的个人网站：https://hgt12.github.io/

博客开发
#技术向 #个人博客 #前端 #后端
『博客开发日记-后台』之获取菜单树列表接口的实现
http://example.com/2026/04/25/『博客开发日记-后台』之获取菜单树列表接口的实现/
作者
云梦泽
发布于
2026年4月25日
更新于
2026年4月27日
许可协议