admin/lx-admin-backend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs：补充Mapper层注释

Browse Source
This commit is contained in:
AprilWind 2024-11-11 10:05:52 +08:00
parent 8e749c472a
commit b820a98c6c
6 changed files with 77 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysDeptMapper.java
View File

@ -3,13 +3,13 @@ package org.dromara.system.mapper;
import com.baomidou.mybatisplus.core.conditions.Wrapper;
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.core.toolkit.Constants;
import org.apache.ibatis.annotations.Param;
import org.dromara.common.mybatis.annotation.DataColumn;
import org.dromara.common.mybatis.annotation.DataPermission;
import org.dromara.common.mybatis.core.mapper.BaseMapperPlus;
import org.dromara.common.mybatis.helper.DataBaseHelper;
import org.dromara.system.domain.SysDept;
import org.dromara.system.domain.vo.SysDeptVo;
import org.apache.ibatis.annotations.Param;
import java.util.List;
@ -31,11 +31,23 @@ public interface SysDeptMapper extends BaseMapperPlus<SysDept, SysDeptVo> {
})
List<SysDeptVo> selectDeptList(@Param(Constants.WRAPPER) Wrapper<SysDept> queryWrapper);
/**
* 统计指定部门ID的部门数量
*
* @param deptId 部门ID
* @return 该部门ID的部门数量
*/
@DataPermission({
@DataColumn(key = "deptName", value = "dept_id")
})
long countDeptById(Long deptId);
/**
* 根据父部门ID查询其所有子部门的列表
*
* @param parentId 父部门ID
* @return 包含子部门的列表
*/
default List<SysDept> selectListByParentId(Long parentId) {
return this.selectList(new LambdaQueryWrapper<SysDept>()
.select(SysDept::getDeptId)

6
ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysDictDataMapper.java
View File

@ -14,6 +14,12 @@ import java.util.List;
*/
public interface SysDictDataMapper extends BaseMapperPlus<SysDictData, SysDictDataVo> {
/**
* 根据字典类型查询字典数据列表
*
* @param dictType 字典类型
* @return 符合条件的字典数据列表
*/
default List<SysDictDataVo> selectDictDataByType(String dictType) {
return selectVoList(
new LambdaQueryWrapper<SysDictData>()

7
ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysPostMapper.java
View File

@ -19,6 +19,13 @@ import java.util.List;
*/
public interface SysPostMapper extends BaseMapperPlus<SysPost, SysPostVo> {
/**
* 分页查询岗位列表
*
* @param page 分页对象
* @param queryWrapper 查询条件
* @return 包含岗位信息的分页结果
*/
@DataPermission({
@DataColumn(key = "deptName", value = "dept_id"),
@DataColumn(key = "userName", value = "create_by")

13
ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysRoleMapper.java
View File

@ -19,6 +19,13 @@ import java.util.List;
*/
public interface SysRoleMapper extends BaseMapperPlus<SysRole, SysRoleVo> {
/**
* 分页查询角色列表
*
* @param page 分页对象
* @param queryWrapper 查询条件
* @return 包含角色信息的分页结果
*/
@DataPermission({
@DataColumn(key = "deptName", value = "d.dept_id"),
@DataColumn(key = "userName", value = "r.create_by")
@ -37,6 +44,12 @@ public interface SysRoleMapper extends BaseMapperPlus<SysRole, SysRoleVo> {
})
List<SysRoleVo> selectRoleList(@Param(Constants.WRAPPER) Wrapper<SysRole> queryWrapper);
/**
* 根据角色ID查询角色信息
*
* @param roleId 角色ID
* @return 对应的角色信息
*/
@DataPermission({
@DataColumn(key = "deptName", value = "d.dept_id"),
@DataColumn(key = "userName", value = "r.create_by")

32
ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysUserMapper.java
View File

@ -20,12 +20,25 @@ import java.util.List;
*/
public interface SysUserMapper extends BaseMapperPlus<SysUser, SysUserVo> {
/**
* 分页查询用户列表，并进行数据权限控制
*
* @param page 分页参数
* @param queryWrapper 查询条件
* @return 分页的用户信息
*/
@DataPermission({
@DataColumn(key = "deptName", value = "u.dept_id"),
@DataColumn(key = "userName", value = "u.user_id")
})
Page<SysUserVo> selectPageUserList(@Param("page") Page<SysUser> page, @Param(Constants.WRAPPER) Wrapper<SysUser> queryWrapper);
/**
* 查询用户列表，并进行数据权限控制
*
* @param queryWrapper 查询条件
* @return 用户信息集合
*/
@DataPermission({
@DataColumn(key = "deptName", value = "dept_id"),
@DataColumn(key = "userName", value = "user_id")
@ -68,12 +81,25 @@ public interface SysUserMapper extends BaseMapperPlus<SysUser, SysUserVo> {
})
Page<SysUserVo> selectUnallocatedList(@Param("page") Page<SysUser> page, @Param(Constants.WRAPPER) Wrapper<SysUser> queryWrapper);
/**
* 根据用户ID统计用户数量
*
* @param userId 用户ID
* @return 用户数量
*/
@DataPermission({
@DataColumn(key = "deptName", value = "dept_id"),
@DataColumn(key = "userName", value = "user_id")
})
long countUserById(Long userId);
/**
* 根据条件更新用户数据
*
* @param user 要更新的用户实体
* @param updateWrapper 更新条件封装器
* @return 更新操作影响的行数
*/
@Override
@DataPermission({
@DataColumn(key = "deptName", value = "dept_id"),
@ -81,6 +107,12 @@ public interface SysUserMapper extends BaseMapperPlus<SysUser, SysUserVo> {
})
int update(@Param(Constants.ENTITY) SysUser user, @Param(Constants.WRAPPER) Wrapper<SysUser> updateWrapper);
/**
* 根据用户ID更新用户数据
*
* @param user 要更新的用户实体
* @return 更新操作影响的行数
*/
@Override
@DataPermission({
@DataColumn(key = "deptName", value = "dept_id"),

6
ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysUserRoleMapper.java
View File

@ -12,6 +12,12 @@ import java.util.List;
*/
public interface SysUserRoleMapper extends BaseMapperPlus<SysUserRole, SysUserRole> {
/**
* 根据角色ID查询关联的用户ID列表
*
* @param roleId 角色ID
* @return 关联到指定角色的用户ID列表
*/
List<Long> selectUserIdsByRoleId(Long roleId);
}