PageHelper详解：使用方法与注意事项

一、PageHelper简介

PageHelper是MyBatis框架的一个强大分页插件，用于简化数据库分页查询操作。它通过拦截SQL执行过程并自动添加分页语句，使开发者可以不必手写复杂的分页SQL，从而大大提高了开发效率。

核心特点

支持多种数据库（MySQL、Oracle、PostgreSQL等）自动识别数据库方言，生成对应的分页语句支持多种分页方式（如静态分页、动态分页）支持连续分页查询（如"上一页"、“下一页”）可自定义分页参数和结果处理

二、基本使用方法

2.1 引入依赖

在Maven项目中添加PageHelper依赖：

com.github.pagehelper

pagehelper-spring-boot-starter

1.4.6

2.2 基础配置（Spring Boot）

在application.properties或application.yml中配置PageHelper：

# PageHelper配置

pagehelper:

helper-dialect: mysql # 指定数据库方言

reasonable: true # 开启合理化，页码小于1查询第一页，大于总页数查询最后一页

support-methods-arguments: true # 支持通过Mapper接口参数传递分页参数

page-size-zero: true # pageSize为0时查询所有记录，相当于没有分页

params: count=countSql # 用于从对象中根据属性名取值

2.3 基本使用

方式一：使用startPage静态方法

@RestController

@RequestMapping("/users")

public class UserController {

@Autowired

private UserService userService;

@GetMapping

public PageInfo getUsers(@RequestParam(defaultValue = "1") int pageNum,

@RequestParam(defaultValue = "10") int pageSize) {

// 开始分页，只对之后的第一个查询有效

PageHelper.startPage(pageNum, pageSize);

// 执行查询

List users = userService.getAllUsers();

// 封装分页结果

return new PageInfo<>(users);

}

}

方式二：使用Page对象

@GetMapping("/page")

public PageInfo getUsersByPage() {

// 创建Page对象，构造方法中传入页码和每页记录数

Page page = new Page<>(1, 10);

// 使用page对象查询

page = userService.getUserByPage(page);

// 转换为PageInfo对象返回

return new PageInfo<>(page);

}

方式三：分页参数自动获取（针对Spring MVC）

// 在Mapper接口方法中添加Page参数

public interface UserMapper {

List findAll(Page page);

}

// 在Controller中

@GetMapping("/auto")

public PageInfo getUsersAuto(@RequestParam(defaultValue = "1") int pageNum,

@RequestParam(defaultValue = "10") int pageSize) {

// 直接构造Page对象传给Mapper

Page page = new Page<>(pageNum, pageSize);

List users = userMapper.findAll(page);

return new PageInfo<>(users);

}

2.4 PageInfo对象

PageInfo是PageHelper提供的用于封装分页结果的对象，包含完整的分页信息：

PageInfo pageInfo = new PageInfo<>(users);

// 页码相关信息

int pageNum = pageInfo.getPageNum(); // 当前页码

int pageSize = pageInfo.getPageSize(); // 每页记录数

int pages = pageInfo.getPages(); // 总页数

long total = pageInfo.getTotal(); // 总记录数

// 导航页相关信息

int[] navigatepageNums = pageInfo.getNavigatepageNums(); // 导航页码数组

int navigatePages = pageInfo.getNavigatePages(); // 导航页码数量

// 页面状态

boolean isFirstPage = pageInfo.isIsFirstPage(); // 是否是第一页

boolean isLastPage = pageInfo.isIsLastPage(); // 是否是最后一页

boolean hasPreviousPage = pageInfo.isHasPreviousPage(); // 是否有前一页

boolean hasNextPage = pageInfo.isHasNextPage(); // 是否有下一页

// 数据

List list = pageInfo.getList(); // 当前页数据列表

三、高级用法

3.1 排序查询

// 按id降序排列

PageHelper.startPage(1, 10).orderBy("id desc");

List users = userService.getAllUsers();

// 多字段排序

PageHelper.startPage(1, 10).orderBy("age desc, create_time asc");

List users = userService.getAllUsers();

3.2 count查询优化

// 禁用count查询，适用于不需要总记录数的场景

PageHelper.startPage(1, 10, false);

List users = userService.getAllUsers();

// 自定义count查询SQL

PageHelper.startPage(1, 10).doSelectPageInfo(() -> userService.getAllUsers());

3.3 分页参数设置

// 设置导航页码数量

PageInfo pageInfo = new PageInfo<>(users, 5); // 显示5个导航页码

// 使用默认的每页记录数

Page