doc:注释更新

service-base/src/main/java/com/simuwang/base/utils/TreeUtil.java

@@ -8,8 +8,24 @@ import java.util.List;
 import java.util.function.BiConsumer;
 import java.util.function.Function;
 
+/**
+ * @author wangzaijun
+ * @date 2024/9/13 11:35
+ * @description 集合转树工具
+ */
 public class TreeUtil {
-    // list转树，不排序
+    /**
+     * 集合对象转树结构，对象必须包含所需的树节点字段，不支持排序
+     *
+     * @param list        集合数据
+     * @param getId       从对象T中获取id字段的方法
+     * @param getParentId 从对象T中获取pid字段的方法
+     * @param getChildren 从对象T中获取children字段的方法
+     * @param setChildren 从对象T中设置children字段的方法
+     * @param root        根节点的id值
+     * @param <T>         对象类型
+     * @return 转换后的树结构
+     */
     public static <T> List<T> list2Tree(List<T> list,
                                         Function<T, Serializable> getId,
                                         Function<T, Serializable> getParentId,
@@ -19,7 +35,19 @@ public class TreeUtil {
         return list2Tree(list, getId, getParentId, getChildren, setChildren, root, null);
     }
 
-    // list转树，可排序
+    /**
+     * 集合对象转树结构，对象必须包含所需的树节点字段，支持排序
+     *
+     * @param list        集合数据
+     * @param getId       从对象T中获取id字段的方法
+     * @param getParentId 从对象T中获取pid字段的方法
+     * @param getChildren 从对象T中获取children字段的方法
+     * @param setChildren 从对象T中设置children字段的方法
+     * @param root        根节点的id值
+     * @param getOrder    排序方法
+     * @param <T>         对象类型
+     * @return 转换后的树结构
+     */
     public static <T> List<T> list2Tree(List<T> list,
                                         Function<T, Serializable> getId,
                                         Function<T, Serializable> getParentId,

service-manage/src/main/java/com/simuwang/manage/api/LoginController.java

@@ -37,6 +37,7 @@ public class LoginController {
 
     /**
      * 获取rsk公钥
+     *
      * @return /
      */
     @GetMapping("rsa-key")
@@ -46,8 +47,9 @@ public class LoginController {
 
     /**
      * 用户登录
+     *
      * @param loginUser 登录用户账号和密码
-     * @param response 响应体对象
+     * @param response  响应体对象
      * @return /
      */
     @PostMapping("login")
@@ -75,9 +77,11 @@ public class LoginController {
     }
 
     /**
-     * 获取当前
-     * @return
+     * 获取当前用户的角色权限信息
+     *
+     * @return 当前登录用户的角色权限信息
      */
+    @RequiresAuthentication
     @GetMapping("/user-info")
     public UserInfoVO getUserInfo() {
         return this.systemService.getUserInfo();

service-manage/src/main/java/com/simuwang/manage/dto/LoginUser.java

@@ -30,4 +30,10 @@ public class LoginUser {
     public void setPassword(String password) {
         this.password = password;
     }
+
+    @Override
+    public String toString() {
+        return "{username='" + username + '\'' +
+                ", password='***'";
+    }
 }

service-manage/src/main/java/com/simuwang/manage/dto/UserMenuTreeDTO.java

@@ -11,18 +11,53 @@ import java.util.List;
  * @description 用户菜单树
  */
 public class UserMenuTreeDTO {
+    /**
+     * 当前菜单id
+     */
     private Integer id;
+    /**
+     * 父id
+     */
     private Integer pid;
+    /**
+     * 排序，越小越靠前
+     */
     private Integer sort;
+    /**
+     * 名称
+     */
     private String name;
+    /**
+     * 唯一编码
+     */
     private String code;
+    /**
+     * 路由
+     */
     private String path;
+    /**
+     * 前端页面
+     */
     private String component;
+    /**
+     * 路由参数
+     */
     private String query;
+    /**
+     * 菜单类型,M-目录，C-菜单，F-按钮
+     */
     private String menuType;
+    /**
+     * 显示状态（0显示 1隐藏）
+     */
     private Integer visible;
+    /**
+     * 图标
+     */
     private String icon;
-
+    /**
+     * 子菜单
+     */
     private List<UserMenuTreeDTO> children;
 
     public UserMenuTreeDTO() {

service-manage/src/main/java/com/simuwang/manage/service/SystemService.java

@@ -46,7 +46,7 @@ public class SystemService {
         List<UserMenuTreeDTO> tempList = menuList.stream().map(UserMenuTreeDTO::new).collect(Collectors.toList());
         // 菜单列表转树结构
         List<UserMenuTreeDTO> trees = TreeUtil.list2Tree(tempList, UserMenuTreeDTO::getId, UserMenuTreeDTO::getPid,
-                UserMenuTreeDTO::getChildren, UserMenuTreeDTO::setChildren, 0);
+                UserMenuTreeDTO::getChildren, UserMenuTreeDTO::setChildren, 0, UserMenuTreeDTO::getSort);
         UserMenuTreeDTO root = new UserMenuTreeDTO(0, "全部菜单", trees);
         // 返回的数据结构构建
         return new UserInfoVO(userId, username, roles, root);