From 3dff5299206a365ab4b61e9050aeb6b52a733433 Mon Sep 17 00:00:00 2001
From: AprilWind <2100166581@qq.com>
Date: 星期四, 27 六月 2024 17:46:17 +0800
Subject: [PATCH] !556 新增mybatis注释
---
ruoyi-common/ruoyi-common-mybatis/src/main/java/org/dromara/common/mybatis/interceptor/PlusDataPermissionInterceptor.java | 70 ++++++++++++++++++++++++++++++++---
1 files changed, 64 insertions(+), 6 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 6eed8f7..85a4d0a 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
@@ -37,17 +37,33 @@
private final PlusDataPermissionHandler dataPermissionHandler;
+ /**
+ * 鏋勯�犲嚱鏁帮紝鍒濆鍖� PlusDataPermissionHandler 瀹炰緥
+ *
+ * @param mapperPackage 鎵弿鐨勬槧灏勫櫒鍖�
+ */
public PlusDataPermissionInterceptor(String mapperPackage) {
this.dataPermissionHandler = new PlusDataPermissionHandler(mapperPackage);
}
+ /**
+ * 鍦ㄦ墽琛屾煡璇箣鍓嶏紝妫�鏌ュ苟澶勭悊鏁版嵁鏉冮檺鐩稿叧閫昏緫
+ *
+ * @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 (dataPermissionHandler.invalid(ms.getId())) {
return;
}
@@ -56,16 +72,26 @@
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 (dataPermissionHandler.invalid(ms.getId())) {
return;
}
@@ -74,6 +100,14 @@
}
}
+ /**
+ * 澶勭悊 SELECT 鏌ヨ璇彞涓殑 WHERE 鏉′欢
+ *
+ * @param select SELECT 鏌ヨ瀵硅薄
+ * @param index 鏌ヨ璇彞鐨勭储寮�
+ * @param sql 鏌ヨ璇彞
+ * @param obj WHERE 鏉′欢鍙傛暟
+ */
@Override
protected void processSelect(Select select, int index, String sql, Object obj) {
if (select instanceof PlainSelect) {
@@ -84,6 +118,14 @@
}
}
+ /**
+ * 澶勭悊 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);
@@ -92,6 +134,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);
@@ -101,10 +151,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);
@@ -113,6 +163,14 @@
}
}
+ /**
+ * 鏋勫缓琛ㄨ揪寮忥紝鐢ㄤ簬澶勭悊琛ㄧ殑鏁版嵁鏉冮檺
+ *
+ * @param table 琛ㄥ璞�
+ * @param where WHERE 鏉′欢琛ㄨ揪寮�
+ * @param whereSegment WHERE 鏉′欢鐗囨
+ * @return 鏋勫缓鐨勮〃杈惧紡
+ */
@Override
public Expression buildTableExpression(Table table, Expression where, String whereSegment) {
// 鍙湁鏂扮増鏁版嵁鏉冮檺澶勭悊鍣ㄦ墠浼氭墽琛屽埌杩欓噷
--
Gitblit v1.9.3