Mybatis分页插件PageHelper

PageHelper

pagehelper是mybatis 提供的分页插件，目前支持Oracle,Mysql,MariaDB,SQLite,Hsqldb,PostgreSQL六种数据库。

导入依赖

<!-- mybatis依赖 -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.6</version>
        </dependency>
<!-- mysql -->
        <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.18</version>
        </dependency>
<!-- pageHelper依赖 -->
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper</artifactId>
            <version>5.1.10</version>
        </dependency>

插件配置

<!--mybatis的插件配置-->
	<plugins>
		<!-- com.github.pagehelper为PageHelper类所在包名 -->
		<plugin interceptor="com.github.pagehelper.PageInterceptor">
			<!-- 表示使用mysql的分页方法 -->
			<property name="helperDialect" value="mysql" />
			<!-- 表示当页码长度为0 的时候,就不进行分页查询 -->
			<property name="pageSizeZero" value="true"/>
			<!-- 表示支持通过mapper接口参数来传递分页参数 -->
			<property name="supportMethodsArguments" value="true"/>
			<!-- 表示使用RowBounds分页会进行count查询 -->
			<property name="rowBoundsWithCount" value="true"/>
		</plugin>
	</plugins>

开始分页

service方法调用SQL查询前添加PageHelper.startPage(),进行分页对象初始化

// 分页对象初始化
PageHelper.startPage(pageDTO.getPageNum(), pageDTO.getPageSize());

这里有两个参数，分别为：page=1，rows=20。默认请求第一页，每页显示20条数据

先PageHelper.startPage(1, 10)开始分页，再selectlist查询数据库的时候会自动加上limit 1，10。

原理
首先是在Mybatis里面配置了分页拦截器（PageInterceptor），即在执行相关Sql之前会拦截做一点事情；

这里通过setLocalPage()方法，将分页信息保存在当前线程中。查询方法与之处于同一个线程中，共享ThreadLocal中的数据。

selectlist查询之后赋值给的List list。这个list是Page 类型。

再将list放到PageInfo<>中即可。

// 查询分页信息
List<BdDeptPageListVO> deptPageListVOList = bdDeptMapper.findByPage(bdDeptPageConvert.dto2Po(pageDTO));
// 返回分页查询分页信息
return new PageInfo<>(deptPageListVOList);

PageInfo里面的属性

 private int pageNum;//当前页码
 private int pageSize;//设置每页多少条数据
private int size;//当前页有多少条数据
private int startRow;//当前页码第一条数据的
private int endRow;//当前页码的开始条
private int pages;//当前页码结束条
private int prePage;//上一页（页面链接使用）
private int nextPage;//下一页（页面链接使用）
private boolean isFirstPage;//是否为第一页
private boolean isLastPage;//是否为最后一页
private boolean hasPreviousPage;//是否有前一页
private boolean hasNextPage;//是否有下一页
private int navigatePages;//导航页码数(就是总共有多少页)
private int[] navigatepageNums;//导航页码数(就是总共有多少页),可以用来遍历
private int navigateFirstPage;//首页号
private int navigateLastPage;//尾页号