MyBatis 是一种持久层框架,支持通过配置文件和注解将 SQL 映射为 Java 对象。在实际开发中,查询数据时经常需要进行分页处理。 MyBatis 也提供了支持分页的方案,其主要思路是使用 Limit 偏移量和限制个数,来获取指定数量的数据。下面将会介绍 MyBatis 如何进行分页。
MyBatis 提供两种分页方式:基于参数改造和基于插件拦截 。下面我们将分别介绍这两种方式:
1、基于参数改造:
第一种分页方式是基于参数改造的,通过添加参数 limit 和 offset 就可以实现查询从某个位置开始的若干条记录,代码实现如下:
代码语言:javascript复制<select id="selectSomeData"
parameterType="map" resultType="com.example.SomeData">
SELECT * FROM sometable
ORDER BY somecolumn
LIMIT #{limit} OFFSET #{offset}
</select>
这段 SQL 语句会返回从偏移量为 offset 的位置开始的 limit 条结果。例如:LIMIT 30,10 表示从第 31 行开始返回 10 行结果。
在实际应用中,我们可以将 limit 和 offset 抽取成两个参数,并传入到 MyBatis 中。
2、基于插件拦截 :
MyBatis 还提供了另外一种分页方式,基于插件拦截机制。这种方式更加灵活,支持实现更为复杂的分页功能。
我们需要自定义一个拦截器,实现 Interceptor 接口,并重写其中唯一的 intercept 方法,在其中对 SQL 语句进行修改,添加分页信息。具体操作如下:
首先,创建一个类来实现该拦截器:
代码语言:javascript复制public class PageInterceptor implements Interceptor {
/**
* 拦截方法
*
* @param invocation
* @return
* @throws Throwable
*/
@Override
public Object intercept(Invocation invocation) throws Throwable {
// 获取原始的SQL语句
String sql = (String) invocation.getArgs()[0];
// 查询总数并计算出总页数和当前页
int total = count(sql);
// 如果总数小于等于0,则直接返回空结果集
if (total <= 0) {
return Collections.emptyList();
}
// 计算出当前页的起始位置和结束位置
int offset = getOffset(pageNo, pageSize);
int limit = pageSize;
// 构造含分页信息的新SQL
String newSql = getNewSql(sql, offset, limit);
// 将新SQL替换成原来的SQL,并继续执行原有方法
ReflectionUtils.setFieldValue(invocation, "h.sql", newSql);
Object result = invocation.proceed();
// 包装成Page对象,并返回
Page<T> pageResult = new Page<>(pageNo,pageSize,total,(List<T>)result);
return pageResult;
}
/**
* 获取新的SQL语句(含分页信息)
*
* @param sql
* @param offset
* @param limit
* @return
*/
private String getNewSql(String sql, int offset, int limit) {
return sql " LIMIT " offset "," limit;
}
/**
* 获取查询结果总数
*
* @param sql
* @return
*/
private int count(String sql){
// code omitted
}
/**
* 计算当前分页的 Offset
*
* @param pageNo
* @param pageSize
* @return
*/
private int getOffset(int pageNo, int pageSize) {
return (pageNo - 1) * pageSize;
}
}
然后,我们需要在 mybatis-config.xml 配置文件中注册该拦截器:
代码语言:javascript复制<plugins>
<plugin interceptor="com.example.mybatis.PageInterceptor"/>
</plugins>
最终,在查询数据时,我们便可以按照以下方式进行分页处理了:
代码语言:javascript复制public List<User> selectUserListByPage(int startRow, int pageSize){
RowBounds rowBounds = new RowBounds(startRow,pageSize);
String statement = "com.example.UserMapper.selectUserList";
return sqlSession.selectList(statement,null,rowBounds);
}