【SpringBoot高级篇】SpringBoot集成MybatisPlus+PageHelper分页

简介

在项目中我们执行一个分页查询时，很多时候还会需要知道该查询的其他信息，如总数、每页数量、当前页数、上一页或下一页等等，这些信息如果每次都自己写的话就太麻烦了，而pagehelper能够帮助我们更方便地获取这些信息，大大方便了我们的开发效率。

pagehelper是mybatis的一个插件，其作用是更加方便地进行分页查询

SpringBoot集成PageHelper插件

框架	版本
spring-boot	2.2.2.RELEASE
mybatis-plus	3.5.2
pagehelper	1.3.0

pom

<parent>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-parentartifactId>
    <version>2.2.2.RELEASEversion>
    <relativePath/>
parent>
<dependencies>
    <dependency>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starter-jdbcartifactId>
    dependency>
    <dependency>
        <groupId>mysqlgroupId>
        <artifactId>mysql-connector-javaartifactId>
    dependency>

    <dependency>
        <groupId>com.baomidougroupId>
        <artifactId>mybatis-plus-boot-starterartifactId>
        <version>3.5.2version>
    dependency>
    <dependency>
        <groupId>com.github.pagehelpergroupId>
        <artifactId>pagehelper-spring-boot-starterartifactId>
        <version>1.3.0version>
    dependency>
dependencies>

yml配置

#pagehelper分页插件配置
pagehelper:
  helper-dialect: mysql  #设置数据库类型
  reasonable: true  #开启合理化：页码<=0 查询第一页，页码>=总页数查询最后一页
  support-methods-arguments: true  #支持通过 Mapper 接口参数来传递分页参数
  params: count=countsql

• helper-dialect：指定数据库，不指定的话会默认自动检测数据库类型
• reasonable：是否启用分页合理化。如果启用，当pagenum<1时，会自动查询第一页的数据，当pagenum>pages时，自动查询最后一页数据；不启用的，以上两种情况都会返回空数据
• support-methods-arguments：默认值false，分页插件会从查询方法的参数值中，自动根据上面 params 配置的字段中取值，查找到合适的值时就会自动分页。
• params：用于从对象中根据属性名取值， 可以配置 pageNum,pageSize,count,pageSizeZero,reasonable，不配置映射的用默认值， 默认值为pageNum=pageNum;pageSize=pageSize;count=countSql;reasonable=reasonable;pageSizeZero=pageSizeZero

StockMapper

这里使用Mybatis-Plus所以继承了通用的BaseMapper类

public interface StockMapper extends BaseMapper<Stock> {
    @Select(" select * from stock")
    List<Stock>  selectAll();
}

启动类

@MapperScan(basePackages = {"cn.zysheep.biz.mapper"})
@SpringBootApplication
public class FfsApplication {
    public static void main(String[] args) {
        SpringApplication.run(FfsApplication.class, args);
    }
}

测试类

@SpringBootTest(classes = FfsApplication.class)
@Slf4j
public class StockMapperTest {
    @Resource
    private StockMapper stockMapper;
    
	@Test
	public void selectAll() {
	    PageHelper.startPage(1,20);
	    List<Stock> stocks = stockMapper.selectAll();
	    PageInfo<Stock> stockPageInfo = new PageInfo<>(stocks);
	    log.info("当前页: {}",stockPageInfo.getPageNum());
	    log.info("每页的数量: {}",stockPageInfo.getPageSize());
	    log.info("当前页的数量: {}",stockPageInfo.getSize());
	    log.info("总记录数:{}",stockPageInfo.getTotal());
	    log.info("总页数:{}",stockPageInfo.getPages());
	    log.info("结果集: {}",stockPageInfo.getList());
	}
}

注意:
1、只有紧跟着PageHelper.startPage(pageNum,pageSize)的查询sql语句才被pagehelper起作用
2、PageInfo stockPageInfo = new PageInfo<>(stocks);传入的对象必须是分页查询后的对象。即紧跟PageHelper.startPage(pageNum,pageSize)的查询语句返回的集合对象。中间做数据转换可能导致数据不对

结论： 这三句要按顺序连在一起，分页数据对象PageInfo才会生效且正确。

PageHelper.startPage(1,20);
List<Stock> stocks = stockMapper.selectAll();
PageInfo<Stock> stockPageInfo = new PageInfo<>(stocks);