> 文章列表 > PageHelper的使用

PageHelper的使用

PageHelper的使用

这个分页插件是在Mybatis的环境中使用的,所以项目需要导入Mybatis依赖
更加详细的用法看官方文档:PageHelper官网

在Mybatis中使用

前提条件

  1. 引入依赖
<dependency><groupId>com.github.pagehelper</groupId><artifactId>pagehelper</artifactId><version>5.3.2</version>
</dependency>
  1. 在MyBatis中配置拦截器插件,在MyBatis的配置文件中添加如下内容:
<plugins><!--设置分页插件--><plugin interceptor="com.github.pagehelper.PageInterceptor"/>
</plugins>

如何使用

在你需要进行分页的 MyBatis 查询方法前调用 PageHelper.startPage 静态方法即可,紧跟在这个方法后的第一个MyBatis 查询方法会被进行分页。

	SqlSession sqlssion = MyBatisUtils.getSqlssion();  UserMapper mapper = sqlssion.getMapper(UserMapper.class);  PageHelper.startPage(1, 1);  List<User> aLlUsers = mapper.getALlUsers();  aLlUsers.forEach(System.out::println);

此方法的两个参数:

PageHelper.startPage(pageNum, pageSize);// pageNum 页码// pageSize 页面大小

未开启前:
PageHelper的使用
开启后的结果集:
PageHelper的使用

除了静态方法PageHelper.startPage()外,还有一个类似的静态方法PageHelper.offsetPage()

分页信息

Page对象

当开启分页后,会返回一个Page对象,这个对象中包含了分页信息

SqlSession sqlssion = MyBatisUtils.getSqlssion();  
UserMapper mapper = sqlssion.getMapper(UserMapper.class);  
Page<User> pages = PageHelper.startPage(1, 1);  
List<User> aLlUsers = mapper.getALlUsers();  
aLlUsers.forEach(System.out::println);  
System.out.println(pages);

这个Page对象中包含这些信息:

Page{count=true, // pageNum=1, // 页码pageSize=1, // 页面大小startRow=0, // 当前页的数据的起始编号endRow=1, // 当前页数据的结束编号total=2, // 所有记录条数pages=2, // 所有的页数量reasonable=false, pageSizeZero=false
}
// 当前页的数据
[User(id=55, username=liumingkai, password=liumingkai, age=18, sex=男, email=2222@llll.com, deleted=0)
]

PageInfo对象

PageInfo对象可以用来封装分页数据,对结果进行包装,只需要将结果集传递给PageInfo对象就好了。
此对象中的分页信息更加详细,PageInfo中包含了Page对象。

SqlSession sqlssion = MyBatisUtils.getSqlssion();  
UserMapper mapper = sqlssion.getMapper(UserMapper.class);  
// 开启分页  
PageHelper.startPage(1, 1);  
List<User> aLlUsers = mapper.getALlUsers();  
// 对结果集封装  
PageInfo<User> pageInfo = new PageInfo<>(aLlUsers);  
System.out.println(pageInfo);

来看一下这个对象的信息

PageInfo{pageNum=1, // 当前页码pageSize=1, // 页面大小size=1, // 当前页面的容量startRow=1, // 当前页的起始数据的编号endRow=1, // 当前页最后一条数据的编号total=2, // 总共有多少条数据pages=2, // 总共有多少页list=Page{// page对象的信息count=true, pageNum=1, pageSize=1, startRow=0, endRow=1, total=2, pages=2, reasonable=false, pageSizeZero=false}// 分页数据[User(id=55, username=liumingkai, password=liumingkai, age=18, sex=, email=2222@llll.com, deleted=0)], prePage=0, // 前一页的页码nextPage=2, // 下一页的页码isFirstPage=true, // 是否是第一页isLastPage=false, // 是否是最后一页hasPreviousPage=false, // 是否有前一页hasNextPage=true, // 是否有下一页navigatePages=8, // 分页导航的页数量navigateFirstPage=1, // 分页导航的第一页页码navigateLastPage=2, // 分页导航的最后一页的页码navigatepageNums=[1, 2]}// 当前的分页导航的页码

Spring中整合

在SSM整合中,分页插件的用法是一样的,只不过配置方式是不同的。
前提是项目中已经成功整合了Mybatis(需要导入Mybatis-spring的整合依赖)
同样还需要导入PageHelper的依赖

将拦截器配置为SqlSessionFactory的属性,在Spring的配置文件中:

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">  <!-- 注意其他配置 -->  <property name="plugins">  <array>  <bean class="com.github.pagehelper.PageInterceptor">  <property name="properties"> <!--使用下面的方式配置参数,一行配置一个 -->  <value>params=value1</value>  </property>  </bean>  </array>  </property>  
</bean>

一般我们不需要配置参数,使用默认的PageHelper进行分页就可以

<bean class="org.mybatis.spring.SqlSessionFactoryBean">  <property name="dataSource" ref="dataSource"/>  <property name="typeAliasesPackage" value="com.liumingkai.domain"/>  <property name="plugins">  <array>  <bean class="com.github.pagehelper.PageInterceptor"/>  </array>  </property>  
</bean>

如果使用纯注解开发,只需要在SqlSessionFactoryBean的配置中注入依赖即可

SpringBoot中整合

PageHelper 的使用都是一样的,只不过配置方式是不同的
导入依赖

<dependency><groupId>com.github.pagehelper</groupId><artifactId>pagehelper-spring-boot-starter</artifactId><version>1.3.1</version>
</dependency>

配置文件

pagehelper:autoRuntimeDialect: truereasonable: truesupportMethodsArguments: trueparams: count=countSql