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-common/ruoyi-common-mybatis/src/main/java/org/dromara/common/mybatis/interceptor/PlusDataPermissionInterceptor.java | 113 ++++++++++++++++++++++++++++++++++++++++++--------------
1 files changed, 84 insertions(+), 29 deletions(-)
diff --git a/ruoyi-common/ruoyi-common-mybatis/src/main/java/org/dromara/common/mybatis/interceptor/PlusDataPermissionInterceptor.java b/ruoyi-common/ruoyi-common-mybatis/src/main/java/org/dromara/common/mybatis/interceptor/PlusDataPermissionInterceptor.java
index 755cda4..587a998 100644
--- a/ruoyi-common/ruoyi-common-mybatis/src/main/java/org/dromara/common/mybatis/interceptor/PlusDataPermissionInterceptor.java
+++ b/ruoyi-common/ruoyi-common-mybatis/src/main/java/org/dromara/common/mybatis/interceptor/PlusDataPermissionInterceptor.java
@@ -1,18 +1,16 @@
package org.dromara.common.mybatis.interceptor;
-import cn.hutool.core.collection.ConcurrentHashSet;
-import cn.hutool.core.util.ArrayUtil;
import com.baomidou.mybatisplus.core.plugins.InterceptorIgnoreHelper;
import com.baomidou.mybatisplus.core.toolkit.PluginUtils;
-import com.baomidou.mybatisplus.extension.parser.JsqlParserSupport;
+import com.baomidou.mybatisplus.extension.plugins.handler.MultiDataPermissionHandler;
+import com.baomidou.mybatisplus.extension.plugins.inner.BaseMultiTableInnerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.InnerInterceptor;
-import org.dromara.common.mybatis.annotation.DataColumn;
-import org.dromara.common.mybatis.handler.PlusDataPermissionHandler;
+import lombok.extern.slf4j.Slf4j;
import net.sf.jsqlparser.expression.Expression;
+import net.sf.jsqlparser.schema.Table;
import net.sf.jsqlparser.statement.delete.Delete;
import net.sf.jsqlparser.statement.select.PlainSelect;
import net.sf.jsqlparser.statement.select.Select;
-import net.sf.jsqlparser.statement.select.SelectBody;
import net.sf.jsqlparser.statement.select.SetOperationList;
import net.sf.jsqlparser.statement.update.Update;
import org.apache.ibatis.executor.Executor;
@@ -22,11 +20,11 @@
import org.apache.ibatis.mapping.SqlCommandType;
import org.apache.ibatis.session.ResultHandler;
import org.apache.ibatis.session.RowBounds;
+import org.dromara.common.mybatis.handler.PlusDataPermissionHandler;
import java.sql.Connection;
import java.sql.SQLException;
import java.util.List;
-import java.util.Set;
/**
* 鏁版嵁鏉冮檺鎷︽埅鍣�
@@ -34,27 +32,37 @@
* @author Lion Li
* @version 3.5.0
*/
-public class PlusDataPermissionInterceptor extends JsqlParserSupport implements InnerInterceptor {
+@Slf4j
+public class PlusDataPermissionInterceptor extends BaseMultiTableInnerInterceptor implements InnerInterceptor {
- private final PlusDataPermissionHandler dataPermissionHandler = new PlusDataPermissionHandler();
+ private final PlusDataPermissionHandler dataPermissionHandler;
+
/**
- * 鏃犳晥娉ㄨВ鏂规硶缂撳瓨鐢ㄤ簬蹇�熻繑鍥�
+ * 鏋勯�犲嚱鏁帮紝鍒濆鍖� PlusDataPermissionHandler 瀹炰緥
*/
- private final Set<String> invalidCacheSet = new ConcurrentHashSet<>();
+ public PlusDataPermissionInterceptor() {
+ this.dataPermissionHandler = new PlusDataPermissionHandler();
+ }
+ /**
+ * 鍦ㄦ墽琛屾煡璇箣鍓嶏紝妫�鏌ュ苟澶勭悊鏁版嵁鏉冮檺鐩稿叧閫昏緫
+ *
+ * @param executor MyBatis 鎵ц鍣ㄥ璞�
+ * @param ms 鏄犲皠璇彞瀵硅薄
+ * @param parameter 鏂规硶鍙傛暟
+ * @param rowBounds 鍒嗛〉瀵硅薄
+ * @param resultHandler 缁撴灉澶勭悊鍣�
+ * @param boundSql 缁戝畾鐨� SQL 瀵硅薄
+ * @throws SQLException 濡傛灉鍙戠敓 SQL 寮傚父
+ */
@Override
public void beforeQuery(Executor executor, MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) throws SQLException {
- // 妫�鏌ュ拷鐣ユ敞瑙�
+ // 妫�鏌ユ槸鍚﹂渶瑕佸拷鐣ユ暟鎹潈闄愬鐞�
if (InterceptorIgnoreHelper.willIgnoreDataPermission(ms.getId())) {
return;
}
- // 妫�鏌ユ槸鍚︽棤鏁� 鏃犳暟鎹潈闄愭敞瑙�
- if (invalidCacheSet.contains(ms.getId())) {
- return;
- }
- DataColumn[] dataColumns = dataPermissionHandler.findAnnotation(ms.getId());
- if (ArrayUtil.isEmpty(dataColumns)) {
- invalidCacheSet.add(ms.getId());
+ // 妫�鏌ユ槸鍚︾己灏戞湁鏁堢殑鏁版嵁鏉冮檺娉ㄨВ
+ if (dataPermissionHandler.invalid()) {
return;
}
// 瑙ｆ瀽 sql 鍒嗛厤瀵瑰簲鏂规硶
@@ -62,17 +70,27 @@
mpBs.sql(parserSingle(mpBs.sql(), ms.getId()));
}
+ /**
+ * 鍦ㄥ噯澶� SQL 璇彞涔嬪墠锛屾鏌ュ苟澶勭悊鏇存柊鍜屽垹闄ゆ搷浣滅殑鏁版嵁鏉冮檺鐩稿叧閫昏緫
+ *
+ * @param sh MyBatis StatementHandler 瀵硅薄
+ * @param connection 鏁版嵁搴撹繛鎺ュ璞�
+ * @param transactionTimeout 浜嬪姟瓒呮椂鏃堕棿
+ */
@Override
public void beforePrepare(StatementHandler sh, Connection connection, Integer transactionTimeout) {
PluginUtils.MPStatementHandler mpSh = PluginUtils.mpStatementHandler(sh);
MappedStatement ms = mpSh.mappedStatement();
+ // 鑾峰彇 SQL 鍛戒护绫诲瀷锛堝銆佸垹銆佹敼銆佹煡锛�
SqlCommandType sct = ms.getSqlCommandType();
+
+ // 鍙鐞嗘洿鏂板拰鍒犻櫎鎿嶄綔鐨� SQL 璇彞
if (sct == SqlCommandType.UPDATE || sct == SqlCommandType.DELETE) {
if (InterceptorIgnoreHelper.willIgnoreDataPermission(ms.getId())) {
return;
}
- // 妫�鏌ユ槸鍚︽棤鏁� 鏃犳暟鎹潈闄愭敞瑙�
- if (invalidCacheSet.contains(ms.getId())) {
+ // 妫�鏌ユ槸鍚︾己灏戞湁鏁堢殑鏁版嵁鏉冮檺娉ㄨВ
+ if (dataPermissionHandler.invalid()) {
return;
}
PluginUtils.MPBoundSql mpBs = mpSh.mPBoundSql();
@@ -80,17 +98,32 @@
}
}
+ /**
+ * 澶勭悊 SELECT 鏌ヨ璇彞涓殑 WHERE 鏉′欢
+ *
+ * @param select SELECT 鏌ヨ瀵硅薄
+ * @param index 鏌ヨ璇彞鐨勭储寮�
+ * @param sql 鏌ヨ璇彞
+ * @param obj WHERE 鏉′欢鍙傛暟
+ */
@Override
protected void processSelect(Select select, int index, String sql, Object obj) {
- SelectBody selectBody = select.getSelectBody();
- if (selectBody instanceof PlainSelect plainSelect) {
- this.setWhere(plainSelect, (String) obj);
- } else if (selectBody instanceof SetOperationList setOperationList) {
- List<SelectBody> selectBodyList = setOperationList.getSelects();
+ if (select instanceof PlainSelect) {
+ this.setWhere((PlainSelect) select, (String) obj);
+ } else if (select instanceof SetOperationList setOperationList) {
+ List<Select> selectBodyList = setOperationList.getSelects();
selectBodyList.forEach(s -> this.setWhere((PlainSelect) s, (String) obj));
}
}
+ /**
+ * 澶勭悊 UPDATE 璇彞涓殑 WHERE 鏉′欢
+ *
+ * @param update UPDATE 鏌ヨ瀵硅薄
+ * @param index 鏌ヨ璇彞鐨勭储寮�
+ * @param sql 鏌ヨ璇彞
+ * @param obj WHERE 鏉′欢鍙傛暟
+ */
@Override
protected void processUpdate(Update update, int index, String sql, Object obj) {
Expression sqlSegment = dataPermissionHandler.getSqlSegment(update.getWhere(), (String) obj, false);
@@ -99,6 +132,14 @@
}
}
+ /**
+ * 澶勭悊 DELETE 璇彞涓殑 WHERE 鏉′欢
+ *
+ * @param delete DELETE 鏌ヨ瀵硅薄
+ * @param index 鏌ヨ璇彞鐨勭储寮�
+ * @param sql 鏌ヨ璇彞
+ * @param obj WHERE 鏉′欢鍙傛暟
+ */
@Override
protected void processDelete(Delete delete, int index, String sql, Object obj) {
Expression sqlSegment = dataPermissionHandler.getSqlSegment(delete.getWhere(), (String) obj, false);
@@ -108,10 +149,10 @@
}
/**
- * 璁剧疆 where 鏉′欢
+ * 璁剧疆 SELECT 璇彞鐨� WHERE 鏉′欢
*
- * @param plainSelect 鏌ヨ瀵硅薄
- * @param mappedStatementId 鎵ц鏂规硶id
+ * @param plainSelect SELECT 鏌ヨ瀵硅薄
+ * @param mappedStatementId 鏄犲皠璇彞鐨� ID
*/
protected void setWhere(PlainSelect plainSelect, String mappedStatementId) {
Expression sqlSegment = dataPermissionHandler.getSqlSegment(plainSelect.getWhere(), mappedStatementId, true);
@@ -120,5 +161,19 @@
}
}
+ /**
+ * 鏋勫缓琛ㄨ揪寮忥紝鐢ㄤ簬澶勭悊琛ㄧ殑鏁版嵁鏉冮檺
+ *
+ * @param table 琛ㄥ璞�
+ * @param where WHERE 鏉′欢琛ㄨ揪寮�
+ * @param whereSegment WHERE 鏉′欢鐗囨
+ * @return 鏋勫缓鐨勮〃杈惧紡
+ */
+ @Override
+ public Expression buildTableExpression(Table table, Expression where, String whereSegment) {
+ // 鍙湁鏂扮増鏁版嵁鏉冮檺澶勭悊鍣ㄦ墠浼氭墽琛屽埌杩欓噷
+ final MultiDataPermissionHandler handler = (MultiDataPermissionHandler) dataPermissionHandler;
+ return handler.getSqlSegment(table, where, whereSegment);
+ }
}
--
Gitblit v1.9.3