前文中，我们展示了Spring Boot与MyBatis的集成，但是没有展示分页实现。本文专门介绍分页相关知识体系和基于MyBatis的物理分页PageHelper。@anarkh
- SpringBoot集成MySQL - MyBatis PageHelper分页
- 准备知识
- MyBatis的相关知识体系
- 逻辑分页和物理分页的区别？
- 不同数据库的物理分页是如何实现的？
- PageHelper是如何实现物理分页的前提:MyBatis的插件机制？
- 简单示例
- 第一种：RowBounds方式的调用
- 第二种：Mapper接口方式的调用startPage
- 第三种：Mapper接口方式的调用offsetPage
- 第四种:参数方法调用
- 第五种:参数对象
- 第六种：ISelect 接口方式
- 进一步理解
- PageHelper是如何实现分页的？
- 使用PageHelper有何注意点
- 示例源码
准备知识
MyBatis的相关知识体系以及常见的数据库分页方式，MySQL物理分页的方式等。
MyBatis的相关知识体系
MyBatis技术栈演化 SpringBoot集成MySQL - MyBatis XML方式
MyBatis源码知识体系 MyBatis详解 - 总体框架设计
逻辑分页和物理分页的区别？
为什么会出现PageHelper这类框架？
这便要从逻辑分页和物理分页开始说起：
逻辑分页 ：从数据库将所有记录查询出来，存储到内存中，展示当前页，然后数据再直接从内存中获取（前台分页）
物理分页 ：只从数据库中查询当前页的数据（后台分页）
由于MyBatis默认实现中采用的是逻辑分页，所以才诞生了PageHelper一类的物理分页框架。hibernate不要是因为hibernate采用的就是物理分页。
不同数据库的物理分页是如何实现的？
那物理分页通常是如何实现的呢？
不同的数据库有不同的实现方式：（简单而言：mysql 使用limit ，SQLServer 使用top ，Oracle使用rowNum）
- MySQL 使用LIMIT
例如：
SELECT username, password
FROM tb_user
WHERE id = 1
LIMIT 100,10- SQLServer 2012 使用top
SQL SERVER 2012 支持了OFFSET + TOP方式提高了性能
SELECT top(50) LastName, FirstName, EmailAddress
FROM Employee
ORDER BY LastName, FirstName, EmailAddress
OFFSET 14000 ROWS
FETCH NEXT 50 ROWS ONLY;- ORACLE
SELECT *
FROM (SELECT AA.*, ROWNUM RN
FROM (SELECT * FROM USERS ORDER BY ID DESC) AA
WHERE ROWNUM <= 10 )
WHERE RN > 0（这里只是给你简单介绍，感兴趣的可以去查找更多的资料）
PageHelper是如何实现物理分页的前提:MyBatis的插件机制？
这就要谈到MyBatis的插件机制
具体请参考这两篇文章
- MyBatis详解 - 插件机制
- MyBatis提供了一种插件(plugin)的功能，虽然叫做插件，但其实这是拦截器功能。那么拦截器拦截MyBatis中的哪些内容呢？
- MyBatis详解 - 插件之分页机制
- Mybatis的分页功能很弱，它是基于内存的分页（查出所有记录再按偏移量和limit取结果），在大数据量的情况下这样的分页基本上是没有用的。本文基于插件，通过拦截StatementHandler重写sql语句，实现数据库的物理分页
简单示例
PageHelper 有多种用法，这里主要介绍官网提供的几种常见用法。具体请参考官网的介绍在新窗口打开
第一种：RowBounds方式的调用
第一种，RowBounds方式的调用
List<User> list = sqlSession.selectList("x.y.selectIf", null, new RowBounds(0, 10));第二种：Mapper接口方式的调用startPage
第二种，Mapper接口方式的调用，推荐这种使用方式。
PageHelper.startPage(1, 10);
List<User> list = userMapper.selectIf(1);第三种：Mapper接口方式的调用offsetPage
第三种，Mapper接口方式的调用，推荐这种使用方式。
PageHelper.offsetPage(1, 10);
List<User> list = userMapper.selectIf(1);第四种:参数方法调用
第四种:参数方法调用
public interface CountryMapper {
List<User> selectByPageNumSize(
@Param("user") User user,
@Param("pageNum") int pageNum,
@Param("pageSize") int pageSize);
}
List<User> list = userMapper.selectByPageNumSize(user, 1, 10);第五种:参数对象
public class User {
private Integer pageNum;
private Integer pageSize;
}
public interface CountryMapper {
List<User> selectByPageNumSize(User user);
}
List<User> list = userMapper.selectByPageNumSize(user);第六种：ISelect 接口方式
jdk6,7用法，创建接口
Page<User> page = PageHelper.startPage(1, 10).doSelectPage(new ISelect() {
@Override
public void doSelect() {
userMapper.selectGroupBy();
}
});jdk8 lambda用法
Page<User> page = PageHelper.startPage(1, 10).doSelectPage(()-> userMapper.selectGroupBy());也可以直接返回PageInfo，注意doSelectPageInfo方法和doSelectPage
pageInfo = PageHelper.startPage(1, 10).doSelectPageInfo(new ISelect() {
@Override
public void doSelect() {
userMapper.selectGroupBy();
}
});对应的lambda用法
pageInfo = PageHelper.startPage(1, 10).doSelectPageInfo(() -> userMapper.selectGroupBy());count查询，返回一个查询语句的count数
long total = PageHelper.count(new ISelect() {
@Override
public void doSelect() {
userMapper.selectLike(user);
}
});
对应的lambda用法
```java
total = PageHelper.count(()->userMapper.selectLike(user));进一步理解
我们通过如下问题进一步理解PageHelper分页。@anarkh
PageHelper是如何实现分页的？
我们知道如何使用PageHelper后，我们发现使用
PageHelper.startPage(pageNum, pageSize, orderBy)方法后的第一个select是具备分页能力的，那它是如何做到的呢？
理解它的原理，有两个点：
- 第一，相对对于JDBC这种嵌入式的分页而言，PageHelper分页是独立的，能做到独立分页查询，那它必然是通过某个拦截点进行了拦截，这样它才能够进行解耦分离出分页 。
- 第二，我们通过
PageHelper.startPage(pageNum, pageSize, orderBy)方法后的第一个select是具备分页能力的，那它必然缓存了分页信息，同时结合线程知识，这里必然使用的是本地栈ThreadLocal ，即每个线程有一个本地缓存。
所以结合这两点，聪明的你就会想到它大概是如何实现的，关键就是两点（拦截，ThreadLocal), 我们看下源码：
简单看下拦截
public Object intercept(Invocation invocation) throws Throwable {
if (autoRuntimeDialect) {
SqlUtil sqlUtil = getSqlUtil(invocation);
return sqlUtil.processPage(invocation);
} else {
if (autoDialect) {
initSqlUtil(invocation);
}
return sqlUtil.processPage(invocation);
}
}进而看下sqlUtil.processPage(invocation);方法
private Object _processPage(Invocation invocation) throws Throwable {
final Object[] args = invocation.getArgs();
Page page = null;
if (supportMethodsArguments) {
page = getPage(args);
}
RowBounds rowBounds = (RowBounds) args[2];
if ((supportMethodsArguments && page == null)
|| (!supportMethodsArguments && SqlUtil.getLocalPage() == null && rowBounds == RowBounds.DEFAULT)) {
return invocation.proceed();
} else {
if (!supportMethodsArguments && page == null) {
page = getPage(args);
}
return doProcessPage(invocation, page, args);
}
}所以startPage方法和这里的getPage(args);这方法里应该包含了ThreadLocal中设置和获取分页参数的，让我们看下startPage方法即可：
public static <E> Page<E> startPage(int pageNum, int pageSize, boolean count, Boolean reasonable, Boolean pageSizeZero) {
Page<E> page = new Page(pageNum, pageSize, count);
page.setReasonable(reasonable);
page.setPageSizeZero(pageSizeZero);
Page<E> oldPage = getLocalPage();
if (oldPage != null && oldPage.isOrderByOnly()) {
page.setOrderBy(oldPage.getOrderBy());
}
setLocalPage(page);
return page;
}
protected static final ThreadLocal<Page> LOCAL_PAGE = new ThreadLocal();
protected static void setLocalPage(Page page) {
LOCAL_PAGE.set(page);
}所以这里提示下想进阶的开发者，源码的阅读是伴随着思路现行的（有了思路，简单看源码），而不是直接源码。
使用PageHelper有何注意点
- 只有紧跟在
PageHelper.startPage方法后的第一个 Mybatis的查询（Select） 方法会被分页。 - 请不要配置多个分页插件：请不要在系统中配置多个分页插件(使用Spring时,
mybatis-config.xml和Spring<bean>配置方式，请选择其中一种，不要同时配置多个分页插件)！ - 分页插件不支持带有
for update语句的分页：对于带有for update的sql，会抛出运行时异常，对于这样的sql建议手动分页，毕竟这样的sql需要重视。 - 分页插件不支持嵌套结果映射: 由于嵌套结果方式会导致结果集被折叠，因此分页查询的结果在折叠后总数会减少，所以无法保证分页结果数量正确。
示例源码
（上述代码中一些实体类和配置的完整代码，请参考如下代码仓库）