wol/AgileBoot-Back-End
2
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

补充缺少的javadoc注释

Browse Source
This commit is contained in:
imlam
2023-07-14 14:20:20 +08:00
parent 2401ec2c62
commit 92b698a313
13 changed files with 69 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
agileboot-orm/src/main/java/com/agileboot/orm/common/query/AbstractPageQuery.java
View File

@@ -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<T> extends AbstractQuery<T> {

6
agileboot-orm/src/main/java/com/agileboot/orm/common/query/AbstractQuery.java
View File

@@ -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<T> {
/**
* 生成query conditions
* @return
*
* @return 添加条件后的QueryWrapper
*/
public QueryWrapper<T> toQueryWrapper() {
QueryWrapper<T> queryWrapper = addQueryCondition();

8
agileboot-orm/src/main/java/com/agileboot/orm/system/mapper/SysMenuMapper.java
View File

@@ -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;
/**
* <p>
* 菜单权限表 Mapper 接口
@@ -18,8 +19,9 @@ public interface SysMenuMapper extends BaseMapper<SysMenuEntity> {
/**
* 根据用户查询出所有菜单
* @param userId
* @return
*
* @param userId 用户id
* @return 菜单列表
*/
@Select("SELECT DISTINCT m.* "
+ "FROM sys_menu m "

7
agileboot-orm/src/main/java/com/agileboot/orm/system/mapper/SysNoticeMapper.java
View File

@@ -20,9 +20,10 @@ public interface SysNoticeMapper extends BaseMapper<SysNoticeEntity> {
/**
* 根据条件分页查询角色关联的用户列表
* @param page
* @param queryWrapper
* @return
*
* @param page 分页对象
* @param queryWrapper 条件选择器
* @return 分页处理后的公告列表
*/
@Select("SELECT n.* "
+ "FROM sys_notice n "

12
agileboot-orm/src/main/java/com/agileboot/orm/system/mapper/SysUserMapper.java
View File

@@ -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;
/**
* <p>
* 用户信息表 Mapper 接口
@@ -67,9 +68,10 @@ public interface SysUserMapper extends BaseMapper<SysUserEntity> {
/**
* 根据条件分页查询角色关联的用户列表
* @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 "

2
agileboot-orm/src/main/java/com/agileboot/orm/system/result/SearchUserDO.java
View File

@@ -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 {

3
agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysConfigService.java
View File

@@ -15,8 +15,9 @@ public interface ISysConfigService extends IService<SysConfigEntity> {
/**
* 通过key获取配置
*
* @param key 配置对应的key
* @return
* @return 配置
*/
String getConfigValueByKey(String key);

15
agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysDeptService.java
View File

@@ -16,10 +16,11 @@ public interface ISysDeptService extends IService<SysDeptEntity> {
/**
* 检测部门名称是否一致
* @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<SysDeptEntity> {
* 是否是目标部门的子部门
* @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);

10
agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysMenuService.java
View File

@@ -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<SysMenuEntity> {
/**
* 校验菜单名称是否唯一
* @param menuName
* @param menuId
* @param parentId
* @return
*
* @param menuName 菜单名称
* @param menuId 菜单id
* @param parentId 父级菜单id
* @return 校验结果
*/
boolean isMenuNameDuplicated(String menuName, Long menuId, Long parentId);

5
agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysNoticeService.java
View File

@@ -19,9 +19,10 @@ public interface ISysNoticeService extends IService<SysNoticeEntity> {
/**
* 获取公告列表
* @param page 页码对象
*
* @param page 页码对象
* @param queryWrapper 查询对象
* @return
* @return 分页处理后的公告列表
*/
Page<SysNoticeEntity> getNoticeList(Page<SysNoticeEntity> page,
@Param(Constants.WRAPPER) Wrapper<SysNoticeEntity> queryWrapper);

3
agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysPostService.java
View File

@@ -32,8 +32,9 @@ public interface ISysPostService extends IService<SysPostEntity> {
/**
* 检测职位是否分配给用户
*
* @param postId 职位id
* @return
* @return 校验结果
*/
boolean isAssignedToUsers(Long postId);

10
agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysRoleService.java
View File

@@ -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<SysRoleEntity> {
/**
* 检测角色是否分配给用户
* @param roleId
* @return
*
* @param roleId 角色id
* @return 校验结果
*/
boolean isAssignedToUsers(Long roleId);
/**
* 获取用户的权限列表
* @param roleId
* @return
* @param roleId 角色id
* @return 菜单列表
*/
List<SysMenuEntity> getMenuListByRoleId(Long roleId);

30
agileboot-orm/src/main/java/com/agileboot/orm/system/service/ISysUserService.java
View File

@@ -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<SysUserEntity> {
/**
* 检测号码是否唯一
* @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<String> getMenuPermissionsForUser(Long userId);