4.1 MyBatis 分页插件

分页查询基本上是必备的能力，MyBaits 可以通过插件来很好的支持分页查询，目前最成熟的方案是pagehelper这个第三方插件。

我们只需要在工程的 pom.xml 里添加如下的依赖即可，目前最新的版本是1.2.13

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

pagehelper 非常易用，内部做了很多的优化工作，让开发者基本不需要额外处理 MyBatis XML 逻辑，我们通过代码来看一下，继续改造 UserController.getAll 方法

package com.youkeda.comment.control;

import com.github.pagehelper.Page;
import com.github.pagehelper.PageHelper;
import com.youkeda.comment.dao.UserDAO;
import com.youkeda.comment.dataobject.UserDO;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.format.annotation.DateTimeFormat;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;

import java.time.LocalDateTime;
import java.util.List;

@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();
    }

}

如上，我们使用PageHelper类来处理分页，它的完整包名是

com.github.pagehelper.PageHelper

我们结合 lambda 语法，在doSelectPage lambda 方法中执行 MyBatis 查询方法，就会自动执行分页逻辑，并且返回分页对象Page,我们在仔细看看方法调用的情况

PageHelper.startPage(1, 3);

startPage第一个参数是指定页数，第二个参数指定的是每页的记录数

MyBatis PageHelper 比较智能，如果查询第0页会自动转化为查询第一页（让开发者不纠结这个坐标值），如果查询的页数超过总页数也会自动查询最后一页。比如下面的调用和上面是一样的

PageHelper.startPage(0, 3);

返回类型Page对象是 MyBatis 封装的分页模型，通过这个我们可以得到

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

Page 的完整路径是 com.github.pagehelper.Page

在企业开发中，我们都会额外封装一个通用的分页模型Paging用于处理返回值，参考如下

以后我们再各种项目中可能会经常复用这个模型，就不再额外介绍啦

package com.youkeda.comment.model;

import java.io.Serializable;
import java.util.List;

/**
 * 分页模型
 */
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

}

Paging 模型比较简单，主要提供

• pageNum 当前页面数

• pageSize 每页记录数

• totalPage 总页面数

• totalCount 总记录数

• data 当前页面的集合数据 我们还提供了一个构造函数

  public Paging(int pageNum, int pageSize, int totalPage, long totalCount, List<R> data)
  

我们继续改造一下 UserController.getAll 方法

package com.youkeda.comment.control;

import com.github.pagehelper.Page;
import com.github.pagehelper.PageHelper;
import com.youkeda.comment.dao.UserDAO;
import com.youkeda.comment.dataobject.UserDO;
import com.youkeda.comment.model.Paging;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.format.annotation.DateTimeFormat;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;

import java.time.LocalDateTime;
import java.util.List;

@Controller
public class UserController {

    @Autowired
    private UserDAO userDAO;

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

        return new Paging<>(page.getPageNum(), page.getPageSize(), page.getPages(), page.getTotal(), page
                .getResult());
    }
}