From 92b698a313d9c0a3e3ef242cb074a04741dba69b Mon Sep 17 00:00:00 2001 From: imlam Date: Fri, 14 Jul 2023 14:20:20 +0800 Subject: [PATCH] =?UTF-8?q?=E8=A1=A5=E5=85=85=E7=BC=BA=E5=B0=91=E7=9A=84ja?= =?UTF-8?q?vadoc=E6=B3=A8=E9=87=8A?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../orm/common/query/AbstractPageQuery.java | 5 +++- .../orm/common/query/AbstractQuery.java | 6 ++-- .../orm/system/mapper/SysMenuMapper.java | 8 +++-- .../orm/system/mapper/SysNoticeMapper.java | 7 +++-- .../orm/system/mapper/SysUserMapper.java | 12 ++++---- .../orm/system/result/SearchUserDO.java | 2 ++ .../orm/system/service/ISysConfigService.java | 3 +- .../orm/system/service/ISysDeptService.java | 15 +++++----- .../orm/system/service/ISysMenuService.java | 10 ++++--- .../orm/system/service/ISysNoticeService.java | 5 ++-- .../orm/system/service/ISysPostService.java | 3 +- .../orm/system/service/ISysRoleService.java | 10 ++++--- .../orm/system/service/ISysUserService.java | 30 ++++++++++--------- 13 files changed, 69 insertions(+), 47 deletions(-) diff --git a/agileboot-orm/src/main/java/com/agileboot/orm/common/query/AbstractPageQuery.java b/agileboot-orm/src/main/java/com/agileboot/orm/common/query/AbstractPageQuery.java index 299f648..4436914 100644 --- a/agileboot-orm/src/main/java/com/agileboot/orm/common/query/AbstractPageQuery.java +++ b/agileboot-orm/src/main/java/com/agileboot/orm/common/query/AbstractPageQuery.java @@ -1,12 +1,15 @@ package com.agileboot.orm.common.query; import com.baomidou.mybatisplus.extension.plugins.pagination.Page; -import javax.validation.constraints.Max; import lombok.Data; +import lombok.EqualsAndHashCode; + +import javax.validation.constraints.Max; /** * @author valarchie */ +@EqualsAndHashCode(callSuper = true) @Data public abstract class AbstractPageQuery extends AbstractQuery { diff --git a/agileboot-orm/src/main/java/com/agileboot/orm/common/query/AbstractQuery.java b/agileboot-orm/src/main/java/com/agileboot/orm/common/query/AbstractQuery.java index 931aed8..2bcb9a4 100644 --- a/agileboot-orm/src/main/java/com/agileboot/orm/common/query/AbstractQuery.java +++ b/agileboot-orm/src/main/java/com/agileboot/orm/common/query/AbstractQuery.java @@ -5,9 +5,10 @@ import com.agileboot.common.utils.time.DatePickUtil; import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper; import com.fasterxml.jackson.annotation.JsonFormat; import com.fasterxml.jackson.annotation.JsonFormat.Shape; -import java.util.Date; import lombok.Data; +import java.util.Date; + /** * 如果是简单的排序 和 时间范围筛选 可以使用内置的这几个字段 * @author valarchie @@ -32,7 +33,8 @@ public abstract class AbstractQuery { /** * 生成query conditions - * @return + * + * @return 添加条件后的QueryWrapper */ public QueryWrapper toQueryWrapper() { QueryWrapper queryWrapper = addQueryCondition(); diff --git a/agileboot-orm/src/main/java/com/agileboot/orm/system/mapper/SysMenuMapper.java b/agileboot-orm/src/main/java/com/agileboot/orm/system/mapper/SysMenuMapper.java index a3e98fc..fa0c253 100644 --- a/agileboot-orm/src/main/java/com/agileboot/orm/system/mapper/SysMenuMapper.java +++ b/agileboot-orm/src/main/java/com/agileboot/orm/system/mapper/SysMenuMapper.java @@ -2,10 +2,11 @@ package com.agileboot.orm.system.mapper; import com.agileboot.orm.system.entity.SysMenuEntity; import com.baomidou.mybatisplus.core.mapper.BaseMapper; -import java.util.List; import org.apache.ibatis.annotations.Param; import org.apache.ibatis.annotations.Select; +import java.util.List; + /** *

* 菜单权限表 Mapper 接口 @@ -18,8 +19,9 @@ public interface SysMenuMapper extends BaseMapper { /** * 根据用户查询出所有菜单 - * @param userId - * @return + * + * @param userId 用户id + * @return 菜单列表 */ @Select("SELECT DISTINCT m.* " + "FROM sys_menu m " diff --git a/agileboot-orm/src/main/java/com/agileboot/orm/system/mapper/SysNoticeMapper.java b/agileboot-orm/src/main/java/com/agileboot/orm/system/mapper/SysNoticeMapper.java index 69d6e7f..0cf6b70 100644 --- a/agileboot-orm/src/main/java/com/agileboot/orm/system/mapper/SysNoticeMapper.java +++ b/agileboot-orm/src/main/java/com/agileboot/orm/system/mapper/SysNoticeMapper.java @@ -20,9 +20,10 @@ public interface SysNoticeMapper extends BaseMapper { /** * 根据条件分页查询角色关联的用户列表 - * @param page - * @param queryWrapper - * @return + * + * @param page 分页对象 + * @param queryWrapper 条件选择器 + * @return 分页处理后的公告列表 */ @Select("SELECT n.* " + "FROM sys_notice n " diff --git a/agileboot-orm/src/main/java/com/agileboot/orm/system/mapper/SysUserMapper.java b/agileboot-orm/src/main/java/com/agileboot/orm/system/mapper/SysUserMapper.java index ce0057e..991173d 100644 --- a/agileboot-orm/src/main/java/com/agileboot/orm/system/mapper/SysUserMapper.java +++ b/agileboot-orm/src/main/java/com/agileboot/orm/system/mapper/SysUserMapper.java @@ -8,11 +8,12 @@ import com.baomidou.mybatisplus.core.conditions.Wrapper; import com.baomidou.mybatisplus.core.mapper.BaseMapper; import com.baomidou.mybatisplus.core.toolkit.Constants; import com.baomidou.mybatisplus.extension.plugins.pagination.Page; -import java.util.List; -import java.util.Set; import org.apache.ibatis.annotations.Param; import org.apache.ibatis.annotations.Select; +import java.util.List; +import java.util.Set; + /** *

* 用户信息表 Mapper 接口 @@ -67,9 +68,10 @@ public interface SysUserMapper extends BaseMapper { /** * 根据条件分页查询角色关联的用户列表 - * @param page - * @param queryWrapper - * @return + * + * @param page 分页对象 + * @param queryWrapper 条件选择器 + * @return 分页处理后的用户列表 */ @Select("SELECT DISTINCT u.user_id, u.dept_id, u.username, u.nick_name, u.email " + " , u.phone_number, u.status, u.create_time " diff --git a/agileboot-orm/src/main/java/com/agileboot/orm/system/result/SearchUserDO.java b/agileboot-orm/src/main/java/com/agileboot/orm/system/result/SearchUserDO.java index 4d15092..0ea5074 100644 --- a/agileboot-orm/src/main/java/com/agileboot/orm/system/result/SearchUserDO.java +++ b/agileboot-orm/src/main/java/com/agileboot/orm/system/result/SearchUserDO.java @@ -2,11 +2,13 @@ package com.agileboot.orm.system.result; import com.agileboot.orm.system.entity.SysUserEntity; import lombok.Data; +import lombok.EqualsAndHashCode; /** * 如果Entity的字段和复杂查询不匹配时 自定义类来接收 * @author valarchie */ +@EqualsAndHashCode(callSuper = true) @Data public class SearchUserDO extends SysUserEntity { diff --git a/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysConfigService.java b/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysConfigService.java index 51db4a8..6188f53 100644 --- a/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysConfigService.java +++ b/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysConfigService.java @@ -15,8 +15,9 @@ public interface ISysConfigService extends IService { /** * 通过key获取配置 + * * @param key 配置对应的key - * @return + * @return 配置 */ String getConfigValueByKey(String key); diff --git a/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysDeptService.java b/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysDeptService.java index 8534d8d..27d7b62 100644 --- a/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysDeptService.java +++ b/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysDeptService.java @@ -16,10 +16,11 @@ public interface ISysDeptService extends IService { /** * 检测部门名称是否一致 - * @param deptName - * @param deptId - * @param parentId - * @return + * + * @param deptName 部门名称 + * @param deptId 部门id + * @param parentId 父级部门id + * @return 校验结果 */ boolean isDeptNameDuplicated(String deptName, Long deptId, Long parentId); @@ -35,14 +36,14 @@ public interface ISysDeptService extends IService { * 是否是目标部门的子部门 * @param parentId 目标部门id * @param childId 子部门id - * @return + * @return 校验结果 */ boolean isChildOfTheDept(Long parentId, Long childId); /** * 检测该部门是否已有用户使用 - * @param deptId - * @return + * @param deptId 部门id + * @return 校验结果 */ boolean isDeptAssignedToUsers(Long deptId); diff --git a/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysMenuService.java b/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysMenuService.java index df0e7c6..248d79c 100644 --- a/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysMenuService.java +++ b/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysMenuService.java @@ -2,6 +2,7 @@ package com.agileboot.orm.system.service; import com.agileboot.orm.system.entity.SysMenuEntity; import com.baomidou.mybatisplus.extension.service.IService; + import java.util.List; /** @@ -32,10 +33,11 @@ public interface ISysMenuService extends IService { /** * 校验菜单名称是否唯一 - * @param menuName - * @param menuId - * @param parentId - * @return + * + * @param menuName 菜单名称 + * @param menuId 菜单id + * @param parentId 父级菜单id + * @return 校验结果 */ boolean isMenuNameDuplicated(String menuName, Long menuId, Long parentId); diff --git a/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysNoticeService.java b/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysNoticeService.java index f5f0bd8..01a46f7 100644 --- a/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysNoticeService.java +++ b/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysNoticeService.java @@ -19,9 +19,10 @@ public interface ISysNoticeService extends IService { /** * 获取公告列表 - * @param page 页码对象 + * + * @param page 页码对象 * @param queryWrapper 查询对象 - * @return + * @return 分页处理后的公告列表 */ Page getNoticeList(Page page, @Param(Constants.WRAPPER) Wrapper queryWrapper); diff --git a/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysPostService.java b/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysPostService.java index 5ec0ed1..3d76749 100644 --- a/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysPostService.java +++ b/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysPostService.java @@ -32,8 +32,9 @@ public interface ISysPostService extends IService { /** * 检测职位是否分配给用户 + * * @param postId 职位id - * @return + * @return 校验结果 */ boolean isAssignedToUsers(Long postId); diff --git a/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysRoleService.java b/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysRoleService.java index c381eaa..afdce86 100644 --- a/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysRoleService.java +++ b/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysRoleService.java @@ -3,6 +3,7 @@ package com.agileboot.orm.system.service; import com.agileboot.orm.system.entity.SysMenuEntity; import com.agileboot.orm.system.entity.SysRoleEntity; import com.baomidou.mybatisplus.extension.service.IService; + import java.util.List; /** @@ -35,15 +36,16 @@ public interface ISysRoleService extends IService { /** * 检测角色是否分配给用户 - * @param roleId - * @return + * + * @param roleId 角色id + * @return 校验结果 */ boolean isAssignedToUsers(Long roleId); /** * 获取用户的权限列表 - * @param roleId - * @return + * @param roleId 角色id + * @return 菜单列表 */ List getMenuListByRoleId(Long roleId); diff --git a/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysUserService.java b/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysUserService.java index a19579f..0d00801 100644 --- a/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysUserService.java +++ b/agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysUserService.java @@ -7,6 +7,7 @@ import com.agileboot.orm.system.entity.SysUserEntity; import com.agileboot.orm.system.result.SearchUserDO; import com.baomidou.mybatisplus.extension.plugins.pagination.Page; import com.baomidou.mybatisplus.extension.service.IService; + import java.util.Set; /** @@ -21,45 +22,46 @@ public interface ISysUserService extends IService { /** * 检测号码是否唯一 - * @param phone - * @param userId - * @return + * + * @param phone 电话号码 + * @param userId 用户id + * @return 校验结果 */ boolean isPhoneDuplicated(String phone, Long userId); /** * 检测邮箱是否唯一 - * @param email - * @param userId - * @return + * @param email 邮箱 + * @param userId 用户id + * @return 校验结果 */ boolean isEmailDuplicated(String email, Long userId); /** * 检测用户名是否 - * @param userName - * @return + * @param userName 用户名 + * @return 校验结果 */ boolean isUserNameDuplicated(String userName); /** * 获取用户的角色 - * @param userId - * @return + * @param userId 用户id + * @return 用户角色 */ SysRoleEntity getRoleOfUser(Long userId); /** * 获取用户的岗位 - * @param userId - * @return + * @param userId 用户id + * @return 用户岗位 */ SysPostEntity getPostOfUser(Long userId); /** * 获取用户的权限列表 - * @param userId - * @return + * @param userId 用户id + * @return 用户菜单权限列表 */ Set getMenuPermissionsForUser(Long userId);