MyBatis攔截器動(dòng)態(tài)替換表名的方法詳解
寫在前面
今天收到一個(gè)需求,根據(jù)請(qǐng)求方的不同,動(dòng)態(tài)的切換表名(涵蓋SELECT,INSERT,UPDATE操作)。幾張新表和舊表的結(jié)構(gòu)完全一致,但是分開維護(hù)??吹叫枨蟮谝环磻?yīng)是將表名提出來當(dāng)${tableName}參數(shù),然后AOP攔截判斷再替換表名。但是后面看了一下這幾張表在很多mapper接口都有使用,其中還有一些復(fù)雜的連接查詢,提取tableName當(dāng)參數(shù)肯定是不現(xiàn)實(shí)的了。后面和組內(nèi)大佬討論之后,發(fā)現(xiàn)可以使用MyBatis提供的攔截器,判斷并且動(dòng)態(tài)的替換表名。
一、Mybatis Interceptor 攔截器接口和注解
簡(jiǎn)單的說就是mybatis在執(zhí)行sql的時(shí)候,攔截目標(biāo)方法并且在前后加上我們的業(yè)務(wù)邏輯。實(shí)際上就是加@Intercepts注解和實(shí)現(xiàn)org.apache.ibatis.plugin.Interceptor接口
@Intercepts(
@Signature(method = "query",
type = Executor.class,
args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}
)
)public interface Interceptor {
//主要重寫這個(gè)方法、實(shí)現(xiàn)我們的業(yè)務(wù)邏輯
Object intercept(Invocation invocation) throws Throwable;
//生成代理對(duì)象,可以在這里判斷是否生成代理對(duì)象
Object plugin(Object target);
//如果我們攔截器需要用到一些變量參數(shù),可以在這里讀取
void setProperties(Properties properties);
}二、實(shí)現(xiàn)思路
- 在intercept方法中有參數(shù)Invocation對(duì)象,里面有3個(gè)成員變量和@Signature對(duì)應(yīng)
| 成員變量 | 變量類型 | 說明 |
|---|---|---|
| target | Object | 代理對(duì)象 |
| method | Method | 被攔截方法 |
| args | Object[] | 被攔截方法執(zhí)行所需的參數(shù) |
- 通過Invocation中的args變量。我們能拿到MappedStatement這個(gè)對(duì)象(args[0]),傳入sql語句的參數(shù)Object(args[1])。而MappedStatement是一個(gè)記錄了sql語句(sqlSource對(duì)象)、參數(shù)值結(jié)構(gòu)、返回值結(jié)構(gòu)、mapper配置等的一個(gè)對(duì)象。
- sqlSource對(duì)象和傳入sql語句的參數(shù)對(duì)象Object就能獲得BoundSql。BoundSql的toString方法就能獲取到有占位符的sql語句了,我們的業(yè)務(wù)邏輯就能在這里介入。
- 獲取到sql語句,根據(jù)規(guī)則替換表名,塞回BoundSql對(duì)象中、再把BoundSql對(duì)象塞回MappedStatement對(duì)象中。最后再賦值給args[0](實(shí)際被攔截方法所需的參數(shù))就搞定了
三、代碼實(shí)現(xiàn)
import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.mapping.SqlSource;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.session.ResultHandler;
import org.apache.ibatis.session.RowBounds;
import java.util.*;
/**
* @description: 動(dòng)態(tài)替換表名攔截器
* @author: hinotoyk
* @created: 2022/04/19
*/
//method = "query"攔截select方法、而method = "update"則能攔截insert、update、delete的方法
@Intercepts({
@Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}),
@Signature(type = Executor.class, method = "update", args = {MappedStatement.class, Object.class})
})
public class ReplaceTableInterceptor implements Interceptor {
private final static Map<String,String> TABLE_MAP = new LinkedHashMap<>();
static {
//表名長(zhǎng)的放前面,避免字符串匹配的時(shí)候先匹配替換子集
TABLE_MAP.put("t_game_partners","t_game_partners_test");//測(cè)試
TABLE_MAP.put("t_file_recycle","t_file_recycle_other");
TABLE_MAP.put("t_folder","t_folder_other");
TABLE_MAP.put("t_file","t_file_other");
}
@Override
public Object intercept(Invocation invocation) throws Throwable {
Object[] args = invocation.getArgs();
//獲取MappedStatement對(duì)象
MappedStatement ms = (MappedStatement) args[0];
//獲取傳入sql語句的參數(shù)對(duì)象
Object parameterObject = args[1];
BoundSql boundSql = ms.getBoundSql(parameterObject);
//獲取到擁有占位符的sql語句
String sql = boundSql.getSql();
System.out.println("攔截前sql :" + sql);
//判斷是否需要替換表名
if(isReplaceTableName(sql)){
for(Map.Entry<String, String> entry : TABLE_MAP.entrySet()){
sql = sql.replace(entry.getKey(),entry.getValue());
}
System.out.println("攔截后sql :" + sql);
//重新生成一個(gè)BoundSql對(duì)象
BoundSql bs = new BoundSql(ms.getConfiguration(),sql,boundSql.getParameterMappings(),parameterObject);
//重新生成一個(gè)MappedStatement對(duì)象
MappedStatement newMs = copyMappedStatement(ms, new BoundSqlSqlSource(bs));
//賦回給實(shí)際執(zhí)行方法所需的參數(shù)中
args[0] = newMs;
}
return invocation.proceed();
}
@Override
public Object plugin(Object target) {
return Plugin.wrap(target, this);
}
@Override
public void setProperties(Properties properties) {
}
/***
* 判斷是否需要替換表名
* @param sql
* @return
*/
private boolean isReplaceTableName(String sql){
for(String tableName : TABLE_MAP.keySet()){
if(sql.contains(tableName)){
return true;
}
}
return false;
}
/***
* 復(fù)制一個(gè)新的MappedStatement
* @param ms
* @param newSqlSource
* @return
*/
private MappedStatement copyMappedStatement (MappedStatement ms, SqlSource newSqlSource) {
MappedStatement.Builder builder = new MappedStatement.Builder(ms.getConfiguration(), ms.getId(), newSqlSource, ms.getSqlCommandType());
builder.resource(ms.getResource());
builder.fetchSize(ms.getFetchSize());
builder.statementType(ms.getStatementType());
builder.keyGenerator(ms.getKeyGenerator());
if (ms.getKeyProperties() != null && ms.getKeyProperties().length > 0) {
builder.keyProperty(String.join(",",ms.getKeyProperties()));
}
builder.timeout(ms.getTimeout());
builder.parameterMap(ms.getParameterMap());
builder.resultMaps(ms.getResultMaps());
builder.resultSetType(ms.getResultSetType());
builder.cache(ms.getCache());
builder.flushCacheRequired(ms.isFlushCacheRequired());
builder.useCache(ms.isUseCache());
return builder.build();
}
/***
* MappedStatement構(gòu)造器接受的是SqlSource
* 實(shí)現(xiàn)SqlSource接口,將BoundSql封裝進(jìn)去
*/
public static class BoundSqlSqlSource implements SqlSource {
private BoundSql boundSql;
public BoundSqlSqlSource(BoundSql boundSql) {
this.boundSql = boundSql;
}
@Override
public BoundSql getBoundSql(Object parameterObject) {
return boundSql;
}
}
}四、運(yùn)行結(jié)果

寫在最后
一開始接到這個(gè)需求的時(shí)候,會(huì)習(xí)慣性的從熟悉常用的技術(shù)入手。如果涉及的表引用沒這么多,是不是就會(huì)直接用AOP攔截判斷替換了呢,我大概率是會(huì)的。可能就不會(huì)想到上面的攔截器動(dòng)態(tài)替換的方法(相當(dāng)于失去一次學(xué)習(xí)的機(jī)會(huì)),還是要跳出慣性多思考還有沒有更合適的做法,把每次需求都當(dāng)成一次學(xué)習(xí)的機(jī)會(huì),舒適圈都能變開闊很多,共勉。
參考資料
到此這篇關(guān)于MyBatis攔截器動(dòng)態(tài)替換表名的文章就介紹到這了,更多相關(guān)MyBatis動(dòng)態(tài)替換表名內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
java批量下載將多個(gè)文件(minio中存儲(chǔ))壓縮成一個(gè)zip包代碼示例
在Java應(yīng)用程序中有時(shí)我們需要從多個(gè)URL地址下載文件,并將這些文件打包成一個(gè)Zip文件進(jìn)行批量處理或傳輸,這篇文章主要給大家介紹了關(guān)于java批量下載將多個(gè)文件(minio中存儲(chǔ))壓縮成一個(gè)zip包的相關(guān)資料,需要的朋友可以參考下2023-11-11
如何解決idea安裝插件后報(bào)錯(cuò)打不開問題
這篇文章主要介紹了如何解決idea安裝插件后報(bào)錯(cuò)打不開問題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-06-06
Springboot Redis設(shè)置key前綴的方法步驟
這篇文章主要介紹了Springboot Redis設(shè)置key前綴的方法步驟,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2021-04-04
java之TreeUtils生成一切對(duì)象樹形結(jié)構(gòu)案例
這篇文章主要介紹了java之TreeUtils生成一切對(duì)象樹形結(jié)構(gòu)案例,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2020-09-09
Java?Mybatis查詢數(shù)據(jù)庫(kù)舉例詳解
這篇文章主要給大家介紹了關(guān)于Java?Mybatis查詢數(shù)據(jù)庫(kù)的相關(guān)資料,在MyBatis中可以使用遞歸查詢實(shí)現(xiàn)對(duì)數(shù)據(jù)庫(kù)中樹形結(jié)構(gòu)數(shù)據(jù)的查詢,文中通過代碼介紹的非常詳細(xì),需要的朋友可以參考下2023-10-10
23種設(shè)計(jì)模式(22)java狀態(tài)模式
這篇文章主要為大家詳細(xì)介紹了23種設(shè)計(jì)模式之java狀態(tài)模式,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2018-01-01
IntelliJ IDEA 2021.1 首個(gè) Beta 版本發(fā)布
這篇文章主要介紹了IntelliJ IDEA 2021.1 首個(gè) Beta 版本發(fā)布,本文通過圖文并茂的形式給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2021-03-03

