轻而易举地使用 Spring Boot 2.x 集成 PageHelper 分页插件，提升项目开发效率！

2024-02-08 11:39:39

Spring Boot 集成 PageHelper 分页插件入门指南

在 Spring Boot 项目中集成 PageHelper 分页插件十分便捷，仅需以下三步即可快速实现数据分页查询，提升项目开发效率和性能。

1. 导入 Maven 依赖

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

2. 参数配置

在 application.properties 文件中配置 PageHelper 分页插件的默认参数：

# 开启合理化查询
pagehelper.reasonable=true
# 支持通过 Mapper 接口参数来传递分页参数
pagehelper.supportMethodsArguments=true
# 默认分页参数为1，默认每页10条记录
pagehelper.params=pageNum=1,pageSize=10

3. 快速使用

在需要使用分页查询的地方，只需在需要分页的 SQL 查询语句中使用 PageHelper.startPage() 和 PageHelper.endPage() 方法即可。例如：

// 开始分页，每页10条记录
PageHelper.startPage(pageNum, pageSize);
// 查询数据
List<User> users = userDao.selectAll();
// 结束分页
PageHelper.endPage();

分页查询结果可以通过 Page 对象获取，它提供了丰富的分页信息，包括总记录数、总页数、当前页码、当前页记录数等。

4. 响应数据

在控制器方法中，可以使用 Page 객체直接返回分页查询结果。框架会自动将 Page 对象转换成 JSON 格式返回给前端。例如：

@GetMapping("/users")
public Page<User> getAllUsers(Integer pageNum, Integer pageSize) {
    // 开始分页
    PageHelper.startPage(pageNum, pageSize);
    // 查询数据
    List<User> users = userDao.selectAll();
    // 结束分页
    PageHelper.endPage();
    return Page<User>(users);
}