Mybatis分页插件PageHelper使用-蒲公英云

Mybatis分页插件PageHelper使用

PageHelper原理：

PageHelper方法使用了静态的ThreadLocal参数，分页参数和线程是绑定的。内部流程是ThreadLocal中设置了分页参数（pageIndex，pageSize），之后在查询执行的时候，获取当前线程中的分页参数，执行查询的时候通过拦截器在sql语句中添加分页参数，之后实现分页查询，查询结束后在 finally 语句中清除ThreadLocal中的查询参数。

通俗地讲，就是

PageHelper.startPage(int pageNum, int pageSize)相当于开启分页，通过拦截 MySQL 的方式，把查询语句拦截下来加 limit.

所以，该语句应该放在查询语句之前。

因此，整个过程应该是，前端会传过来pageNum和pageSize这两个参数，当点击前端的下一页按钮的时候，这个pageNum会加1，然后重新传到后端，调用后端的接口。后端拿到pageNum和pageSize之后，利用PageHelper.startPage设置分页，这样，在后面的sql语句中不用加 limit了。

注意：只要保证在PageHelper方法调用后紧跟 MyBatis 查询方法，这就是安全的。因为PageHelper在finally代码段中自动清除了ThreadLocal存储的对象。

在代码中使用例子：

1.引入maven依赖

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

2.配置文件application.yml

# 分页配置
pagehelper:
  helper-dialect: mysql
  reasonable: true
  support-methods-arguments: true
  params: count=countSql

3.使用

FtUserEntity.java

@Data
@TableName("ft_user")
public class FtUserEntity implements Serializable {
    private static final long serialVersionUID = 565759124424203805L;
    /**
     * 主键id
     */
    @TableId(type = IdType.AUTO)
    private Integer id;
    /**
     * 用户名称
     */
    private String name;
    /**
     * 用户年龄
     */
    private Integer age;
    /**
     * 用户手机号
     */
    private String phone;
    /**
     * 创建时间
     */
    private Date createTime;
    /**
     * 更新时间
     */
    private Date updateTime;
}

UserDao.xml

select * from ft_user

UserService.java

public interface FtUserService extends IService<FtUserEntity> {
    List<FtUserEntity> selectAll();
}

UserController.java

public PageInfo<FtUserEntity> selectAll(@RequestParam(value = "pageCount",defaultValue = "1",required = false)int pageCount,
                                        @RequestParam(value = "pageSize",defaultValue = "10",required = false)int pageSize){
        PageHelper.startPage(pageCount,pageSize);
        try {
            List<FtUserEntity> ftUserEntityList = ftUserService.selectAll();
            PageInfo<FtUserEntity> pageInfo = new PageInfo<>(ftUserEntityList);
            log.info("数据总条数:{}",pageInfo.getTotal());
            return pageInfo;
        } finally {
            PageHelper.clearPage();
        }
    }