经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置：技术经验 » 数据库/运维 » MyBatis » 查看文章
Springboot自定义mybatis拦截器实现扩展
来源：jb51　　时间：2021/12/31 17:27:03　　对本文有异议

前言

相信大家对拦截器并不陌生，对mybatis也不陌生。

有用过pagehelper的，那么对mybatis拦截器也不陌生了，按照使用的规则触发sql拦截，帮我们自动添加分页参数 。

那么今天，我们的实践 自定义mybatis拦截器也是如此， 本篇文章实践的效果：

针对一些使用 单个实体类去接收返回结果的 mapper方法，我们拦截检测，如果没写 LIMIT 1 ，我们将自动帮忙填充，达到查找单条数据 效率优化的效果。

ps： 当然，跟着该篇学会了这个之后，那么可以扩展的东西就多了，大家按照自己的想法或是项目需求都可以自己发挥。 我该篇的实践仅仅作为抛砖引玉吧。

正文

实践的准备 ：

整合mybatis ，然后故意写了3个查询方法， 1个是list 列表数据，2个是 单条数据 。

我们通过自己写一个MybatisInterceptor实现 mybatis框架的 Interceptor来做文章：

MybatisInterceptor.java :

  1. import org.apache.ibatis.executor.Executor;
  2. import org.apache.ibatis.mapping.*;
  3. import org.apache.ibatis.plugin.*;
  4. import org.apache.ibatis.session.ResultHandler;
  5. import org.apache.ibatis.session.RowBounds;
  6. import org.springframework.stereotype.Component;
  7.  
  8. import java.lang.reflect.Method;
  9. import java.util.*;
  10.  
  11.  
  12.  
  13. /**
  14.  * @Author JCccc
  15.  * @Description
  16.  * @Date 2021/12/14 16:56
  17.  */
  18. @Component
  19. @Intercepts({
  20.         @Signature(type = Executor.class, method = "update", args = {MappedStatement.class, Object.class}),
  21.         @Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class})
  22. })
  23. public class MybatisInterceptor implements Interceptor {
  24.  
  25.     @Override
  26.     public Object intercept(Invocation invocation) throws Throwable {
  27.         //获取执行参数
  28.         Object[] objects = invocation.getArgs();
  29.         MappedStatement ms = (MappedStatement) objects[0];
  30.         //解析执行sql的map方法,开始自定义规则匹配逻辑
  31.         String mapperMethodAllName = ms.getId();
  32.         int lastIndex = mapperMethodAllName.lastIndexOf(".");
  33.         String mapperClassStr = mapperMethodAllName.substring(0, lastIndex);
  34.         String mapperClassMethodStr = mapperMethodAllName.substring((lastIndex + 1));
  35.         Class<?> mapperClass = Class.forName(mapperClassStr);
  36.         Method[] methods = mapperClass.getMethods();
  37.         Class<?> returnType;
  38.         for (Method method : methods) {
  39.             if (method.getName().equals(mapperClassMethodStr)) {
  40.                 returnType = method.getReturnType();
  41.                 if (returnType.isAssignableFrom(List.class)) {
  42.                     System.out.println("返回类型是 List");
  43.                     System.out.println("针对List 做一些操作");
  44.                 } else if (returnType.isAssignableFrom(Set.class)) {
  45.                     System.out.println("返回类型是 Set");
  46.                     System.out.println("针对Set 做一些操作");
  47.                 } else{
  48.                     BoundSql boundSql = ms.getSqlSource().getBoundSql(objects[1]);
  49.                     String oldSql = boundSql.getSql().toLowerCase(Locale.CHINA).replace("[\\t\\n\\r]", " ");
  50.                     if (!oldSql.contains("LIMIT")){
  51.                         String newSql = boundSql.getSql().toLowerCase(Locale.CHINA).replace("[\\t\\n\\r]", " ") + " LIMIT 1";
  52.                         BoundSql newBoundSql = new BoundSql(ms.getConfiguration(), newSql,
  53.                                 boundSql.getParameterMappings(), boundSql.getParameterObject());
  54.                         MappedStatement newMs = newMappedStatement(ms, new MyBoundSqlSqlSource(newBoundSql));
  55.                         for (ParameterMapping mapping : boundSql.getParameterMappings()) {
  56.                             String prop = mapping.getProperty();
  57.                             if (boundSql.hasAdditionalParameter(prop)) {
  58.                                 newBoundSql.setAdditionalParameter(prop, boundSql.getAdditionalParameter(prop));
  59.                             }
  60.                         }
  61.                         Object[] queryArgs = invocation.getArgs();
  62.                         queryArgs[0] = newMs;
  63.                         System.out.println("打印新SQL语句" + newSql);
  64.                     }
  65.  
  66.                 }
  67.             }
  68.         }
  69.         //继续执行逻辑
  70.         return invocation.proceed();
  71.     }
  72.  
  73.  
  74.     @Override
  75.     public Object plugin(Object o) {
  76.         //获取代理权
  77.         if (o instanceof Executor) {
  78.             //如果是Executor（执行增删改查操作），则拦截下来
  79.             return Plugin.wrap(o, this);
  80.         } else {
  81.             return o;
  82.         }
  83.     }
  84.  
  85.     /**
  86.      * 定义一个内部辅助类，作用是包装 SQL
  87.      */
  88.     class MyBoundSqlSqlSource implements SqlSource {
  89.         private BoundSql boundSql;
  90.  
  91.         public MyBoundSqlSqlSource(BoundSql boundSql) {
  92.             this.boundSql = boundSql;
  93.         }
  94.  
  95.         @Override
  96.         public BoundSql getBoundSql(Object parameterObject) {
  97.             return boundSql;
  98.         }
  99.  
  100.     }
  101.  
  102.     private MappedStatement newMappedStatement(MappedStatement ms, SqlSource newSqlSource) {
  103.         MappedStatement.Builder builder = new
  104.                 MappedStatement.Builder(ms.getConfiguration(), ms.getId(), newSqlSource, ms.getSqlCommandType());
  105.         builder.resource(ms.getResource());
  106.         builder.fetchSize(ms.getFetchSize());
  107.         builder.statementType(ms.getStatementType());
  108.         builder.keyGenerator(ms.getKeyGenerator());
  109.         if (ms.getKeyProperties() != null && ms.getKeyProperties().length > 0) {
  110.             builder.keyProperty(ms.getKeyProperties()[0]);
  111.         }
  112.         builder.timeout(ms.getTimeout());
  113.         builder.parameterMap(ms.getParameterMap());
  114.         builder.resultMaps(ms.getResultMaps());
  115.         builder.resultSetType(ms.getResultSetType());
  116.         builder.cache(ms.getCache());
  117.         builder.flushCacheRequired(ms.isFlushCacheRequired());
  118.         builder.useCache(ms.isUseCache());
  119.         return builder.build();
  120.     }
  121.  
  122.  
  123.     @Override
  124.     public void setProperties(Properties properties) {
  125.         //读取mybatis配置文件中属性
  126.     }
  127.  
  128.  
  129. }

简单代码端解析：

① 拿出执行参数，里面有很多东西给我们用的，我本篇主要是用MappedStatement。大家可以发挥自己的想法。 打debug可以自己看看里面的东西。

  1. //获取执行参数
  2. Object[] objects = invocation.getArgs();
  3. MappedStatement ms = (MappedStatement) objects[0];

 

 ② 这里我主要是使用了从MappedStatement里面拿出来的id，做切割分别切出来 目前执行的sql的mapper是哪个，然后方法是哪个。

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

③ 这就是我自己随便写的一下，我直接根据切割出来的mapper类找出里面的方法，主要是为了拿出每个方法的返回类型，因为 我这篇实践内容就是，判断出单个pojo接受的mapper方法，加个LIMIT 1 ， 其他的 LIST 、SET 、 Page 等等这些，我暂时不做扩展。

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

 ④这一段代码就是该篇的拓展逻辑了，从MappedStatement里面拿出 SqlSource，然后再拿出BoundSql，然后一顿操作 给加上 LIMIT 1  ， 然后new 一个新的 MappedStatement，一顿操作塞回去invocation 里面

  1. BoundSql boundSql = ms.getSqlSource().getBoundSql(objects[1]);
  2. String oldSql = boundSql.getSql().toLowerCase(Locale.CHINA).replace("[\\t\\n\\r]", " ");
  3. if (!oldSql.contains("LIMIT")){
  4.     String newSql = boundSql.getSql().toLowerCase(Locale.CHINA).replace("[\\t\\n\\r]", " ") + " LIMIT 1";
  5.     BoundSql newBoundSql = new BoundSql(ms.getConfiguration(), newSql,
  6.             boundSql.getParameterMappings(), boundSql.getParameterObject());
  7.     MappedStatement newMs = newMappedStatement(ms, new MyBoundSqlSqlSource(newBoundSql));
  8.     for (ParameterMapping mapping : boundSql.getParameterMappings()) {
  9.         String prop = mapping.getProperty();
  10.         if (boundSql.hasAdditionalParameter(prop)) {
  11.             newBoundSql.setAdditionalParameter(prop, boundSql.getAdditionalParameter(prop));
  12.         }
  13.     }
  14.     Object[] queryArgs = invocation.getArgs();
  15.     queryArgs[0] = newMs;
  16.     System.out.println("打印新SQL语句：" + newSql);
  17. }

OK，最后简单来试试效果 ：
 

 

最后再重申一下，本篇文章内容只是一个抛砖引玉，随便想的一些实践效果，大家可以按照自己的想法发挥。

最后再补充一个 解决 mybatis自定义拦截器和 pagehelper 拦截器 冲突导致失效的问题出现的

解决方案：

加上一个拦截器配置类 

MyDataSourceInterceptorConfig.java ：

  1. import org.apache.ibatis.session.SqlSessionFactory;
  2. import org.springframework.beans.factory.annotation.Autowired;
  3. import org.springframework.context.ApplicationListener;
  4. import org.springframework.context.event.ContextRefreshedEvent;
  5. import org.springframework.stereotype.Component;
  6.  
  7. import java.util.List;
  8.  
  9. /**
  10.  * @Author JCccc
  11.  * @Description
  12.  * @Date 2021/12/14 16:56
  13.  */
  14. @Component
  15. public class MyDataSourceInterceptorConfig implements ApplicationListener<ContextRefreshedEvent> {
  16.  
  17.     @Autowired
  18.     private MybatisInterceptor mybatisInterceptor;
  19.  
  20.     @Autowired
  21.     private List<SqlSessionFactory> sqlSessionFactories;
  22.  
  23.     @Override
  24.     public void onApplicationEvent(ContextRefreshedEvent contextRefreshedEvent) {
  25.         for (SqlSessionFactory factory : sqlSessionFactories) {
  26.             factory.getConfiguration().addInterceptor(mybatisInterceptor);
  27.         }
  28.     }
  29. }

最后最后再补充多一些，

文中 针对拦截的是Executor 这种接口的插件，

其实 还可以使用ParameterHandler、ResultSetHandler、StatementHandler。

每当执行这四种接口对象的方法时，就会进入拦截方法，然后我们可以根据不同的插件去拿不同的参数。

类似：

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

然后可以做个转换，也是可以取出相关的 BoundSql 等等 ：

  1. if (!(invocation.getTarget() instanceof RoutingStatementHandler)){
  2.                 return invocation.proceed();
  3.             }
  4.             RoutingStatementHandler statementHandler = (RoutingStatementHandler) invocation.getTarget();
  5.             BoundSql boundSql = statementHandler.getBoundSql();
  6.             String sql = boundSql.getSql().toUpperCase();

ParameterHandler、ResultSetHandler、StatementHandler、Executor ，不同的插件拦截，有不同的使用场景，想深入的看客们，可以深一下。

到此这篇关于Springboot自定义mybatis拦截器实现扩展的文章就介绍到这了,更多相关Springboot mybatis拦截器内容请搜索w3xue以前的文章或继续浏览下面的相关文章希望大家以后多多支持w3xue！

 友情链接：直通硅谷 　点职佳 　北美留学生论坛

MyBatis热门文章

  • Mybatis使用连表查询的操作代码
  • Mybatis-plus如何查询表中指定字段(不查询全部字段)
  • mybatis/mybatis-plus模糊查询语句特殊字符转义拦截器的实现
  • MyBatis注解开发-@Insert和@InsertProvider的使用
  • springboot+mybatis报错找不到实体类的问题
  • mybatis 忽略实体对象的某个属性(2种方式)
  • mybatis update set 多个字段实例
  • 如何通过一个注解实现MyBatis字段加解密
  • oracle+mybatis-plus+springboot实现分页查询的实例
  • MybatisPlus中的insert操作详解

    • MyBatis推荐文章

  • Mybatis-Plus最优化持久层开发
  • MyBatis 的在使用上的注意事项及其辨析 - Rainbow-Sea
  • 在 Wed 中应用 MyBatis（同时使用MVC架构模式，以及ThreadLocal 事务控制） - Rainbow-Sea
  • MyBatis源码之前言—JDBC编码存在的问题和Mybatis的介绍
  • mybatis plugin源码解析
  • Spring Boot + MyBatis-Plus 实现 MySQL 主从复制动态数据源切换
  • 一种轻量分表方案-MyBatis拦截器分表实践
  • 使用Mybatis自定义插件实现不侵入业务的公共参数自动追加
  • MyBatis-Plus雪花算法实现源码解析
  • Mybatis和其他主流框架的整合使用

    • 本站QQ群：前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

    W3xue 的所有内容仅供测试，对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
    关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接（目前9元/月）请联系QQ：27243702 沸活量
    皖ICP备17017327号-2　皖公网安备34020702000426号