分页神器：PageHelper的使⽤教程
⼀、什么是PageHelper?
1.PageHelper简介
PageHelper是国内⾮常优秀的⼀款开源的mybatis分页插件，它⽀持基本的主流与常⽤的数据库。例如mysql、oracle、mariaDB、DB2、Hsqldb等。
2.PageHelper官⽹
官⽹链接：(PageHelper.github.io)
对于该开源项⽬刚兴趣的同学可以点进去阅读以下其官⽅⽂档，加深⼀下印象。
⼆、如何使⽤PageHelper?
1.导⼊jar包（本案例使⽤maven导⼊）
在maven中导⼊依赖
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>5.1.2</version>
</dependency>
2.配置
特别注意，新版是 com.github.pagehelper.PageInterceptor 。 com.github.pagehelper.PageHelper 现在是⼀个特殊的 dialect 实现类，
是分页插件的默认实现类，提供了和以前相同的⽤法。
2.1 mybatis⾥配置
<!--
plugins在配置⽂件中的位置必须符合要求，否则会报错，顺序如下:
properties?, settings?,
typeAliases?, typeHandlers?,
objectFactory?,objectWrapperFactory?,
plugins?,
environments?, databaseIdProvider?, mappers?
-->
<plugins>
<!-- com.github.pagehelper为PageHelper类所在包名-->
<plugin interceptor="com.github.pagehelper.PageInterceptor">
<!--使⽤下⾯的⽅式配置参数，后⾯会有所有的参数介绍-->
<property name="param1" value="value1"/>
</plugin>
</plugins>
2.2 spring⾥配置
⼀般在使⽤时，我们的项⽬⼀般都是⽤spring集成了mybatis，所以配置在spring中会⽐较常见。
<bean id="sqlSessionFactory"class="batis.spring.SqlSessionFactoryBean">
<!--注意其他配置-->
<property name="plugins">
<array>
<bean class="com.github.pagehelper.PageInterceptor">
<property name="properties">
<!--使⽤下⾯的⽅式配置参数，⼀⾏配置⼀个-->
<props>
<!--配置使⽤的数据库类型-->
<prop key="helpDialect">mysql</prop>
<prop key="reasonable">true</prop>
</props>
</property>
</bean>
</array>
</property>
</bean>
3、具体使⽤⽅法
3.1分页插件参数介绍
1. helperDialect ：分页插件会⾃动检测当前的数据库链接，⾃动选择合适的分页⽅式。 你可以配置helperDialect 属性来指定分页插件
使⽤哪种⽅⾔。配置时，可以使⽤下⾯的缩写值：
oracle , mysql , mariadb , sqlite , hsqldb , postgresql , db2 , sqlserver , informix , h2 , sqlserver2012 , derby
特别注意：使⽤ SqlServer2012 数据库时，需要⼿动指定为 sqlserver2012 ，否则会使⽤ SqlServer2005 的⽅式进⾏分页。你也可以实现 AbstractHelperDialect ，然后配置该属性为实现类的全限定名称即可使⽤⾃定义的实现⽅法。
2. offsetAsPageNum ：默认值为 false ，该参数对使⽤ RowBounds 作为分页参数时有效。 当该参数设置为
true 时，会将 RowBounds 中的 offset 参数当成 pageNum 使⽤，可以⽤页码和页⾯⼤⼩两个参数进⾏分页。
3. rowBoundsWithCount ：默认值为 false ，该参数对使⽤ RowBounds 作为分页参数时有效。 当该参数设置为 true 时，使⽤
RowBounds 分页会进⾏ count 查询。
4. pageSizeZero ：默认值为 false ，当该参数设置为 true 时，如果 pageSize=0 或者 RowBounds.limit =0 就会查询出全部的结果
（相当于没有执⾏分页查询，但是返回结果仍然是 Page 类型）。
5. reasonable ：分页合理化参数，默认值为 false 。当该参数设置为 true 时， pageNum<=0 时会查询第⼀页， pageNum>pages
（超过总数时），会查询最后⼀页。默认 false 时，直接根据参数进⾏查询。
6. params ：为了⽀持 startPage(Object params) ⽅法，增加了该参数来配置参数映射，⽤于从对象中根据属性名取值， 可以配置
pageNum,pageSize,count,pageSizeZero,reasonable ，不配置映射的⽤默认值， 默认值为
pageNum=pageNum;pageSize=pageSize;count=countSql;reasonable=reasonable;pageSizeZero=pageSizeZero
。
7. supportMethodsArguments ：⽀持通过 Mapper 接⼝参数来传递分页参数，默认值 false ，分页插件会从查询⽅法的参数值中，
⾃动根据上⾯ params 配置的字段中取值，查到合适的值时就会⾃动分页。 使⽤⽅法
可以参考测试代码中的 com.st.basic 包下的ArgumentsMapTest 和ArgumentsObjTest 。
8. autoRuntimeDialect ：默认值为 false 。设置为 true 时，允许在运⾏时根据多数据源⾃动识别对应⽅⾔的分页 （不⽀持⾃动选择
sqlserver2012 ，只能使⽤ sqlserver ），⽤法和注意事项参考下⾯的场景五。
9. closeConn ：默认值为 true 。当使⽤运⾏时动态数据源或没有设置 helperDialect 属性⾃动获取数据库类型时，会⾃动获取⼀个数
据库连接， 通过该属性来设置是否关闭获取的这个连接，默认 true 关闭，设置为false 后，不会关闭获取的连接，这个参数的设置要根据⾃⼰选择的数据源来决定。
3.2分页插件基本使⽤（最常⽤⽅法）
静态调⽤：
特别注意：在查询语句前使⽤
//service层：
//page：当前页码
//size：每页⾏数
PageHelper.startPage(page,size);
dao.findALL();
//controller层
List<T> list = service.findAll(page,size);
//pageInfo是⼀个分页bean
PageInfo pageInfo =new(list);
/
/把pageInfo数据传⼊到前端
ModelAndView m =new ModelAndView();
m.addObject("pageInfo",pageInfo);
m.setViewName("orders-list");
return m;
关于⼀些pageInfo的参数定义和使⽤，可以参考具体PageInfo类
/*
* The MIT License (MIT)
分页查询插件*
* Copyright (c) 2014 abel533@gmail
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN  * THE SOFTWARE.
*/
package com.github.pagehelper;
import java.io.Serializable;
import java.util.List;
/**
* 对Page<E>结果进⾏包装
* <p/>
* 新增分页的多项属性，主要参考:bbs.csdn/topics/360010907
*
* @author liuzh/abel533/isea533
* @version 3.3.0
* @since 3.2.2
* 项⽬地址 : git.oschina/free/Mybatis_PageHelper
*/
@SuppressWarnings({"rawtypes","unchecked"})
public class PageInfo<T>implements Serializable {
private static final long serialVersionUID =1L;
/
/当前页
private int pageNum;
//每页的数量
private int pageSize;
//当前页的数量
private int size;
//由于startRow和endRow不常⽤，这⾥说个具体的⽤法
//可以在页⾯中"显⽰startRow到endRow 共size条数据"
//当前页⾯第⼀个元素在数据库中的⾏号
private int startRow;
private int startRow;
/
/当前页⾯最后⼀个元素在数据库中的⾏号
private int endRow;
//总记录数
private long total;
//总页数
private int pages;
//结果集
private List<T> list;
//第⼀页
private int firstPage;
//前⼀页
private int prePage;
//下⼀页
private int nextPage;
//最后⼀页
private int lastPage;
//是否为第⼀页
private boolean isFirstPage =false;
//是否为最后⼀页
private boolean isLastPage =false;
//是否有前⼀页
private boolean hasPreviousPage =false;
/
/是否有下⼀页
private boolean hasNextPage =false;
//导航页码数
private int navigatePages;
//所有导航页号
private int[] navigatepageNums;
public PageInfo(){
}
/**
* 包装Page对象
*
* @param list
*/
public PageInfo(List<T> list){
this(list,8);
}
/**
* 包装Page对象
*
* @param list          page结果
* @param navigatePages 页码数量
*/
public PageInfo(List<T> list,int navigatePages){
if(list instanceof Page){
Page page =(Page) list;
this.pageNum = PageNum();
this.pageSize = PageSize();
this.pages = Pages();
this.list = page;
this.size = page.size();
//由于结果是>startRow的，所以实际的需要+1
if(this.size ==0){
this.startRow =0;
}else{
this.startRow = StartRow()+1;
//计算实际的endRow（最后⼀页的时候特殊）
}
this.navigatePages = navigatePages;
//计算导航页
calcNavigatepageNums();
//计算前后页，第⼀页，最后⼀页
calcPage();
//判断页⾯边界
judgePageBoudary();
}
}
/**
* 计算导航页
*/
private void calcNavigatepageNums(){
//当总页数⼩于或等于导航页码数时
if(pages <= navigatePages){
navigatepageNums =new int[pages];
for(int i =0; i < pages; i++){
navigatepageNums[i]= i +1;
}
}else{//当总页数⼤于导航页码数时
navigatepageNums =new int[navigatePages];
int startNum = pageNum - navigatePages /2;
int endNum = pageNum + navigatePages /2;
if(startNum <1){
startNum =1;
//(最前navigatePages页
for(int i =0; i < navigatePages; i++){
navigatepageNums[i]= startNum++;
}
}else if(endNum > pages){
endNum = pages;
//最后navigatePages页
for(int i = navigatePages -1; i >=0; i--){
navigatepageNums[i]= endNum--;
}
}else{
//所有中间页
for(int i =0; i < navigatePages; i++){
navigatepageNums[i]= startNum++;
}
}
}
}
/**
* 计算前后页，第⼀页，最后⼀页
*/
private void calcPage(){
if(navigatepageNums != null && navigatepageNums.length >0){            firstPage = navigatepageNums[0];
lastPage = navigatepageNums[navigatepageNums.length -1];
if(pageNum >1){
prePage = pageNum -1;
}
if(pageNum < pages){
nextPage = pageNum +1;
}
}
}
/**
* 判定页⾯边界

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。