Mybatis手写一个分页插件

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

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

写之前先简单分析一下插件的原理：
插件的基本原理是使用Mybatis提供的插件接口，拦截方法中拦截Mybatis四大对象中方法(对这个四个对象不熟悉的可以参考这篇文章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语句。最后别忘了在全局配置文件中注册这个插件

<plugins>
        <plugin interceptor="com.tucker.mybatismaven.plugin.MyPagePlugin"></plugin>
</plugins>

传入一个RowBounds对象

运行结果
参考文章：MyBatis 源码分析 - 插件机制