From b820a98c6cece449e6822a0ef39047c5503e2d3f Mon Sep 17 00:00:00 2001
From: AprilWind <2100166581@qq.com>
Date: 星期一, 11 十一月 2024 10:05:52 +0800
Subject: [PATCH] docs：补充Mapper层注释
---
ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysPostMapper.java | 7 +++
ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysUserRoleMapper.java | 6 +++
ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysDictDataMapper.java | 6 +++
ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysDeptMapper.java | 14 ++++++
ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysUserMapper.java | 32 ++++++++++++++++
ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysRoleMapper.java | 13 ++++++
6 files changed, 77 insertions(+), 1 deletions(-)
diff --git a/ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysDeptMapper.java b/ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysDeptMapper.java
index 048d2fa..0f2c906 100644
--- a/ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysDeptMapper.java
+++ b/ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysDeptMapper.java
@@ -3,13 +3,13 @@
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 @@
})
List<SysDeptVo> selectDeptList(@Param(Constants.WRAPPER) Wrapper<SysDept> queryWrapper);
+ /**
+ * 缁熻鎸囧畾閮ㄩ棬ID鐨勯儴闂ㄦ暟閲�
+ *
+ * @param deptId 閮ㄩ棬ID
+ * @return 璇ラ儴闂↖D鐨勯儴闂ㄦ暟閲�
+ */
@DataPermission({
@DataColumn(key = "deptName", value = "dept_id")
})
long countDeptById(Long deptId);
+ /**
+ * 鏍规嵁鐖堕儴闂↖D鏌ヨ鍏舵墍鏈夊瓙閮ㄩ棬鐨勫垪琛�
+ *
+ * @param parentId 鐖堕儴闂↖D
+ * @return 鍖呭惈瀛愰儴闂ㄧ殑鍒楄〃
+ */
default List<SysDept> selectListByParentId(Long parentId) {
return this.selectList(new LambdaQueryWrapper<SysDept>()
.select(SysDept::getDeptId)
diff --git a/ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysDictDataMapper.java b/ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysDictDataMapper.java
index c2f1a7c..7298db3 100644
--- a/ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysDictDataMapper.java
+++ b/ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysDictDataMapper.java
@@ -14,6 +14,12 @@
*/
public interface SysDictDataMapper extends BaseMapperPlus<SysDictData, SysDictDataVo> {
+ /**
+ * 鏍规嵁瀛楀吀绫诲瀷鏌ヨ瀛楀吀鏁版嵁鍒楄〃
+ *
+ * @param dictType 瀛楀吀绫诲瀷
+ * @return 绗﹀悎鏉′欢鐨勫瓧鍏告暟鎹垪琛�
+ */
default List<SysDictDataVo> selectDictDataByType(String dictType) {
return selectVoList(
new LambdaQueryWrapper<SysDictData>()
diff --git a/ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysPostMapper.java b/ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysPostMapper.java
index f9bf134..60da074 100644
--- a/ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysPostMapper.java
+++ b/ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysPostMapper.java
@@ -19,6 +19,13 @@
*/
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")
diff --git a/ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysRoleMapper.java b/ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysRoleMapper.java
index ac5a47e..9cb1ea5 100644
--- a/ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysRoleMapper.java
+++ b/ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysRoleMapper.java
@@ -19,6 +19,13 @@
*/
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 @@
})
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")
diff --git a/ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysUserMapper.java b/ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysUserMapper.java
index fc7fc6e..46695aa 100644
--- a/ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysUserMapper.java
+++ b/ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysUserMapper.java
@@ -20,12 +20,25 @@
*/
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 @@
})
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 @@
})
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"),
diff --git a/ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysUserRoleMapper.java b/ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysUserRoleMapper.java
index e2f706c..8340348 100644
--- a/ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysUserRoleMapper.java
+++ b/ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/mapper/SysUserRoleMapper.java
@@ -12,6 +12,12 @@
*/
public interface SysUserRoleMapper extends BaseMapperPlus<SysUserRole, SysUserRole> {
+ /**
+ * 鏍规嵁瑙掕壊ID鏌ヨ鍏宠仈鐨勭敤鎴稩D鍒楄〃
+ *
+ * @param roleId 瑙掕壊ID
+ * @return 鍏宠仈鍒版寚瀹氳鑹茬殑鐢ㄦ埛ID鍒楄〃
+ */
List<Long> selectUserIdsByRoleId(Long roleId);
}
--
Gitblit v1.9.3