PageHelper (Dynamic-SQL2 0.1.6 API)

java.lang.Object
- com.dynamic.sql.plugins.pagination.PageHelper

```
public class PageHelper
extends Object
```
PageHelper 用于处理不同类型的数据分页逻辑的辅助类。
提供多种分页方式，适用于不同场景：
- of(int, int)：通用分页逻辑，基于 Dynamic-SQL2 插件
- ofMybatis(int, int)：MyBatis 分页逻辑（需要加载扩展包 dynamic-sql2-extension）
- ofCollection(int, int)：集合类型分页逻辑（已废弃）
- ofMap(int, int)：Map 类型分页逻辑（已废弃）
- ofLogic(int, int)：逻辑分页，基于内存集合的分页，不依赖数据库插件

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`PageHelper.CollectionPageHelper`
`static class`	`PageHelper.GeneralPageHelper`
`static class`	`PageHelper.LogicPageHelper` 逻辑分页工具类，用于对集合进行内存分页。
`static class`	`PageHelper.MapPageHelper`

方法概要

所有方法静态方法具体方法已过时的方法
限定符和类型	方法和说明
`static PageHelper.GeneralPageHelper`	`of(int pageIndex, int pageSize)` 创建一个通用的 GeneralPageHelper 实例，指定页码和页大小。
`static PageHelper.CollectionPageHelper`	`ofCollection(int pageIndex, int pageSize)` 已过时。
`static PageHelper.LogicPageHelper`	`ofLogic(int pageIndex, int pageSize)` 创建一个 LogicPageHelper 实例，指定页码和页大小。
`static PageHelper.MapPageHelper`	`ofMap(int pageIndex, int pageSize)` 已过时。
`static PageHelper.GeneralPageHelper`	`ofMybatis(int pageIndex, int pageSize)` 创建一个用于 MyBatis 分页插件的分页实例。

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - of
```
public static PageHelper.GeneralPageHelper of(int pageIndex,
                                              int pageSize)
```
    创建一个通用的 GeneralPageHelper 实例，指定页码和页大小。
    
    参数:
    
    pageIndex - 要获取的页码（如果小于等于0，则页码默认为1）
    
    pageSize - 每页的大小（每页的项目数量）
    
    返回:
    
    GeneralPageHelper 实例，用于通用的分页处理
    
    抛出:
    
    IllegalArgumentException - 如果 pageSize 小于等于0
  - ofMybatis
```
public static PageHelper.GeneralPageHelper ofMybatis(int pageIndex,
                                                     int pageSize)
```
    创建一个用于 MyBatis 分页插件的分页实例。
    注意：调用此方法需要额外加载扩展包：
```
 
 <dependency>
     <groupId>com.dynamic-sql</groupId>
     <artifactId>dynamic-sql2-extension</artifactId>
     <version>版本号</version>
 </dependency>
 
```
    参数:
    
    pageIndex - 页码，从 1 开始（若小于等于 0 则默认为 1）
    
    pageSize - 每页大小（必须大于 0）
    
    返回:
    
    配置完成的 PageHelper.GeneralPageHelper 实例
    
    抛出:
    
    IllegalArgumentException - 如果 pageSize 小于等于 0
  - ofLogic
```
public static PageHelper.LogicPageHelper ofLogic(int pageIndex,
                                                 int pageSize)
```
    创建一个 LogicPageHelper 实例，指定页码和页大小。
    LogicPageHelper 用于对集合进行内存分页，不依赖数据库插件。
    
    参数:
    
    pageIndex - 页码（从 1 开始，若小于等于 0 则默认为 1）
    
    pageSize - 每页大小（必须大于 0）
    
    返回:
    
    LogicPageHelper 实例，用于集合的逻辑分页处理
    
    抛出:
    
    IllegalArgumentException - 如果 pageSize 小于等于 0
  - ofCollection
```
@Deprecated
public static PageHelper.CollectionPageHelper ofCollection(int pageIndex,
                                                                       int pageSize)
```
    已过时。
    
    创建一个 CollectionPageHelper 实例，指定页码和页大小。针对处理集合类型的分页。
    
    参数:
    
    pageIndex - 要获取的页码（如果小于等于0，则页码默认为1）
    
    pageSize - 每页的大小（每页的项目数量）
    
    返回:
    
    CollectionPageHelper 实例，用于集合的分页处理
    
    抛出:
    
    IllegalArgumentException - 如果 pageSize 小于等于0
  - ofMap
```
@Deprecated
public static PageHelper.MapPageHelper ofMap(int pageIndex,
                                                         int pageSize)
```
    已过时。
    
    创建一个 MapPageHelper 实例，指定页码和页大小。针对处理 Map 类型的分页。
    
    参数:
    
    pageIndex - 要获取的页码（如果小于等于0，则页码默认为1）
    
    pageSize - 每页的大小（每页的项目数量）
    
    返回:
    
    MapPageHelper 实例，用于 Map 的分页处理
    
    抛出:
    
    IllegalArgumentException - 如果 pageSize 小于等于0

类 PageHelper

嵌套类概要

方法概要

从类继承的方法 java.lang.Object

方法详细资料

of

ofMybatis

ofLogic

ofCollection

ofMap