MyBatis 分页插件 PageHelper 简介

引言

PageHelper 是一款优秀的开源免费 MyBatis 分页插件，它极大地简化了分页查询的复杂性，支持多种主流数据库如 MySQL、Oracle、MariaDB、DB2 等。本文将详细介绍 PageHelper 的基本使用、配置参数、实现原理以及实际项目中的应用。

一、PageHelper 简介

PageHelper 作为一个 MyBatis 的分页插件，通过拦截 MyBatis 的查询操作，自动在 SQL 语句后添加分页逻辑，从而实现了物理分页。使用 PageHelper 可以避免手写复杂的分页 SQL 语句，简化开发过程，提高开发效率。

PageHelper 开源仓库：https://github.com/pagehelper/Mybatis-PageHelper

二、PageHelper 的基本使用

1. 引入依赖

Maven 项目中引入 PageHelper 示例：

<dependency>  <groupId>com.github.pagehelper</groupId>  <artifactId>pagehelper</artifactId>  <version>5.1.10</version> <!-- 请根据实际需要选择合适的版本 -->  
</dependency>

2. 配置

application.yml 文件中配置 PageHelper 的参数示例：

pagehelper:  helperDialect: mysql  reasonable: true  supportMethodsArguments: true  params: pageNum=pageNum;pageSize=pageSize;

3. 使用

PageHelper 的使用非常简单，只需在 MyBatis 的查询方法前调用 PageHelper.startPage 方法即可。以下是一个简单的使用示例：

public PageInfo<ResponseEntityDto> page(RequestParamDto param) {// 设置分页参数  PageHelper.startPage(param.getPageNum(), param.getPageSize());// 紧跟在startPage方法后的第一个Mybatis查询会被分页List<ResoinseEntityDto> list = mapper.selectByExample(param);// 使用PageInfo包装查询后的结果  PageInfo<ResponseEntityDto> pageInfo = (PageInfo<ResponseEntityDto>)list;// 返回分页信息 return pageInfo;
}

注意：PageHelper.startPage 方法必须紧跟在需要进行分页的查询方法之前，否则不会生效。
在集合查询前使用PageHelper.startPage(pageNum,pageSize),并且中间不能穿插执行其他SQL

三、PageHelper 的配置参数

PageHelper 提供了丰富的配置参数，以满足不同的分页需求。以下是一些常用的配置参数：

helperDialect：指定数据库类型，PageHelper 会自动检测，但也可以手动指定。
reasonable：分页合理化参数，默认为 false。当设置为 true 时，如果 pageNum<=0 会查询第一页，如果 pageNum>pages 会查询最后一页。
supportMethodsArguments：支持通过 Mapper 接口参数来传递分页参数，默认为 false。
params：为了支持 startPage(Object params) 方法，增加了该参数来配置参数映射。

四、PageHelper 的实现原理

PageHelper 的实现原理基于 MyBatis 的插件机制，通过实现 MyBatis 的 Interceptor 接口，在 MyBatis 的查询方法执行前进行拦截，并动态地修改 SQL 语句，添加分页逻辑。PageHelper 会在 SQL 语句后添加 LIMIT 语句（或其他数据库的等效分页语句），从而实现物理分页。
具体实现原理可以参考：PageHelper分页插件最新源码解读及使用