Spring Boot 分页插件PageHelper

我会带着你远行 2023-01-21 02:29 2阅读 0赞

第一步：在使用PageHelper分页插件前，我们需要引入Spring Boot与PageHelper整合的依赖

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

在上述依赖包里面包含了下述依赖，实际做分页操作时也是引用的是下述PageHelper类

<dependency>
        <groupId>com.github.pagehelper</groupId>
        <artifactId>pagehelper</artifactId>
    </dependency>

第二步：接着我们需要在yml配置需要先配置mybatis扫描到mapper.xml文件和配置文件的路径

mybatis:
      type-handlers-package: com.*.model.entity
      mapper-locations: classpath:mappers/*.xml
      config-location: classpath:mybatis-config.xml
    
    #配置分页插件pagehelper
    pagehelper:
      #heleperDialect表示配置PageHelper的方言，一般取值为mysql、oracle
      helperDialect: mysql
      #reasonable表示分页合理化参数，其取值默认为false，会直接根据分页参数（PageNum、PageSize）进行查询。当该参数设置为true时，pageNum小于等于0时会查询第一页，pageNum>pages（超过总数时），会查询最后一页
      reasonable: true
      #supportMethodsArguments表示PageHelper是否支持根据mapper方法的入参对象（queryModel）的pageNum、pageSize 来分析是否进行自动分页，默认为false（推荐配置），为true的情况下一不留神会给自己带来坑，除非我们的入参对象（queryModel）中不含这两个字段
      supportMethodsArguments: false
      #为了支持PageHelper的startPage(Object params)方法，增加了该参数来配置参数映射，用于从对象中根据属性名取值， 可以配置 pageNum,pageSize,count,pageSizeZero,reasonable，不配置映射的用默认值， 默认值为pageNum=pageNum;pageSize=pageSize;count=countSql;reasonable=reasonable;pageSizeZero=pageSizeZero。  
      params: count=countSql

引入mybatis与Spring Boot整合的依赖也是必须的，鉴于非重点，这里就不做展示

第三步：构建mapper接口类和mapper.xml

import org.apache.ibatis.annotations.Mapper;
    import org.springframework.stereotype.Component;
    
    import java.util.List;
    
    @Mapper
    @Component
    public interface TbQuarantinePermitSmsMapper {
    
        List<TbQuarantinePermitSmsInfoVo> page(TbQuarantinePermitSmsModel model);
    }

<?xml version="1.0" encoding="UTF-8" ?>
    <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
    <mapper namespace="com.*.orm.mapper.TbQuarantinePermitSmsMapper" >
    
        <select id="page" resultType="com.*.model.vo.TbQuarantinePermitSmsInfoVo" parameterType="com.*.model.dto.TbQuarantinePermitSmsModel">
            select * from tb_quarantine_permit_sms tb
        </select>
    
    </mapper>

第四步：在Service实现类中使用PageHelper组件进行分页操作

import com.github.pagehelper.PageHelper;
    import com.github.pagehelper.PageInfo;
    
    @Service
    public class TbQuarantinePermitSmsServiceImpl implements ITbQuarantinePermitSmsService {
        
        @Autowired
        private TbQuarantinePermitSmsMapper quarantinePermitSmsMapper;
    
        @Override
        public PageInfo<TbQuarantinePermitSmsInfoVo> page(PageRequest pageRequest) {
            //1.分页显示第几页这页显示多少条数据
            PageHelper.startPage(pageRequest.getPageNo(), pageRequest.getPageSize());
            //2.分页要显示的所有信息
            List<TbQuarantinePermitSmsInfoVo> list=quarantinePermitSmsMapper.page(tbQuarantinePermitSmsModel);
            //3.将所有信息注入到PageInfo中
            PageInfo<TbQuarantinePermitSmsInfoVo> page = new PageInfo(list);
            return page;
        }
    }

**特别提示**：

1.PageHelper.startPage(m,n)，只对最近的一次查询有效，在此方法后面的第一个mybaits查询语句就会按照这个进行分页

2.PageHelper.startPage(page, rows)的代码位置必须在mapper查询方法的前面，如果在后面则分页查询不会生效

3.需要将查询结果list注入到PageInfo中

**pagehelper中的supportMethodsArguments参数配置扩展：**

1.如果supportMethodsArguments的配置为不启用，这样分页的方法中必须调用PageHelper.startPage方法

2.如果supportMethodsArguments的配置为启用，那么在入参对象中尽量不要创建pageNum和pageSize这两个变量