Springboot自定義mybatis攔截器實(shí)現(xiàn)擴(kuò)展

更新時(shí)間：2021年12月31日 16:37:51 作者：小目標(biāo)青年

本文主要介紹了Springboot自定義mybatis攔截器實(shí)現(xiàn)擴(kuò)展，文中通過(guò)示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下

前言

相信大家對(duì)攔截器并不陌生，對(duì)mybatis也不陌生。

有用過(guò)pagehelper的，那么對(duì)mybatis攔截器也不陌生了，按照使用的規(guī)則觸發(fā)sql攔截，幫我們自動(dòng)添加分頁(yè)參數(shù) 。

那么今天，我們的實(shí)踐自定義mybatis攔截器也是如此，本篇文章實(shí)踐的效果：

針對(duì)一些使用單個(gè)實(shí)體類去接收返回結(jié)果的 mapper方法，我們攔截檢測(cè)，如果沒寫 LIMIT 1 ，我們將自動(dòng)幫忙填充，達(dá)到查找單條數(shù)據(jù) 效率優(yōu)化的效果。

ps：當(dāng)然，跟著該篇學(xué)會(huì)了這個(gè)之后，那么可以擴(kuò)展的東西就多了，大家按照自己的想法或是項(xiàng)目需求都可以自己發(fā)揮。我該篇的實(shí)踐僅僅作為拋磚引玉吧。

正文

實(shí)踐的準(zhǔn)備：

整合mybatis ，然后故意寫了3個(gè)查詢方法， 1個(gè)是list 列表數(shù)據(jù)，2個(gè)是單條數(shù)據(jù) 。

我們通過(guò)自己寫一個(gè)MybatisInterceptor實(shí)現(xiàn) mybatis框架的 Interceptor來(lái)做文章：

MybatisInterceptor.java :

import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.*;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.session.ResultHandler;
import org.apache.ibatis.session.RowBounds;
import org.springframework.stereotype.Component;
 
import java.lang.reflect.Method;
import java.util.*;
 
 
 
/**
 * @Author JCccc
 * @Description
 * @Date 2021/12/14 16:56
 */
@Component
@Intercepts({
        @Signature(type = Executor.class, method = "update", args = {MappedStatement.class, Object.class}),
        @Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class})
})
public class MybatisInterceptor implements Interceptor {
 
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        //獲取執(zhí)行參數(shù)
        Object[] objects = invocation.getArgs();
        MappedStatement ms = (MappedStatement) objects[0];
        //解析執(zhí)行sql的map方法,開始自定義規(guī)則匹配邏輯
        String mapperMethodAllName = ms.getId();
        int lastIndex = mapperMethodAllName.lastIndexOf(".");
        String mapperClassStr = mapperMethodAllName.substring(0, lastIndex);
        String mapperClassMethodStr = mapperMethodAllName.substring((lastIndex + 1));
        Class<?> mapperClass = Class.forName(mapperClassStr);
        Method[] methods = mapperClass.getMethods();
        Class<?> returnType;
        for (Method method : methods) {
            if (method.getName().equals(mapperClassMethodStr)) {
                returnType = method.getReturnType();
                if (returnType.isAssignableFrom(List.class)) {
                    System.out.println("返回類型是 List");
                    System.out.println("針對(duì)List 做一些操作");
                } else if (returnType.isAssignableFrom(Set.class)) {
                    System.out.println("返回類型是 Set");
                    System.out.println("針對(duì)Set 做一些操作");
                } else{
                    BoundSql boundSql = ms.getSqlSource().getBoundSql(objects[1]);
                    String oldSql = boundSql.getSql().toLowerCase(Locale.CHINA).replace("[\\t\\n\\r]", " ");
                    if (!oldSql.contains("LIMIT")){
                        String newSql = boundSql.getSql().toLowerCase(Locale.CHINA).replace("[\\t\\n\\r]", " ") + " LIMIT 1";
                        BoundSql newBoundSql = new BoundSql(ms.getConfiguration(), newSql,
                                boundSql.getParameterMappings(), boundSql.getParameterObject());
                        MappedStatement newMs = newMappedStatement(ms, new MyBoundSqlSqlSource(newBoundSql));
                        for (ParameterMapping mapping : boundSql.getParameterMappings()) {
                            String prop = mapping.getProperty();
                            if (boundSql.hasAdditionalParameter(prop)) {
                                newBoundSql.setAdditionalParameter(prop, boundSql.getAdditionalParameter(prop));
                            }
                        }
                        Object[] queryArgs = invocation.getArgs();
                        queryArgs[0] = newMs;
                        System.out.println("打印新SQL語(yǔ)句" + newSql);
                    }
 
                }
            }
        }
        //繼續(xù)執(zhí)行邏輯
        return invocation.proceed();
    }
 
 
    @Override
    public Object plugin(Object o) {
        //獲取代理權(quán)
        if (o instanceof Executor) {
            //如果是Executor（執(zhí)行增刪改查操作），則攔截下來(lái)
            return Plugin.wrap(o, this);
        } else {
            return o;
        }
    }
 
    /**
     * 定義一個(gè)內(nèi)部輔助類，作用是包裝 SQL
     */
    class MyBoundSqlSqlSource implements SqlSource {
        private BoundSql boundSql;
 
        public MyBoundSqlSqlSource(BoundSql boundSql) {
            this.boundSql = boundSql;
        }
 
        @Override
        public BoundSql getBoundSql(Object parameterObject) {
            return boundSql;
        }
 
    }
 
    private MappedStatement newMappedStatement(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(ms.getKeyProperties()[0]);
        }
        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();
    }
 
 
    @Override
    public void setProperties(Properties properties) {
        //讀取mybatis配置文件中屬性
    }
 
 
}

簡(jiǎn)單代碼端解析：

① 拿出執(zhí)行參數(shù)，里面有很多東西給我們用的，我本篇主要是用MappedStatement。大家可以發(fā)揮自己的想法。打debug可以自己看看里面的東西。

//獲取執(zhí)行參數(shù)
Object[] objects = invocation.getArgs();
MappedStatement ms = (MappedStatement) objects[0];

② 這里我主要是使用了從MappedStatement里面拿出來(lái)的id，做切割分別切出來(lái) 目前執(zhí)行的sql的mapper是哪個(gè)，然后方法是哪個(gè)。

String mapperMethodAllName = ms.getId();
int lastIndex = mapperMethodAllName.lastIndexOf(".");
String mapperClassStr = mapperMethodAllName.substring(0, lastIndex);
String mapperClassMethodStr = mapperMethodAllName.substring((lastIndex + 1));

③ 這就是我自己隨便寫的一下，我直接根據(jù)切割出來(lái)的mapper類找出里面的方法，主要是為了拿出每個(gè)方法的返回類型，因?yàn)?我這篇實(shí)踐內(nèi)容就是，判斷出單個(gè)pojo接受的mapper方法，加個(gè)LIMIT 1 ，其他的 LIST 、SET 、 Page 等等這些，我暫時(shí)不做擴(kuò)展。

Class<?> mapperClass = Class.forName(mapperClassStr);
Method[] methods = mapperClass.getMethods();
Class<?> returnType;

④這一段代碼就是該篇的拓展邏輯了，從MappedStatement里面拿出 SqlSource，然后再拿出BoundSql，然后一頓操作給加上 LIMIT 1 ，然后new 一個(gè)新的 MappedStatement，一頓操作塞回去invocation 里面

BoundSql boundSql = ms.getSqlSource().getBoundSql(objects[1]);
String oldSql = boundSql.getSql().toLowerCase(Locale.CHINA).replace("[\\t\\n\\r]", " ");
if (!oldSql.contains("LIMIT")){
    String newSql = boundSql.getSql().toLowerCase(Locale.CHINA).replace("[\\t\\n\\r]", " ") + " LIMIT 1";
    BoundSql newBoundSql = new BoundSql(ms.getConfiguration(), newSql,
            boundSql.getParameterMappings(), boundSql.getParameterObject());
    MappedStatement newMs = newMappedStatement(ms, new MyBoundSqlSqlSource(newBoundSql));
    for (ParameterMapping mapping : boundSql.getParameterMappings()) {
        String prop = mapping.getProperty();
        if (boundSql.hasAdditionalParameter(prop)) {
            newBoundSql.setAdditionalParameter(prop, boundSql.getAdditionalParameter(prop));
        }
    }
    Object[] queryArgs = invocation.getArgs();
    queryArgs[0] = newMs;
    System.out.println("打印新SQL語(yǔ)句：" + newSql);
}

OK，最后簡(jiǎn)單來(lái)試試效果：

最后再重申一下，本篇文章內(nèi)容只是一個(gè)拋磚引玉，隨便想的一些實(shí)踐效果，大家可以按照自己的想法發(fā)揮。

最后再補(bǔ)充一個(gè) 解決 mybatis自定義攔截器和 pagehelper 攔截器沖突導(dǎo)致失效的問(wèn)題出現(xiàn)的

解決方案：

加上一個(gè)攔截器配置類

MyDataSourceInterceptorConfig.java ：

import org.apache.ibatis.session.SqlSessionFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationListener;
import org.springframework.context.event.ContextRefreshedEvent;
import org.springframework.stereotype.Component;
 
import java.util.List;
 
/**
 * @Author JCccc
 * @Description
 * @Date 2021/12/14 16:56
 */
@Component
public class MyDataSourceInterceptorConfig implements ApplicationListener<ContextRefreshedEvent> {
 
    @Autowired
    private MybatisInterceptor mybatisInterceptor;
 
    @Autowired
    private List<SqlSessionFactory> sqlSessionFactories;
 
    @Override
    public void onApplicationEvent(ContextRefreshedEvent contextRefreshedEvent) {
        for (SqlSessionFactory factory : sqlSessionFactories) {
            factory.getConfiguration().addInterceptor(mybatisInterceptor);
        }
    }
}

最后最后再補(bǔ)充多一些，

文中針對(duì)攔截的是Executor 這種接口的插件，

其實(shí) 還可以使用ParameterHandler、ResultSetHandler、StatementHandler。

每當(dāng)執(zhí)行這四種接口對(duì)象的方法時(shí)，就會(huì)進(jìn)入攔截方法，然后我們可以根據(jù)不同的插件去拿不同的參數(shù)。

類似：

@Signature(method = "prepare", type = StatementHandler.class, args = {Connection.class,Integer.class})

然后可以做個(gè)轉(zhuǎn)換，也是可以取出相關(guān)的 BoundSql 等等：

if (!(invocation.getTarget() instanceof RoutingStatementHandler)){
                return invocation.proceed();
            }
            RoutingStatementHandler statementHandler = (RoutingStatementHandler) invocation.getTarget();
            BoundSql boundSql = statementHandler.getBoundSql();
            String sql = boundSql.getSql().toUpperCase();

ParameterHandler、ResultSetHandler、StatementHandler、Executor ，不同的插件攔截，有不同的使用場(chǎng)景，想深入的看客們，可以深一下。

到此這篇關(guān)于Springboot自定義mybatis攔截器實(shí)現(xiàn)擴(kuò)展的文章就介紹到這了,更多相關(guān)Springboot mybatis攔截器內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: