引言

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分頁插件最新源碼解讀及使用

五、PageHelper 在實際項目中的應用

在實際項目中，PageHelper 可以與 Spring Boot、MyBatis 等框架無縫集成，極大地簡化了分頁查詢的開發工作。通過簡單的配置和調用，即可實現復雜的分頁邏輯，提高開發效率。

六、總結

PageHelper 是一款優秀的 MyBatis 分頁插件，它通過攔截 MyBatis 的查詢操作，自動添加分頁邏輯，簡化了分頁查詢的開發過程。本文詳細介紹了 PageHelper 的基本使用、配置參數、實現原理以及在實際項目中的應用，希望能夠幫助大家更好地理解和使用 PageHelper。