feat: 菜单路由优化

2024-12-22 12:48:59 +08:00 · 2023-11-04 00:39:13 +08:00 · 2023-11-04 00:39:13 +08:00 · 9f30696a5e
commit 9f30696a5e
parent 8ee68bf898
6 changed files with 179 additions and 118 deletions
--- a/youlai-system/system-boot/src/main/java/com/youlai/system/model/bo/RouteBO.java
+++ b/youlai-system/system-boot/src/main/java/com/youlai/system/model/bo/RouteBO.java
@ -64,13 +64,23 @@ public class RouteBO {
    private String icon;

    /**
-     * 外链路径
+     * 跳转路径
     */
-    private String redirectUrl;
+    private String redirect;

    /**
     * 拥有路由的权限
     */
    private List<String> roles;

+    /**
+     * 【目录】只有一个子路由是否始终显示(1:是 0:否)
+     */
+    private Integer alwaysShow;
+
+    /**
+     * 【菜单】是否开启页面缓存(1:是 0:否)
+     */
+    private Integer keepAlive;
+
 }
--- a/youlai-system/system-boot/src/main/java/com/youlai/system/model/entity/SysMenu.java
+++ b/youlai-system/system-boot/src/main/java/com/youlai/system/model/entity/SysMenu.java
@ -77,4 +77,14 @@ public class SysMenu extends BaseEntity {
     */
    private String treePath;

+    /**
+     * 【菜单】是否开启页面缓存(1:开启;0:关闭)
+     */
+    private Integer keepAlive;
+
+    /**
+     * 【目录】只有一个子路由是否始终显示(1:是 0:否)
+     */
+    private Integer alwaysShow;
+
 }
--- a/youlai-system/system-boot/src/main/java/com/youlai/system/model/form/MenuForm.java
+++ b/youlai-system/system-boot/src/main/java/com/youlai/system/model/form/MenuForm.java
@ -41,4 +41,10 @@ public class MenuForm {
    @Schema(description = "跳转路径")
    private String redirect;

+    @Schema(description = "【菜单】是否开启页面缓存", example = "1")
+    private Integer keepAlive;
+
+    @Schema(description = "【目录】只有一个子路由是否始终显示", example = "1")
+    private Integer alwaysShow;
+
 }
--- a/youlai-system/system-boot/src/main/java/com/youlai/system/model/vo/RouteVO.java
+++ b/youlai-system/system-boot/src/main/java/com/youlai/system/model/vo/RouteVO.java
@ -42,14 +42,19 @@ public class RouteVO {
        @Schema(description = "ICON")
        private String icon;

-        @Schema(description = "是否隐藏", example = "true")
+        @Schema(description = "是否隐藏(true-是 false-否)", example = "true")
        private Boolean hidden;

        @Schema(description = "拥有路由权限的角色编码", example = "['ADMIN','ROOT']")
        private List<String> roles;

-        @Schema(description = "是否开启缓存", example = "true")
+        @Schema(description = "【菜单】是否开启页面缓存", example = "true")
+        @JsonInclude(JsonInclude.Include.NON_NULL)
        private Boolean keepAlive;
+
+        @Schema(description = "【目录】只有一个子路由是否始终显示", example = "true")
+        @JsonInclude(JsonInclude.Include.NON_NULL)
+        private Boolean alwaysShow;
    }

    @Schema(description = "子路由列表")
--- a/youlai-system/system-boot/src/main/java/com/youlai/system/service/impl/SysMenuServiceImpl.java
+++ b/youlai-system/system-boot/src/main/java/com/youlai/system/service/impl/SysMenuServiceImpl.java
@ -39,7 +39,6 @@ import java.util.stream.Collectors;
@Service
@RequiredArgsConstructor
 public class SysMenuServiceImpl extends ServiceImpl<SysMenuMapper, SysMenu> implements SysMenuService {
-
    private final MenuConverter menuConverter;

    /**
@ -57,43 +56,40 @@ public class SysMenuServiceImpl extends ServiceImpl<SysMenuMapper, SysMenu> impl
        Set<Long> parentIds = menus.stream()
                .map(SysMenu::getParentId)
                .collect(Collectors.toSet());
-
        Set<Long> menuIds = menus.stream()
                .map(SysMenu::getId)
                .collect(Collectors.toSet());

-        List<Long> rootIds = CollectionUtil.subtractToList(parentIds, menuIds); // 求差集，得到 parentIds 中 menuIds 没有的元素
+        // 获取根节点ID
+        List<Long> rootIds = parentIds.stream()
+                .filter(id -> !menuIds.contains(id))
+                .toList();

-        List<MenuVO> list = new ArrayList<>();
-        for (Long rootId : rootIds) {
-            list.addAll(recurMenus(rootId, menus)); // 递归
-        }
-        return list;
+        // 使用递归函数来构建菜单树
+        List<MenuVO> menuList = rootIds.stream()
+                .flatMap(rootId -> buildMenuTree(rootId, menus).stream())
+                .collect(Collectors.toList());
+
+        return menuList;
    }

    /**
-     * 保存菜单
+     * 递归生成菜单列表
+     *
+     * @param parentId 父级ID
+     * @param menuList 菜单列表
+     * @return 菜单列表
     */
-    @Override
-    public boolean saveMenu(MenuForm menuForm) {
-        String path = menuForm.getPath();
-
-        MenuTypeEnum menuType = menuForm.getType();  // 菜单类型
-        switch (menuType) {
-            case CATALOG -> { // 目录
-                if (ObjectUtil.equal(menuForm.getParentId(), 0) && !path.startsWith("/")) {
-                    menuForm.setPath("/" + path); // 一级目录需以 / 开头
-                }
-                menuForm.setComponent("Layout");
-            }
-            case EXTLINK -> // 外链
-                    menuForm.setComponent(null);
-        }
-        SysMenu entity = menuConverter.form2Entity(menuForm);
-
-        String treePath = generateMenuTreePath(menuForm.getParentId());
-        entity.setTreePath(treePath);
-        return this.saveOrUpdate(entity);
+    private List<MenuVO> buildMenuTree(Long parentId, List<SysMenu> menuList) {
+        return CollectionUtil.emptyIfNull(menuList)
+                .stream()
+                .filter(menu -> menu.getParentId().equals(parentId))
+                .map(entity -> {
+                    MenuVO menuVO = menuConverter.entity2Vo(entity);
+                    List<MenuVO> children = buildMenuTree(entity.getId(), menuList);
+                    menuVO.setChildren(children);
+                    return menuVO;
+                }).toList();
    }

    /**
@ -102,17 +98,41 @@ public class SysMenuServiceImpl extends ServiceImpl<SysMenuMapper, SysMenu> impl
    @Override
    public List<Option> listMenuOptions() {
        List<SysMenu> menuList = this.list(new LambdaQueryWrapper<SysMenu>().orderByAsc(SysMenu::getSort));
-        return recurMenuOptions(SystemConstants.ROOT_NODE_ID, menuList);
+        return buildMenuOptions(SystemConstants.ROOT_NODE_ID, menuList);
+    }
+
+    /**
+     * 递归生成菜单下拉层级列表
+     *
+     * @param parentId 父级ID
+     * @param menuList 菜单列表
+     * @return 菜单下拉列表
+     */
+    private List<Option> buildMenuOptions(Long parentId, List<SysMenu> menuList) {
+        List<Option> menuOptions = new ArrayList<>();
+
+        for (SysMenu menu : menuList) {
+            if (menu.getParentId().equals(parentId)) {
+                Option option = new Option(menu.getId(), menu.getName());
+                List<Option> subMenuOptions = buildMenuOptions(menu.getId(), menuList);
+                if (!subMenuOptions.isEmpty()) {
+                    option.setChildren(subMenuOptions);
+                }
+                menuOptions.add(option);
+            }
+        }
+
+        return menuOptions;
    }

    /**
     * 路由列表
     */
    @Override
-    //@Cacheable(cacheNames = "system", key = "'routes'")
+    @Cacheable(cacheNames = "system", key = "'routes'")
    public List<RouteVO> listRoutes() {
        List<RouteBO> menuList = this.baseMapper.listRoutes();
-        return recurRoutes(SystemConstants.ROOT_NODE_ID, menuList);
+        return buildRoutes(SystemConstants.ROOT_NODE_ID, menuList);
    }

    /**
@ -120,34 +140,96 @@ public class SysMenuServiceImpl extends ServiceImpl<SysMenuMapper, SysMenu> impl
     *
     * @param parentId 父级ID
     * @param menuList 菜单列表
-     * @return
+     * @return 路由层级列表
     */
-    private List<RouteVO> recurRoutes(Long parentId, List<RouteBO> menuList) {
-        return CollectionUtil.emptyIfNull(menuList).stream()
-                .filter(menu -> menu.getParentId().equals(parentId))
-                .map(menu -> {
-                    RouteVO routeVO = new RouteVO();
-                    MenuTypeEnum menuTypeEnum = menu.getType();
-                    if (MenuTypeEnum.MENU.equals(menuTypeEnum)) {
-                        String routeName = StringUtils.capitalize(StrUtil.toCamelCase(menu.getPath(), '-')); // 路由 name 需要驼峰，首字母大写
-                        routeVO.setName(routeName); //  根据name路由跳转 this.$router.push({name:xxx})
+    private List<RouteVO> buildRoutes(Long parentId, List<RouteBO> menuList) {
+        List<RouteVO> routeList = new ArrayList<>();
+
+        for (RouteBO menu : menuList) {
+            if (menu.getParentId().equals(parentId)) {
+                RouteVO routeVO = toRouteVo(menu);
+                List<RouteVO> children = buildRoutes(menu.getId(), menuList);
+                if (!children.isEmpty()) {
+                    routeVO.setChildren(children);
                }
-                    routeVO.setPath(menu.getPath()); // 根据path路由跳转 this.$router.push({path:xxx})
-                    routeVO.setRedirect(menu.getRedirectUrl());
-                    routeVO.setComponent(menu.getComponent());
+                routeList.add(routeVO);
+            }
+        }
+
+        return routeList;
+    }
+
+    /**
+     * 根据RouteBO创建RouteVO
+     */
+    private RouteVO toRouteVo(RouteBO routeBO) {
+        RouteVO routeVO = new RouteVO();
+        String routeName = StringUtils.capitalize(StrUtil.toCamelCase(routeBO.getPath(), '-'));  // 路由 name 需要驼峰，首字母大写
+        routeVO.setName(routeName); // 根据name路由跳转 this.$router.push({name:xxx})
+        routeVO.setPath(routeBO.getPath()); // 根据path路由跳转 this.$router.push({path:xxx})
+        routeVO.setRedirect(routeBO.getRedirect());
+        routeVO.setComponent(routeBO.getComponent());

        RouteVO.Meta meta = new RouteVO.Meta();
-                    meta.setTitle(menu.getName());
-                    meta.setIcon(menu.getIcon());
-                    meta.setRoles(menu.getRoles());
-                    meta.setHidden(StatusEnum.DISABLE.getValue().equals(menu.getVisible()));
+        meta.setTitle(routeBO.getName());
+        meta.setIcon(routeBO.getIcon());
+        meta.setRoles(routeBO.getRoles());
+        meta.setHidden(StatusEnum.DISABLE.getValue().equals(routeBO.getVisible()));
+        // 【菜单】是否开启页面缓存
+        if (MenuTypeEnum.MENU.equals(routeBO.getType())
+                && ObjectUtil.equals(routeBO.getKeepAlive(), 1)) {
            meta.setKeepAlive(true);
-                    routeVO.setMeta(meta);
+        }
+        // 【目录】只有一个子路由是否始终显示
+        if (MenuTypeEnum.CATALOG.equals(routeBO.getType())
+                && ObjectUtil.equals(routeBO.getAlwaysShow(), 1)) {
+            meta.setAlwaysShow(true);
+        }

-                    List<RouteVO> children = recurRoutes(menu.getId(), menuList);
-                    routeVO.setChildren(children);
+        routeVO.setMeta(meta);
        return routeVO;
-                }).toList();
+    }
+
+    /**
+     * 保存菜单
+     */
+    @Override
+    public boolean saveMenu(MenuForm menuForm) {
+        String path = menuForm.getPath();
+        MenuTypeEnum menuType = menuForm.getType();
+
+        // 如果是目录
+        if (menuType == MenuTypeEnum.CATALOG) {
+            if (menuForm.getParentId() == 0 && !path.startsWith("/")) {
+                menuForm.setPath("/" + path); // 一级目录需以 / 开头
+            }
+            menuForm.setComponent("Layout");
+        }
+        // 如果是外链
+        else if (menuType == MenuTypeEnum.EXTLINK) {
+            menuForm.setComponent(null);
+        }
+
+        SysMenu entity = menuConverter.form2Entity(menuForm);
+        String treePath = generateMenuTreePath(menuForm.getParentId());
+        entity.setTreePath(treePath);
+
+        return this.saveOrUpdate(entity);
+    }
+
+    /**
+     * 部门路径生成
+     *
+     * @param parentId 父ID
+     * @return 父节点路径以英文逗号(, )分割，eg: 1,2,3
+     */
+    private String generateMenuTreePath(Long parentId) {
+        if (SystemConstants.ROOT_NODE_ID.equals(parentId)) {
+            return String.valueOf(parentId);
+        } else {
+            SysMenu parent = this.getById(parentId);
+            return parent != null ? parent.getTreePath() + "," + parent.getId() : null;
+        }
    }


@ -208,59 +290,5 @@ public class SysMenuServiceImpl extends ServiceImpl<SysMenuMapper, SysMenu> impl
        return true;
    }

-    /**
-     * 递归生成菜单列表
-     *
-     * @param parentId 父级ID
-     * @param menuList 菜单列表
-     * @return
-     */
-    private List<MenuVO> recurMenus(Long parentId, List<SysMenu> menuList) {
-        return CollectionUtil.emptyIfNull(menuList)
-                .stream()
-                .filter(menu -> menu.getParentId().equals(parentId))
-                .map(entity -> {
-                    MenuVO menuVO = menuConverter.entity2Vo(entity);
-                    List<MenuVO> children = recurMenus(entity.getId(), menuList);
-                    menuVO.setChildren(children);
-                    return menuVO;
-                }).toList();
-    }
-
-    /**
-     * 递归生成菜单下拉层级列表
-     *
-     * @param parentId 父级ID
-     * @param menuList 菜单列表
-     * @return
-     */
-    private static List<Option> recurMenuOptions(Long parentId, List<SysMenu> menuList) {
-        List<Option> menus = CollectionUtil.emptyIfNull(menuList).stream()
-                .filter(menu -> menu.getParentId().equals(parentId))
-                .map(menu -> new Option(menu.getId(), menu.getName(), recurMenuOptions(menu.getId(), menuList)))
-                .collect(ArrayList::new, ArrayList::add, ArrayList::addAll);
-        return menus;
-    }
-
-
-    /**
-     * 部门路径生成
-     *
-     * @param parentId 父ID
-     * @return 父节点路径以英文逗号(, )分割，eg: 1,2,3
-     */
-    private String generateMenuTreePath(Long parentId) {
-        String treePath = null;
-        if (SystemConstants.ROOT_NODE_ID.equals(parentId)) {
-            treePath = String.valueOf(parentId);
-        } else {
-            SysMenu parent = this.getById(parentId);
-            if (parent != null) {
-                treePath = parent.getTreePath() + "," + parent.getId();
-            }
-        }
-        return treePath;
-    }
-

 }
--- a/youlai-system/system-boot/src/main/resources/mapper/SysMenuMapper.xml
+++ b/youlai-system/system-boot/src/main/resources/mapper/SysMenuMapper.xml
@ -11,7 +11,7 @@
        <result property="parentId" column="parent_id" jdbcType="BIGINT"/>
        <result property="path" column="path" jdbcType="VARCHAR"/>
        <result property="component" column="component" jdbcType="VARCHAR"/>
-        <result property="redirectUrl" column="redirect_url" jdbcType="VARCHAR"/>
+        <result property="redirect" column="redirect" jdbcType="VARCHAR"/>
        <result property="icon" column="icon" jdbcType="VARCHAR"/>
        <result property="sort" column="sort" jdbcType="INTEGER"/>
        <result property="visible" column="visible" jdbcType="BOOLEAN"/>
@ -32,9 +32,11 @@
           t1.icon,
           t1.sort,
           t1.visible,
-           t1.redirect_url,
+           t1.redirect,
           t1.type,
-           t3.code
+           t3.code,
+           t1.always_show,
+           t1.keep_alive
        FROM
            sys_menu t1
                 LEFT JOIN sys_role_menu t2 ON t1.id = t2.menu_id