MyBatis分页插件

MyBatis支持通过插件来完成分页查询,而pagehelper是一个很好的第三方插件

依赖:

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

使用分页插件:

@Controller
public class UserController {

    @Autowired
    private UserDAO userDAO;

    @GetMapping("/users")
    @ResponseBody
    public List<UserDO> getAll() {
        // 设置当前页数为1,以及每页3条记录
        Page<UserDO> page = PageHelper.startPage(1, 3).doSelectPage(() -> userDAO.findAll());
        return page.getResult();
    }

}

这里结合lambda语法,在 doSelectPage方法执行MyBatis查询方法,返回 Page 对象。

PageHelper.startPage(1,3); 其中startPage

通过获取的 Page 对象,我们可以:

  • getResult() 获取分页数据
  • getPages() 获取总页数
  • getTotal() 获取总记录数
  • getPageNum() 获取当前页面数

一般我们都会额外封装一个通用的分页模型 Paging 用于处理返回值

public class Paging<R> implements Serializable {

    private static final long serialVersionUID = 522660448543880825L;
    /**
     * 页数
     */
    private int pageNum;

    /**
     * 每页数量
     */
    private int pageSize = 15;
    /**
     * 总页数
     */
    private int totalPage;

    /**
     * 总记录数
     */
    private long totalCount;

    /**
     * 集合数据
     */
    private List<R> data;

    public Paging() {

    }

    public Paging(int pageNum, int pageSize, int totalPage, long totalCount, List<R> data) {
        this.pageNum = pageNum;
        this.pageSize = pageSize;
        this.totalPage = totalPage;
        this.totalCount = totalCount;
        this.data = data;
    }

    // 省略 getter、setter

}