MyBatis分页插件

说明：控制内容分页展示，是我们经常需要做的事情。追根到底，是通过SQL语句中的limit关键字，根据传入的参数（当前页码、每页显示条数）来控制返回的当前页的内容范围。

核心的SQL语句如下：

select * from 表名 limit (当前页码 - 1) * 每页显示记录条数, 每页显示记录条数;
1

具体实现，可以手动实现，或者使用pagehelper分页插件

以我数据库中的tb_stu（学生表）为例，实现对学生信息分页显示

一、准备工作

首先，准备好Student类

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.time.LocalDate;

/**
 * 学生类
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Student {
    private Integer id;
    private String name;
    private String gender;
    private Integer age;
    private LocalDate createTime;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

其次，为了方便把当前页的内容返回给前端，我们需要把当前页的内容封装成一个PageBean对象，该对象应该有两个属性：一个是当前页的内容，即当前页的对象集合；一个是该记录的总条数，方便前端计算总页数并显示。

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.util.List;

/**
 * 页面实体类
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
public class PageBean {

    /**
     * 当前页的内容，学生对象集合
     */
    private List<Student> rows;

    /**
     * 记录总条数
     */
    private long total;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

二、手动实现

前面分析过了，分页需要查找当前页的内容和记录总条数，所以我们需要在Mapper里面写两个方法，分别对应查找当前页的内容和记录总条数。

---

StuMapper类相关代码

import com.essay.domain.Student;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;

import java.util.List;

@Mapper
public interface StuMapper {

    /**
     * 查找指定范围的记录
     * @param begin 开始位置
     * @param pageSize 开始位置 + pageSize
     * @return 学生集合
     */
    @Select("select * from tb_stu limit #{begin},#{pageSize}")
    List<Student> findStuPageManual(Integer begin, Integer pageSize);

    /**
     * 查找记录总条数
     * @return 总条数
     */
    @Select("select count(*) from tb_stu")
    Long findCount();
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

---

测试类相关代码，page（当前页码），pageSize（每页显示条数）为前端传的参数，我这里手动设置，模拟前端传参

    @Autowired
    private StuMapper stuMapper;

    /**
     * 实现分页查询学生数据业务（手动）
     */
    @Test
    public void findStuPageManual() {
        // 模拟当前页为第2页
        Integer page = 2;

        // 每页显示5条
        Integer pageSize = 5;

        // 1.获取查询记录开始位置
        Integer begin = (page - 1) * pageSize;

        // 2.查询当前页所有对象
        List<Student> list = stuMapper.findStuPageManual(begin,pageSize);

        // 3.查询记录总条数
        Long total = stuMapper.findCount();

        // 4.当前页对象（当前页所有对象，记录总条数）
        PageBean pageBean = new PageBean(list, total);

        // 5.展示第二页的内容
        System.out.println("pageBean.getTotal() = " + pageBean.getTotal());

        for (Student row : pageBean.getRows()) {
            System.out.println("row = " + row);
        }
    }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

---

启动，可以看到，程序结果显示出了第2页的内容，达到了预期结果

三、分页插件

可以使用pagehelper插件实现分页，非常方便

第一步：添加依赖

使用插件，先添加依赖，依赖可在官网（https://pagehelper.github.io/docs/howtouse/）复制，版本使用1.4.2

---

---

        <!--分页插件依赖-->
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper-spring-boot-starter</artifactId>
            <version>1.4.2</version>
        </dependency>
1
2
3
4
5
6

第二步：分析

查看pagehelper插件官网提供的重要提示，只有紧跟PageHelper.startPage方法后的第一个查询方法会被分页

---

查看官网提供的使用例子，显然，PageHepler.startPage()方法中的两个参数，分别是页码（page）、每页显示条数（pageSize）

其次，查询结果需要强制转换为Page类型

第三步：在代码中使用

模拟当前传入的页码为2，每页显示条数为4，查看结果

    @Autowired
    private StuMapper stuMapper;
    
    /**
     * 实现分页查询学生数据业务（插件）
     *
     */
    @Test
    public void findStuPageAuto() {
        // 模拟当前页为第2页
        Integer page = 2;

        // 每页显示4条
        Integer pageSize = 4;

        // 1.使用插件
        PageHelper.startPage(page, pageSize);

        // 2.后面跟需要分页的查询语句
        List<Student> list = stuMapper.findStuPageAuto();

        // 3.将结果强制转换为Page类型
        Page pg = (Page) list;

        // 4.将Page内容取出来，pg.getResult()是当前页的内容，pg.getTotal()是查询的所有记录数
        PageBean pageBean = new PageBean(pg.getResult(),pg.getTotal());

        // 5.展示第二页的内容
        System.out.println("pageBean.getTotal() = " + pageBean.getTotal());

        for (Student row : pageBean.getRows()) {
            System.out.println("row = " + row);
        }
    }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

StuMapper类相关代码

    @Select("select * from tb_stu")
    List<Student> findStuPageAuto();
1
2

结果可以看到，实现了分页，仅显示第2页的内容，每页4条记录

---

需要注意的是，查看SQL日志，可以看到分页插件的实现也是使用limit关键字，所以千万不要再StuMapper对应的select查询语句后面加分号（;），因为分号表示SQL语句结束，此时插件再在后面附加limit限制语句就会报错。

另外，在项目中经常会用到SQL语句的拼接，所以建议在项目的任何地方写SQL语句，末尾都不要加分号（;），不加分号不会报错，加了分号就存在报错的可能，不加比加好

之前讲过，Mapper.xml文件中定义SQL语句片段，里面的SQL语句也不能加分号，否则后面引用语句的方法都会报错

总结

手动实现和插件实现都可以，推荐使用插件实现。相较于插件，手动实现有以下不便之处：

（1）手动实现需要写两个查询方法，一个查询限制范围的内容，一个查询总记录数；

（2）如果是在条件查找的基础上再做分页，修改代码，手动实现也需要修改两个地方；