本文已参与「新人创作礼」活动,一起开启掘金创作之路。
PageHelper
第二篇文章看看Mybatis的分页查询功能!
在SpringBoot中使用PageHelper对Mybatis查询数据分页。
使用开源的PageHelper可以对查询进行分页,使用一下:
一、pom依赖
<!-- 分页查询插件启动器 -->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
<version>1.2.13</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
二、配置
package com.xing.config;
import com.github.pagehelper.PageHelper;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import java.util.Properties;
@Configuration
public class MybatisConfig {
@Bean
public PageHelper pageHelper(){
PageHelper pageHelper = new PageHelper();
/**
* helperDialect:分页插件会自动检测当前的数据库链接,自动选择合适的分页方式。
* 你可以配置helperDialect属性来指定分页插件使用哪种方言。配置时,可以使用下面的缩写值: oracle,mysql,mariadb,sqlite,hsqldb,postgresql,db2,sqlserver,informix,h2,sqlserver2012,derby
* 特别注意:使用 SqlServer2012 数据库时,需要手动指定为 sqlserver2012,否则会使用 SqlServer2005 的方式进行分页。
* params:为了支持startPage(Object params)方法,增加了该参数来配置参数映射,用于从对象中根据属性名取值,
* 可以配置 pageNum,pageSize,count,pageSizeZero,reasonable,
* 不配置映射的用默认值, 默认值为pageNum=pageNum;pageSize=pageSize;count=countSql;reasonable=reasonable;pageSizeZero=pageSizeZero。
* pageSizeZero:默认值为 false,当该参数设置为 true 时,如果 pageSize=0 或者 RowBounds.limit = 0 就会查询出全部的结果(相当于没有执行分页查询,但是返回结果仍然是 Page 类型)。
* supportMethodsArguments:支持通过 Mapper 接口参数来传递分页参数,默认值false,分页插件会从查询方法的参数值中,自动根据上面 params 配置的字段中取值,查找到合适的值时就会自动分页。
* 使用方法可以参考测试代码中的 com.github.pagehelper.test.basic 包下的 ArgumentsMapTest 和 ArgumentsObjTest。
* autoRuntimeDialect:默认值为 false。设置为 true 时,允许在运行时根据多数据源自动识别对应方言的分页 (不支持自动选择sqlserver2012,只能使用sqlserver)。
* closeConn:默认值为 true。当使用运行时动态数据源或没有设置 helperDialect 属性自动获取数据库类型时,会自动获取一个数据库连接,
* 通过该属性来设置是否关闭获取的这个连接,默认true关闭,设置为 false 后,不会关闭获取的连接,这个参数的设置要根据自己选择的数据源来决定
* offsetAsPageNum:默认值为 false,该参数对使用 RowBounds 作为分页参数时有效。当该参数设置为 true 时,会将 RowBounds 中的 offset 参数当成 pageNum 使用,可以用页码和页面大小两个参数进行分页。
* rowBoundsWithCount:默认值为false,该参数对使用 RowBounds 作为分页参数时有效。当该参数设置为true时,使用 RowBounds 分页会进行 count 查询。
* reasonable:分页合理化参数,默认值为false。当该参数设置为 true 时,pageNum<=0 时会查询第一页,pageNum>pages(超过总数时),会查询最后一页。默认false 时,直接根据参数进行查询。
*/
Properties p = new Properties();//添加配置,也可以指定文件路径
p.setProperty("offsetAsPageNum", "true");
p.setProperty("rowBoundsWithCount", "true");
p.setProperty("reasonable", "true");
pageHelper.setProperties(p);
return pageHelper;
}
}
也可以在application中配置:
#配置分页插件pagehelper
#pagehelper:
# helperDialect: mysql
# reasonable: true
# supportMethodsArguments: true
# params: count=countSql
三、使用
/**
* 获取全部
* @return user list
*/
@RequestMapping("/getAll/{num}")
public String getAll(@PathVariable int num){
if(StringUtils.isEmpty(num)){
num = 2;
}
PageHelper.startPage(1,num);
return userMapper.getAll().toString();
}
其实就是这句:PageHelper.startPage(1,num);
在想要分页的查询方法前加上这句,就可以实现分页,不过只支持挨着下一句的查询方法,其他的查询方法是不受影响的。
测试结果我就不贴了,可以自己测试一下哦!一些详细的说明也都在注释中了,具体的推荐可以去官网学习哈!
总结:
只是简单使用PageHelper来进行了分页,有兴趣的可以去搜下原理,也可以去github查看下源码。