PageHelper 分页查询【底层代码-图文分析】【原理篇】PageMethod.startPage做了什么？分页插件

🍰 个人主页:不摆烂的小劉

🍞文章有不合理的地方请各位大佬指正。

🍉文章不定期持续更新，如果我的文章对你有帮助➡️ 关注🙏🏻 点赞👍 收藏⭐️

直接上代码，下面是常见的分页应用代码。

PageMethod.startPage(dto.getPageNum(), dto.getPageSize());
List<ProductVO> products = productDAO.listProducts(dto);
return new PageInfo<>(products);

上面三行代码做了什么事？怎么做的？

一、前置知识

1.sql中的limit

limit 10,20 第11 行（因为索引从 0 开始，偏移量 10 就对应第 11 行）开始选取 20 行数据

limit 10 选取前10 行数据

二、分页原理

1.`PageMethod.startPage(dto.getPageNum(), dto.getPageSize());`

设置当前要查询的页码（dto.getPageNum()）和每页显示的记录数量（dto.getPageSize()）

在这里插入图片描述

将分页参数存放到ThreadLocal中：
ThreadLocal在线程内直接获取资源，避免方法调用链中频繁地传递分页参数

2.`List<ProductVO> products = productDAO.listProducts(dto);`

2.1MyBatis拦截器

执行数据库查询，自动应用分页逻辑
Pagehelper底层通过拦截器实现分页.参考MyBatis 的拦截器的文档部分，Executor 中的 query 方法可以被拦截，被拦截有两个方法

<E> List<E> query(
      MappedStatement ms,
      Object parameter,
      RowBounds rowBounds,
      ResultHandler resultHandler,
      CacheKey cacheKey,
      BoundSql boundSql) throws SQLException;

<E> List<E> query(
      MappedStatement ms,
      Object parameter,
      RowBounds rowBounds,
      ResultHandler resultHandler) throws SQLException;

6参数query查询, 4参数query 查询

Mybatis通过org.apache.ibatis.session.Configuration 加入拦截，MyBatis 会按照拦截器配置的顺序依次添加到 interceptorChain 中

public void addInterceptor(Interceptor interceptor) {
    interceptorChain.addInterceptor(interceptor);
}

2.2`PageHelper`拦截器`PageInterceptor`

在这里插入图片描述

注解 @Intercepts：定义了一个拦截器，用于拦截MyBatis的Executor类中的query方法。
注解 @Signature：指定了要拦截的方法签名，包括方法类型、方法名和参数类型。
可以看出这里拦截了Executor 中6参数query查询, 4参数query 查询
PageInterceptor中的intercept方法是整个分页查询的关键，核心代码如下： ![在这里插入图片描述](i-blog.csdnimg.cn/direct/f1b6… =800x470) 流程图 ![在这里插入图片描述](i-blog.csdnimg.cn/direct/63a8… =500x170) 围绕这块核心代码分析一下：

判断是否需要进行 count 查询dialect.beforeCount(ms, parameter, rowBounds)

在设置分页参数时，两种构造器，设置`count`是否开启查询总数

//默认开启
this.count = true PageMethod.startPage(dto.getPageNum(), dto.getPageSize()); 
// 关闭查询总数 
PageMethod.startPage(dto.getPageNum(), dto.getPageSize(),false);

查询总数Long count = count(executor, ms, parameter, rowBounds, null, boundSql); 执行自动创建的 count 查询获取查询总数的sql 将查询的sql包起来，拼装count(sql) ，查询总数。
执行查询resultList = ExecutorUtil.pageQuery(dialect, executor, ms, parameter, rowBounds, resultHandler, boundSql, cacheKey);