PageHelper工作原理

数据分页功能是我们软件系统中必备的功能，在持久层使用mybatis的情况下，pageHelper来实现后台分页则是我们常用的一个选择，所以本文专门类介绍下。

PageHelper原理
相关依赖


<dependency><groupId>org.mybatis</groupId><artifactId>mybatis</artifactId><version>3.2.8</version>
</dependency>
<dependency><groupId>com.github.pagehelper</groupId><artifactId>pagehelper</artifactId><version>1.2.15</version>
</dependency>

1.添加plugin
  要使用PageHelper首先在mybatis的全局配置文件中配置。如下:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configurationPUBLIC "-//mybatis.org//DTD Config 3.0//EN""http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration><plugins><!-- com.github.pagehelper为PageHelper类所在包名 --><plugin interceptor="com.github.pagehelper.PageHelper"><property name="dialect" value="mysql" /><!-- 该参数默认为false --><!-- 设置为true时，会将RowBounds第一个参数offset当成pageNum页码使用 --><!-- 和startPage中的pageNum效果一样 --><property name="offsetAsPageNum" value="true" /><!-- 该参数默认为false --><!-- 设置为true时，使用RowBounds分页会进行count查询 --><property name="rowBoundsWithCount" value="true" /><!-- 设置为true时，如果pageSize=0或者RowBounds.limit = 0就会查询出全部的结果 --><!-- （相当于没有执行分页查询，但是返回结果仍然是Page类型） --><property name="pageSizeZero" value="true" /><!-- 3.3.0版本可用 - 分页参数合理化，默认false禁用 --><!-- 启用合理化时，如果pageNum<1会查询第一页，如果pageNum>pages会查询最后一页 --><!-- 禁用合理化时，如果pageNum<1或pageNum>pages会返回空数据 --><property name="reasonable" value="false" /><!-- 3.5.0版本可用 - 为了支持startPage(Object params)方法 --><!-- 增加了一个`params`参数来配置参数映射，用于从Map或ServletRequest中取值 --><!-- 可以配置pageNum,pageSize,count,pageSizeZero,reasonable,不配置映射的用默认值 --><!-- 不理解该含义的前提下，不要随便复制该配置 --><property name="params" value="pageNum=start;pageSize=limit;" /><!-- always总是返回PageInfo类型,check检查返回类型是否为PageInfo,none返回Page --><property name="returnPageInfo" value="check" /></plugin></plugins>
</configuration>

2.加载过程
  我们通过如下几行代码来演示过程


// 获取配置文件
InputStream inputStream = Resources.getResourceAsStream("mybatis/mybatis-config.xml");
// 通过加载配置文件获取SqlSessionFactory对象
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(inputStream);
// 获取SqlSession对象
SqlSession session = factory.openSession();
PageHelper.startPage(1, 5);
session.selectList("com.bobo.UserMapper.query");

加载配置文件我们从这行代码开始

new SqlSessionFactoryBuilder().build(inputStream);public SqlSessionFactory build(InputStream inputStream) {return build(inputStream, null, null);}

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

private void pluginElement(XNode parent) throws Exception {if (parent != null) {for (XNode child : parent.getChildren()) {// 获取到内容:com.github.pagehelper.PageHelperString interceptor = child.getStringAttribute("interceptor");// 获取配置的属性信息Properties properties = child.getChildrenAsProperties();// 创建的拦截器实例Interceptor interceptorInstance = (Interceptor) resolveClass(interceptor).newInstance();// 将属性和拦截器绑定interceptorInstance.setProperties(properties);// 这个方法需要进入查看configuration.addInterceptor(interceptorInstance);}}
}public void addInterceptor(Interceptor interceptor) {// 将拦截器添加到了 拦截器链中 而拦截器链本质上就是一个List有序集合interceptorChain.addInterceptor(interceptor);}

在这里插入图片描述

小结:通过SqlSessionFactory对象的获取，我们加载了全局配置文件及映射文件同时还将配置的拦截器添加到了拦截器链中。

3.PageHelper定义的拦截信息
  我们来看下PageHelper的源代码的头部定义

@SuppressWarnings("rawtypes")
@Intercepts(@Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}))
public class PageHelper implements Interceptor {//sql工具类private SqlUtil sqlUtil;//属性参数信息private Properties properties;//配置对象方式private SqlUtilConfig sqlUtilConfig;//自动获取dialect,如果没有setProperties或setSqlUtilConfig，也可以正常进行private boolean autoDialect = true;//运行时自动获取dialectprivate boolean autoRuntimeDialect;//多数据源时，获取jdbcurl后是否关闭数据源private boolean closeConn = true;
// 定义的是拦截 Executor对象中的
// query(MappedStatement ms,Object o,RowBounds ob ResultHandler rh)
// 这个方法
type = Executor.class, 
method = "query", 
args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}))

PageHelper中已经定义了该拦截器拦截的方法是什么。

4.Executor
  接下来我们需要分析下SqlSession的实例化过程中Executor发生了什么。我们需要从这行代码开始跟踪

SqlSession session = factory.openSession();
public SqlSession openSession() {return openSessionFromDataSource(configuration.getDefaultExecutorType(), null, false);
}

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
增强Executor
在这里插入图片描述
在这里插入图片描述
  到此我们明白了,Executor对象其实被我们生存的代理类增强了。invoke的代码为

public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {try {Set<Method> methods = signatureMap.get(method.getDeclaringClass());// 如果是定义的拦截的方法 就执行intercept方法if (methods != null && methods.contains(method)) {// 进入查看 该方法增强return interceptor.intercept(new Invocation(target, method, args));}// 不是需要拦截的方法 直接执行return method.invoke(target, args);} catch (Exception e) {throw ExceptionUtil.unwrapThrowable(e);}
}
/*** Mybatis拦截器方法** @param invocation 拦截器入参* @return 返回执行结果* @throws Throwable 抛出异常*/
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);}
}

该方法中的内容我们后面再分析。Executor的分析我们到此，接下来看下PageHelper实现分页的具体过程。

5.分页过程
  接下来我们通过代码跟踪来看下具体的分页流程，我们需要分别从两行代码开始:

5.1 startPage
PageHelper.startPage(1, 5);

/*** 开始分页** @param params*/
public static <E> Page<E> startPage(Object params) {Page<E> page = SqlUtil.getPageFromObject(params);//当已经执行过orderBy的时候Page<E> oldPage = SqlUtil.getLocalPage();if (oldPage != null && oldPage.isOrderByOnly()) {page.setOrderBy(oldPage.getOrderBy());}SqlUtil.setLocalPage(page);return page;
}
/*** 开始分页** @param pageNum    页码* @param pageSize   每页显示数量* @param count      是否进行count查询* @param reasonable 分页合理化,null时用默认配置*/
public static <E> Page<E> startPage(int pageNum, int pageSize, boolean count, Boolean reasonable) {return startPage(pageNum, pageSize, count, reasonable, null);
}
/*** 开始分页** @param offset 页码* @param limit  每页显示数量* @param count  是否进行count查询*/
public static <E> Page<E> offsetPage(int offset, int limit, boolean count) {Page<E> page = new Page<E>(new int[]{offset, limit}, count);//当已经执行过orderBy的时候Page<E> oldPage = SqlUtil.getLocalPage();if (oldPage != null && oldPage.isOrderByOnly()) {page.setOrderBy(oldPage.getOrderBy());}// 这是重点！！！SqlUtil.setLocalPage(page);return page;
}
private static final ThreadLocal<Page> LOCAL_PAGE = new ThreadLocal<Page>();
// 将分页信息保存在ThreadLocal中 线程安全！
public static void setLocalPage(Page page) {LOCAL_PAGE.set(page);
}

5.2selectList方法

session.selectList("com.bobo.UserMapper.query");
public <E> List<E> selectList(String statement) {return this.selectList(statement, null);
}public <E> List<E> selectList(String statement, Object parameter) {return this.selectList(statement, parameter, RowBounds.DEFAULT);
}

在这里插入图片描述
我们需要回到invoke方法中继续看

/*** Mybatis拦截器方法** @param invocation 拦截器入参* @return 返回执行结果* @throws Throwable 抛出异常*/
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);方法


/*** Mybatis拦截器方法** @param invocation 拦截器入参* @return 返回执行结果* @throws Throwable 抛出异常*/
private Object _processPage(Invocation invocation) throws Throwable {final Object[] args = invocation.getArgs();Page page = null;//支持方法参数时，会先尝试获取Pageif (supportMethodsArguments) {// 从线程本地变量中获取Page信息，就是我们刚刚设置的page = getPage(args);}//分页信息RowBounds rowBounds = (RowBounds) args[2];//支持方法参数时，如果page == null就说明没有分页条件，不需要分页查询if ((supportMethodsArguments && page == null)//当不支持分页参数时，判断LocalPage和RowBounds判断是否需要分页|| (!supportMethodsArguments && SqlUtil.getLocalPage() == null && rowBounds == RowBounds.DEFAULT)) {return invocation.proceed();} else {//不支持分页参数时，page==null，这里需要获取if (!supportMethodsArguments && page == null) {page = getPage(args);}// 进入查看return doProcessPage(invocation, page, args);}
}
/*** Mybatis拦截器方法** @param invocation 拦截器入参* @return 返回执行结果* @throws Throwable 抛出异常*/private Page doProcessPage(Invocation invocation, Page page, Object[] args) throws Throwable {//保存RowBounds状态RowBounds rowBounds = (RowBounds) args[2];//获取原始的msMappedStatement ms = (MappedStatement) args[0];//判断并处理为PageSqlSourceif (!isPageSqlSource(ms)) {processMappedStatement(ms);}//设置当前的parser，后面每次使用前都会set，ThreadLocal的值不会产生不良影响((PageSqlSource)ms.getSqlSource()).setParser(parser);try {//忽略RowBounds-否则会进行Mybatis自带的内存分页args[2] = RowBounds.DEFAULT;//如果只进行排序 或 pageSizeZero的判断if (isQueryOnly(page)) {return doQueryOnly(page, invocation);}//简单的通过total的值来判断是否进行count查询if (page.isCount()) {page.setCountSignal(Boolean.TRUE);//替换MSargs[0] = msCountMap.get(ms.getId());//查询总数Object result = invocation.proceed();//还原msargs[0] = ms;//设置总数page.setTotal((Integer) ((List) result).get(0));if (page.getTotal() == 0) {return page;}} else {page.setTotal(-1l);}//pageSize>0的时候执行分页查询，pageSize<=0的时候不执行相当于可能只返回了一个countif (page.getPageSize() > 0 &&((rowBounds == RowBounds.DEFAULT && page.getPageNum() > 0)|| rowBounds != RowBounds.DEFAULT)) {//将参数中的MappedStatement替换为新的qspage.setCountSignal(null);// 重点是查看该方法BoundSql boundSql = ms.getBoundSql(args[1]);args[1] = parser.setPageParameter(ms, args[1], boundSql, page);page.setCountSignal(Boolean.FALSE);//执行分页查询Object result = invocation.proceed();//得到处理结果page.addAll((List) result);}} finally {((PageSqlSource)ms.getSqlSource()).removeParser();}//返回结果return page;}
进入 BoundSql boundSql = ms.getBoundSql(args[1])方法跟踪到PageStaticSqlSource类中的@Override
protected BoundSql getPageBoundSql(Object parameterObject) {String tempSql = sql;String orderBy = PageHelper.getOrderBy();if (orderBy != null) {tempSql = OrderByParser.converToOrderBySql(sql, orderBy);}tempSql = localParser.get().getPageSql(tempSql);return new BoundSql(configuration, tempSql, localParser.get().getPageParameterMapping(configuration, original.getBoundSql(parameterObject)), parameterObject);
}
@Override
protected BoundSql getPageBoundSql(Object parameterObject) {String tempSql = sql;String orderBy = PageHelper.getOrderBy();if (orderBy != null) {tempSql = OrderByParser.converToOrderBySql(sql, orderBy);}tempSql = localParser.get().getPageSql(tempSql);return new BoundSql(configuration, tempSql, localParser.get().getPageParameterMapping(configuration, original.getBoundSql(parameterObject)), parameterObject);
}

在这里插入图片描述
在这里插入图片描述
也可以看Oracle的分页实现
在这里插入图片描述
至此我们发现PageHelper分页的实现原来是在我们执行SQL语句之前动态的将SQL语句拼接了分页的语句，从而实现了从数据库中分页获取的过程。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/250102.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

10-多写一个@Autowired导致程序崩了

10-多写一个@Autowired导致程序崩了

再是javaweb实验六中&#xff0c;是让我们改代码&#xff0c;让它跑起来&#xff0c;结果我少注释了一个&#xff0c;导致一直报错&#xff0c;检查许久没有找到&#xff0c;最后通过代码替换逐步查找&#xff0c;才发现问题。 转载于:https://www.cnblogs.com/zhumengdexiaoba…
阅读更多...
Java class不分32位和64位

Java class不分32位和64位

1、32位JDK编译的java class在32位系统和64位系统下都可以运行&#xff0c;64位系统兼容32位程序&#xff0c;可以理解。2、无论是Linux还是Windows平台下的JDK编译的java class在Linux、Windows平台下通用&#xff0c;Java跨平台特性。3、64位JDK编译的java class在32位的系统…
阅读更多...
包装对象

包装对象

原文地址&#xff1a;https://wangdoc.com/javascript/ 定义 对象是JavaScript语言最主要的数据类型&#xff0c;三种原始类型的值--数值、字符串、布尔值--在一定条件下&#xff0c;也会自动转为对象&#xff0c;也就是原始类型的包装对象。所谓包装对象&#xff0c;就是分别与…
阅读更多...
[C++] 转义序列

[C++] 转义序列

参考 C Primer(第5版)P36 名称转义序列换行符\n横向制表符\t报警(响铃)符\a纵向制表符\v退格符\b双引号"反斜杠\问号?单引号’回车符\r进纸符\f
阅读更多...
vue使用（二）

vue使用（二）

本节目标&#xff1a; 1.数据路径的三种方式 2.{{}}和v-html的区别 1.绑定图片的路径 方法一&#xff1a;直接写路径 <img src"http://pic.baike.soso.com/p/20140109/20140109142534-188809525.jpg"> 方法二&#xff1a;在data中写路径&#xff0c;在…
阅读更多...
typedef 为类型取别名

typedef 为类型取别名

#include <stdio.h> int main() { 　　typedef int myint; // 为int 类型取自己想要的名字 　　myint a 10; 　　printf("%d", a); 　　return 0;} 其他类型的用法也是一样的 typedef 类型 自己想要取得名字; 转载于:https://www.cnblogs.com/hello-dummy/p/9…
阅读更多...
【C++】如何提高Cache的命中率，示例

【C++】如何提高Cache的命中率，示例

参考链接 https://stackoverflow.com/questions/16699247/what-is-a-cache-friendly-code 只是堆积&#xff1a;缓存不友好与缓存友好代码的典型例子是矩阵乘法的“缓存阻塞”。 朴素矩阵乘法看起来像 for(i0;i<N;i) {for(j0;j<N;j) {dest[i][j] 0;for( k;k<N;i)…
阅读更多...
springboot---整合redis

springboot---整合redis

pom.xml新增 <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-redis</artifactId></dependency>代码结构如下 其中redis.yml是连接redis的配置文件&#xff0c;RedisConfig.java是java配置…
阅读更多...
[Head First Java] - 简单的建议程序

[Head First Java] - 简单的建议程序

参考 - p481、p484 与我对接的业务层使用的是JAVA语言,因此花点时间入门java.下面几篇博客可能都是关于java的,我觉得在工作中可能会遇到的 简单的通信 DailyAdviceClient(客户端程序) import java.io.*; import java.net.*;public class DailyAdviceClient{public void go()…
阅读更多...
SQL重复记录查询的几种方法

SQL重复记录查询的几种方法

1 查找表中多余的重复记录&#xff0c;重复记录是根据单个字段1 select * from TB_MAT_BasicData1 2 where MATNR in ( select MATNR from TB_MAT_BasicData1 group by MATNR having count(MATNR)>1) 2.表需要删除重复的记录&#xff08;重复记录保留1条&#xff09;&…
阅读更多...
Redis 的应用场景

Redis 的应用场景

之前讲过Redis的介绍&#xff0c;及使用Redis带来的优势&#xff0c;这章整理了一下Redis的应用场景&#xff0c;也是非常重要的&#xff0c;学不学得好&#xff0c;能正常落地是关键。 下面一一来分析下Redis的应用场景都有哪些。 1、缓存 缓存现在几乎是所有中大型网站都在…
阅读更多...
[Head First Java] - Swing做一个简单的客户端

[Head First Java] - Swing做一个简单的客户端

参考 - P487 1. vscode配置java的格式 点击左下角齿轮 -> 设置 -> 打开任意的setting.json输入如下代码 {code-runner.executorMap": {"java": "cd $dir && javac -encoding utf-8 $fileName && java $fileNameWithoutExt"},…
阅读更多...
【Nginx】 Nginx实现端口转发

【Nginx】 Nginx实现端口转发

什么是端口转发 当我们在服务器上搭建一个图书以及一个电影的应用&#xff0c;其中图书应用启动了 8001 端口&#xff0c;电影应用启动了 8002 端口。此时如果我们可以通过 localhost:8001 //图书 localhost:8002 //电影 但我们一般访问应用的时候都是希望不加端口就访问…
阅读更多...
计算机网络知识总结

计算机网络知识总结

一 OSI与TCP/IP各层的结构与功能&#xff0c;都有哪些协议 OSI的七层体系结构概念清楚&#xff0c;理论也很完整&#xff0c;但是它比较复杂而且不实用。在这里顺带提一下之前一直被一些大公司甚至一些国家政府支持的OSI失败的原因&#xff1a; OSI的专家缺乏实际经验&#xff…
阅读更多...
使用redis做为MySQL的缓存

使用redis做为MySQL的缓存

介绍 在实际项目中&#xff0c;MySQL数据库服务器有时会位于另外一台主机&#xff0c;需要通过网络来访问数据库&#xff1b;即使应用程序与MySQL数据库在同一个主机中&#xff0c;访问MySQL也涉及到磁盘IO操作&#xff08;MySQL也有一些数据预读技术&#xff0c;能够减少磁盘I…
阅读更多...
[Head First Java] - 给线程命名

[Head First Java] - 给线程命名

参考 - P503 public class RunThreads implements Runnable {public static void main (String[] args) {RunThreads runner new RunThreads();Thread alpha new Thread(runner);Thread beta new Thread(runner);alpha.setName("Alpha thread");beta.setName(&qu…
阅读更多...
Cortex-M3 的SVC、PendSV异常，与操作系统(ucos实时系统)（转）

Cortex-M3 的SVC、PendSV异常，与操作系统(ucos实时系统)（转）

Cortex-M3 的SVC、PendSV异常&#xff0c;与操作系统(ucos实时系统)转载于:https://www.cnblogs.com/LittleTiger/p/10070824.html
阅读更多...
快速排序的C++版

快速排序的C++版

int Partition(int a[], int low, int high) {int x a[high];//将输入数组的最后一个数作为主元&#xff0c;用它来对数组进行划分int i low - 1;//i是最后一个小于主元的数的下标for (int j low; j < high; j)//遍历下标由low到high-1的数{if (a[j] < x)//如果数小于…
阅读更多...
springboot---整合shiro

springboot---整合shiro

Shiro是一个非常不错的权限框架&#xff0c;它提供了登录和权限验证功能 1.创建数据库脚本 SET NAMES utf8mb4; SET FOREIGN_KEY_CHECKS 0; -- ---------------------------- -- Table structure for module -- ---------------------------- DROP TABLE IF EXISTS module; C…
阅读更多...
[Head First Java] - 线程共享数据问题

[Head First Java] - 线程共享数据问题

参考 - P507 1. 说明 两个线程共享同一份数据,每次使用数据时,需要先判断其是否在合理范围每次使用数据完毕使用Thread.sleep函数让线程阻塞 2.代码 class BankAccount {private int balance 100;public int getBalance() {return balance;}public void withdraw(int amou…
阅读更多...
最新文章

Copyright @ 2022~2023