mybaits之自定义分页插件

小灰灰 2022-09-09 10:57 190阅读 0赞

## 写在前面 ##

本文在[这篇文章][Link 1]基础上分析，作为一个实例。  
想要系统学习的，可以参考[这篇文章，重要！！！][Link 2]。

## 1：定义插件类 ##

@Intercepts({ 
            @Signature(type = Executor.class, method = "query", args = {  MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class })
    })
    public class MyPagingPlugin implements Interceptor { 
        private static final Integer MAPPED_STATEMENT_INDEX = 0;
        private static final Integer PARAMETER_INDEX = 1;
        private static final Integer ROW_BOUNDS_INDEX = 2;
    
        @Override
        public Object intercept(Invocation invocation) throws Throwable { 
            Object[] args = invocation.getArgs();
            RowBounds rb = (RowBounds) args[ROW_BOUNDS_INDEX];
            // 不是默认的分页RowBounds对象，才处理，即用户传入了指定分页对象
            if (rb != RowBounds.DEFAULT) { 
                // 恢复参数为默认的分页对象，即不使用内置的分页逻辑，默认从0，查到无限大，其实就是不分页了
                args[ROW_BOUNDS_INDEX] = RowBounds.DEFAULT;
                // 获取当前执行的statement对应的MappedStatement对象
                MappedStatement ms = (MappedStatement) args[MAPPED_STATEMENT_INDEX];
                // 从MappedStatement中获取封装sql的BoundSql对象
                BoundSql boundSql = ms.getBoundSql(args[PARAMETER_INDEX]);
                // 获取sql语句并拼接limit信息，如原来是select * from some_table where id=#{id},
                // 拼接后可能就是select * from some_table where id=#{id} limit 10, 20
                String sql = boundSql.getSql();
                String limit = String.format("LIMIT %d,%d", rb.getOffset(), rb.getLimit());
                sql = sql + " " + limit;
                // 创建StaticSqlSource，该对象是用来封装动态sql语句的对象
                // 创建一个 StaticSqlSource，并将拼接好的 sql 传入
                SqlSource sqlSource = new StaticSqlSource(ms.getConfiguration(), sql, boundSql.getParameterMappings());
                // 通过反射获取并设置 MappedStatement 的 sqlSource 字段，这样后续mybatis在解析动态sql的时候，拿到的就是我们拼接limit后的
                // 对象了，替换了里面的动态参数后，会生成最终的带有limit分页逻辑的sql语句
                Field field = MappedStatement.class.getDeclaredField("sqlSource");
                field.setAccessible(true);
                field.set(ms, sqlSource);
            }
            // 执行目标方法并返回结果
            return invocation.proceed();
        }
    
        @Override
        public Object plugin(Object target) { 
            // 模板代码，生成代理类
            return Plugin.wrap(target, this);
        }
    
        @Override
        public void setProperties(Properties properties) { 
    
        }
    }

代码中添加了详细的注释，有不明白的地方可以参考[这里][Link 2]关于mybaits相关内容分享的文章。

## 2：注册到全局配置文件 ##

## 3：测试 ##

### 3.1：mapper 接口 ###

List<TestResultmapAndParametermap> findByPaging(@Param("id") Integer id, RowBounds rowBounds);

### 3.2：mapper xml ###

<select id="findByPaging" resultMap="myResultMap">
        select * from test_resultmap_and_parametermap where id > #{id}
    </select>

### 3.3：测试代码 ###

@Test
    publicvoid findByPaging() { 
        System.out.println(testResultmapAndParametermapMapper.findByPaging(2, new RowBounds(11, 22)).size());
    }

运行输出如下：

...snip... 
    2021-08-31 17--53---45,559 [dongshidaddy--^^--yudaosourcecode.mybatis.mapper.TestResultmapAndParametermapMapper.findByPaging]-[DEBUG] ==>  Preparing: select * from test_resultmap_and_parametermap where id > ? LIMIT 11,22 
    ...snip...

通过输出的sql语句`select * from test_resultmap_and_parametermap where id > ? LIMIT 11,22`可以看到我们定义的分页插件已经生效了。

[Link 1]: https://blog.csdn.net/wang0907/article/details/120001462
[Link 2]: https://blog.csdn.net/wang0907/article/details/118675622