八、PageHelper分页插件
1. 导入分页插件jar包
maven依赖配置
<!-- PageHelper -->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>5.1.2</version>
</dependency>
2. 配置分页插件
2.1 在MyBatis全局配置文件中配置拦截器插件
<!-- 分页插件 -->
<plugins>
<plugin interceptor="com.github.pagehelper.PageInterceptor">
</plugin>
</plugins>
2.2 配置插件属性
属性名称 | 默认值 | 描述 |
---|---|---|
helperDialect | 分页插件会自动检测当前的数据库链接,自动选择合适的分页方式你可以配置helperDialect属性来指定分页插件使用哪种方言。配置时,可以使用下面的缩写值:oracle,mysql,mariadb,sqlite,hsqldb,postgresql,db2,sqlserver,informix,h2,sqlserver2012,derby | |
offsetAsPageNum | false | 该参数对使用 RowBounds作为分页参数时有效当该参数设置为 true时,会将 RowBounds中的 offset参数当成 pageNum使用,可以用页码和页面大小两个参数进行分页 |
rowBoundsWithCount | false | 该参数对使用 RowBounds作为分页参数时有效当该参数设置为true时,使用 RowBounds分页会进行 count查询 |
pageSizeZero | false | 当该参数设置为 true时,如果 pageSize=0 或者 RowBounds.limit=0 就会查询出全部的结果,相当于没有执行分页查询,但是返回结果仍然是 Page类型 |
reasonable | false | 分页合理化参数启用合理化时,如果pageNum<1会查询第一页,如果pageNum>pages会查询最后一页禁用合理化时,如果pageNum<1或pageNum>pages会返回空数据 |
params | pageNum=pageNum; pageSize=pageSize; count=countSql; reasonable=reasonable; pageSizeZero=pageSizeZero | 为了支持startPage(Object params)方法,增加了该参数来配置参数映射,用于从对象中根据属性名取值, 可以配置 pageNum,pageSize,count,pageSizeZero,reasonable,不配置映射的用默认值 |
supportMethodsArguments | false | 支持通过 Mapper接口参数来传递分页参数分页插件会从查询方法的参数值中,自动根据上面 params配置的字段中取值,查找到合适的值时就会自动分页 |
autoRuntimeDialect | false | 设置为 true 时,允许在运行时根据多数据源自动识别对应方言的分页 |
closeConn | true | 当使用运行时动态数据源或没有设置 helperDialect属性自动获取数据库类型时,会自动获取一个数据库连接, 通过该属性来设置是否关闭获取的这个连接,默认true关闭,设置为 false后,不会关闭获取的连接,这个参数的设置要根据自己选择的数据源来决定 |
<!-- 分页插件 -->
<plugins>
<plugin interceptor="com.github.pagehelper.PageInterceptor">
<!-- 开启合理化分页-->
<property name="reasonable" value="true"/>
</plugin>
</plugins>
2.3 在程序中的使用
SqlSession session = MybatisUtil.openSession();
PersonMapper mapper = session.getMapper(PersonMapper.class);
//通过分页助手类,设置当前页数和每页条数
//startPage(当前页数, 每页条数)
PageHelper.startPage(1,5);
List<Person> list = mapper.findPerson();
for (Person person : list) {
System.out.println(person);
}
//分页信息对象
PageInfo<Person> info = new PageInfo<>(list);
System.out.println("当前页数:" + info.getPageNum());
System.out.println("每页条数:" + info.getPageSize());
System.out.println("总记录数:" + info.getTotal());
System.out.println("总页数:" + info.getPages());
System.out.println("上一页:" + info.getPrePage());
System.out.println("下一页:" + info.getNextPage());
System.out.println("是否为首页:" + info.isIsFirstPage());
System.out.println("是否为末页:" + info.isIsLastPage());
System.out.println("页数:" + Arrays.toString(info.getNavigatepageNums()));
session.close();
nds.limit=0 就会查询出全部的结果,相当于没有执行分页查询,但是返回结果仍然是 Page类型
reasonable | false | 分页合理化参数启用合理化时,如果pageNum<1会查询第一页,如果pageNum>pages会查询最后一页禁用合理化时,如果pageNum<1或pageNum>pages会返回空数据
params | pageNum=pageNum; pageSize=pageSize; count=countSql; reasonable=reasonable; pageSizeZero=pageSizeZero | 为了支持startPage(Object params)方法,增加了该参数来配置参数映射,用于从对象中根据属性名取值, 可以配置 pageNum,pageSize,count,pageSizeZero,reasonable,不配置映射的用默认值
supportMethodsArguments | false | 支持通过 Mapper接口参数来传递分页参数分页插件会从查询方法的参数值中,自动根据上面 params配置的字段中取值,查找到合适的值时就会自动分页
autoRuntimeDialect | false | 设置为 true 时,允许在运行时根据多数据源自动识别对应方言的分页
closeConn | true | 当使用运行时动态数据源或没有设置 helperDialect属性自动获取数据库类型时,会自动获取一个数据库连接, 通过该属性来设置是否关闭获取的这个连接,默认true关闭,设置为 false后,不会关闭获取的连接,这个参数的设置要根据自己选择的数据源来决定
```xml
<!-- 分页插件 -->
<plugins>
<plugin interceptor="com.github.pagehelper.PageInterceptor">
<!-- 开启合理化分页-->
<property name="reasonable" value="true"/>
</plugin>
</plugins>