相信大家都遇到过需要列表分页的情况,尤其是在数据量比较大的情况下,分页操作可以增加用户体验。而下面我们要介绍的PageHelper插件就是Mybatis中一款比较优秀的开源的分页插件。
PageHelper可以干什么?
PageHelper可以有效的减少开发人员对于分页操作的处理,提升开发效率。
在关系型数据库查询的时候,如果在数据量较大的时候,我们通过一次SQL去查询所有的数据这种实现显然是不可行的,笔者就经历过这样的事情,大量的数据查询导致小程序列表加载非常缓慢,最终还是通过分页查询的方式来解决了该问题。
显然如果是通过编码的方式来实现分页操作是一个比较繁琐的过程,首先需要计算总过有多少的元素,其次,要拆分每一页都有几个元素,并且这些元素可以分为几页,都需要进行计算,如果计算不合适的话有可能会导致空指针异常。因此Mybatis推出了分页插件PageHelper。
PageHelper的优势?
优势
- 无侵入:使用PageHelper对Mybatis结果进行分页的时候,不需要修改原来的SQL语句,也不需要对Mapper接口以及XML文件添加PageNum和PageSize的参数。
- 简单易用:使用PageHelper的时候只需要在POM文件中引入相关的依赖,然后通过编码的方式就可以实现分页操作。
- 支持复杂查询:PageHelper不但可以支持MySQL数据库,还可以支持其他的数据库,并且支持复杂的分页查询功能。
- 可以自定义拦截器:PageHelper可以支持自定义的拦截器,并且提供了丰富的配置选项,开发者可以根据自己的需求对其进行自定义操作。来支持自己特殊的业务需求。
劣势
- 引入PageHelper需要修改项目的配置依赖以及一些低侵入的控制层代码。在处理查询的时候需要进行特殊的区分。
- 由于PageHelper是基于Mybatis的插件来进行实现,所以可能在有些查询中会损耗查询性能。
如何使用?
引入POM依赖
在项目中引入对应的POM依赖
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>5.2.0</version>
</dependency>
除此之外还要引入Mybatis相关的依赖。或者引入如下的依赖启动项
<!-- pagehelper 分页插件 -->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
</dependency>
配置PageHelper
在SpringBoot的配置文件中通过如下的配置来配置PageHelper。
# PageHelper分页插件
pagehelper:
helperDialect: mysql
supportMethodsArguments: true
params: count=countSql
其中helperDialect 属性用来指定当前项目所使用的数据库类型;supportMethodsArguments 用来指定是否支持接口参数来传递分页参数,也就是页大小与页码;params参数用来指定PageHelper参数名称。
具体使用
可以继承PageHelper类并且实现startPage()方法用来实行分页功能。
public class PageUtils extends PageHelper
{
/**
* 设置请求分页数据
*/
public static void startPage()
{
PageDomain pageDomain = TableSupport.buildPageRequest();
Integer pageNum = pageDomain.getPageNum();
Integer pageSize = pageDomain.getPageSize();
String orderBy = SqlUtil.escapeOrderBySql(pageDomain.getOrderBy());
Boolean reasonable = pageDomain.getReasonable();
PageHelper.startPage(pageNum, pageSize, orderBy).setReasonable(reasonable);
}
/**
* 清理分页的线程变量
*/
public static void clearPage()
{
PageHelper.clearPage();
}
}
会发现其中最关键的代码就是
PageHelper.startPage(pageNum, pageSize, orderBy).setReasonable(reasonable);
这段代码指定页码,页大小以及排序规则,并且使用了reasonable参数来对查询进行了优化。
PageHelper原理分析
根据上面的分析,我们知道PageHelper是基于Mybatis的插件来开发的,所以其底层支持是对Mybatis的支持。通过Mybatis中的拦截器机制对于SQL语句的执行和处理分析进行了拦截来实现分页操作。源码路径
com.github.pagehelper.PageInterceptor
在PageHelper拦截器中主要完成了如下几个内容
- 解析分页参数,也就是我们常说的页大小、页码等分页参数进行解析
- 生成用于分页的SQL语句,通过拦截器,将原始的SQL语句修改成具有分页查询功能的新的SQL语句。
- 执行分页查询,将新生成的SQL语句执行,获取到查询的结果并且保存在Page对象中,同时在返回结果中返回对应的List。
- 生成分页信息,通过自定义的Page对象,例如上面的PageDomain对象,来保存分页的内容,总条数、页码数,页大小等参数,最终返回PageInfo的对象。
总结
在众多的分页插件中PageHelper可以说是使用最方便的插件,并且使用方便,除了提供的使用文档较少之外,其他的功能都是值得推荐的。