Mybatis手写一个分页插件

布满荆棘的人生 2021-11-04 13:26 394阅读 0赞

**给数据库中查询出的数据做分页有两种方式：**

1.  物理分页：以mysql为例，使用limit对查询结果进行限制
2.  逻辑分页：对查询结果进行处理达到分页的目的，但是可能需要查询出多余的数据，降低了性能

**写之前先简单分析一下插件的原理：**  
插件的基本原理是使用Mybatis提供的插件接口，拦截方法中拦截Mybatis四大对象中方法(对这个四个对象不熟悉的可以参考这篇文章[Mybatis执行查询SQL过程分析][Mybatis_SQL])：

*  Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
 *  ParameterHandler (getParameterObject, setParameters)
 *  ResultSetHandler (handleResultSets, handleOutputParameters)
 *  StatementHandler (prepare, parameterize, batch, update, query)

拦截方法后转到Intercept的intercept()方法并在其中织入自定义逻辑，达到想要的目标

直接上代码：

/** * 插件签名，指定拦截方法 */
    @Intercepts({ 
            @Signature(
                    type = Executor.class,
                    method = "query",
                    args = { MappedStatement.class,Object.class, RowBounds.class, ResultHandler.class}
            )
    })
    public class MyPagePlugin implements Interceptor { 
    
        private static final int STATEMENT_INDEX = 0;
        private static final int PARAMETER_INDEX = 1;
        private static final int Row_Bounds_INDEX = 2;
        Logger logger = LoggerFactory.getLogger(getClass());
    
        @Override
        public Object intercept(Invocation invocation) throws Throwable { 
    
            //获取分页信息
            Object[] args = invocation.getArgs();
            RowBounds rb = (RowBounds)args[Row_Bounds_INDEX];
    
            //如果没有分页参数，就放行
            if(rb == RowBounds.DEFAULT){ 
                return invocation.proceed();
            }
    
            //关闭默认分页
            args[Row_Bounds_INDEX] = RowBounds.DEFAULT;
    
            MappedStatement ms = (MappedStatement) args[STATEMENT_INDEX];
            BoundSql boundSql = ms.getBoundSql(args[PARAMETER_INDEX]);
    
            //给sql拼接limit
            String sql = boundSql.getSql();
            if(sql.contains(";")){ 
                sql = sql.replace(";","");
            }
            String limit = String.format("limit %d,%d",rb.getOffset(),rb.getLimit());
            sql = sql + " " + limit ;
    
            //将拼接好的sql传入SqlSource
            SqlSource sqlSource = new StaticSqlSource(ms.getConfiguration(),sql,boundSql.getParameterMappings());
    
            //使用反射获取sqlSource字段并传值
            Field field = MappedStatement.class.getDeclaredField("sqlSource");
            field.setAccessible(true);
            field.set(ms,sqlSource);
    
            logger.info("===分页插件执行===");
            return invocation.proceed();
        }
    
        //使用当前拦截器包装目标对象，并创建目标对象的代理对象
        @Override
        public Object plugin(Object target) { 
            return Plugin.wrap(target,this);
        }
    
        //设置xml中配置的properties属性
        @Override
        public void setProperties(Properties properties) { 
    
        }
    }

插件逻辑很简单，先判断是否需要分页，然后给sql拼接limit语句。最后别忘了在全局配置文件中注册这个插件

传入一个RowBounds对象  
![在这里插入图片描述][20190809233343545.PNG]  
运行结果![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjU0NDg0_size_16_color_FFFFFF_t_70]  
**参考文章：[MyBatis 源码分析 - 插件机制][MyBatis _ -]**

[Mybatis_SQL]: https://blog.csdn.net/qq_42654484/article/details/98667269
[20190809233343545.PNG]: /images/20211104/9116079c610045c1909e5d1f89a347bd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjU0NDg0_size_16_color_FFFFFF_t_70]: /images/20211104/2de0bc8afd5b4a039fc9553fc306697c.png
[MyBatis _ -]: https://cloud.tencent.com/developer/article/1344940