com.github.pagehelper

类 PageHelper

java.lang.Object

com.github.pagehelper.page.PageMethod

com.github.pagehelper.PageHelper

所有已实现的接口:

BoundSqlInterceptor.Chain, Dialect

public class PageHelper
extends PageMethod
implements Dialect, BoundSqlInterceptor.Chain

Mybatis - 通用分页拦截器
项目地址 : http://git.oschina.net/free/Mybatis_PageHelper

版本:

5.0.0

作者:

liuzh/abel533/isea533

字段概要

从类继承的字段 com.github.pagehelper.page.PageMethod

DEFAULT_COUNT, LOCAL_PAGE

从接口继承的字段 com.github.pagehelper.BoundSqlInterceptor.Chain

DO_NOTHING

构造器概要

构造器

构造器和说明
PageHelper()

方法概要

限定符和类型	方法和说明
void	afterAll() 完成所有任务后
boolean	afterCount(long count, Object parameterObject, org.apache.ibatis.session.RowBounds rowBounds) 执行完 count 查询后
Object	afterPage(List pageList, Object parameterObject, org.apache.ibatis.session.RowBounds rowBounds) 分页查询后，处理分页结果，拦截器中直接 return 该方法的返回值
boolean	beforeCount(org.apache.ibatis.mapping.MappedStatement ms, Object parameterObject, org.apache.ibatis.session.RowBounds rowBounds) 执行分页前，返回 true 会进行 count 查询，false 会继续下面的 beforePage 判断
boolean	beforePage(org.apache.ibatis.mapping.MappedStatement ms, Object parameterObject, org.apache.ibatis.session.RowBounds rowBounds) 执行分页前，返回 true 会进行分页查询，false 会返回默认查询结果
org.apache.ibatis.mapping.BoundSql	doBoundSql(BoundSqlInterceptor.Type type, org.apache.ibatis.mapping.BoundSql boundSql, org.apache.ibatis.cache.CacheKey cacheKey)
String	getCountSql(org.apache.ibatis.mapping.MappedStatement ms, org.apache.ibatis.mapping.BoundSql boundSql, Object parameterObject, org.apache.ibatis.session.RowBounds rowBounds, org.apache.ibatis.cache.CacheKey countKey) 生成 count 查询 sql
String	getPageSql(org.apache.ibatis.mapping.MappedStatement ms, org.apache.ibatis.mapping.BoundSql boundSql, Object parameterObject, org.apache.ibatis.session.RowBounds rowBounds, org.apache.ibatis.cache.CacheKey pageKey) 生成分页查询 sql
String	getPageSql(String sql, Page page, org.apache.ibatis.session.RowBounds rowBounds, org.apache.ibatis.cache.CacheKey pageKey)
Object	processParameterObject(org.apache.ibatis.mapping.MappedStatement ms, Object parameterObject, org.apache.ibatis.mapping.BoundSql boundSql, org.apache.ibatis.cache.CacheKey pageKey) 处理查询参数对象
void	setProperties(Properties properties) 设置参数
boolean	skip(org.apache.ibatis.mapping.MappedStatement ms, Object parameterObject, org.apache.ibatis.session.RowBounds rowBounds) 跳过 count 和 分页查询

从类继承的方法 com.github.pagehelper.page.PageMethod

clearPage, count, getLocalPage, offsetPage, offsetPage, orderBy, setLocalPage, setStaticProperties, startPage, startPage, startPage, startPage, startPage

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

PageHelper

public PageHelper()

方法详细资料

skip

public boolean skip(org.apache.ibatis.mapping.MappedStatement ms,
                    Object parameterObject,
                    org.apache.ibatis.session.RowBounds rowBounds)

从接口复制的说明: Dialect

跳过 count 和 分页查询

指定者:

skip 在接口中 Dialect

参数:

ms - MappedStatement

parameterObject - 方法参数

rowBounds - 分页参数

返回:

true 跳过，返回默认查询结果，false 执行分页查询

beforeCount

public boolean beforeCount(org.apache.ibatis.mapping.MappedStatement ms,
                           Object parameterObject,
                           org.apache.ibatis.session.RowBounds rowBounds)

从接口复制的说明: Dialect

执行分页前，返回 true 会进行 count 查询，false 会继续下面的 beforePage 判断

指定者:

beforeCount 在接口中 Dialect

参数:

ms - MappedStatement

parameterObject - 方法参数

rowBounds - 分页参数

返回:

getCountSql

public String getCountSql(org.apache.ibatis.mapping.MappedStatement ms,
                          org.apache.ibatis.mapping.BoundSql boundSql,
                          Object parameterObject,
                          org.apache.ibatis.session.RowBounds rowBounds,
                          org.apache.ibatis.cache.CacheKey countKey)

从接口复制的说明: Dialect

生成 count 查询 sql

指定者:

getCountSql 在接口中 Dialect

参数:

ms - MappedStatement

boundSql - 绑定 SQL 对象

parameterObject - 方法参数

rowBounds - 分页参数

countKey - count 缓存 key

返回:

afterCount

public boolean afterCount(long count,
                          Object parameterObject,
                          org.apache.ibatis.session.RowBounds rowBounds)

从接口复制的说明: Dialect

执行完 count 查询后

指定者:

afterCount 在接口中 Dialect

参数:

count - 查询结果总数

parameterObject - 接口参数

rowBounds - 分页参数

返回:

true 继续分页查询，false 直接返回

processParameterObject

public Object processParameterObject(org.apache.ibatis.mapping.MappedStatement ms,
                                     Object parameterObject,
                                     org.apache.ibatis.mapping.BoundSql boundSql,
                                     org.apache.ibatis.cache.CacheKey pageKey)

从接口复制的说明: Dialect

处理查询参数对象

指定者:

processParameterObject 在接口中 Dialect

参数:

ms - MappedStatement

返回:

beforePage

public boolean beforePage(org.apache.ibatis.mapping.MappedStatement ms,
                          Object parameterObject,
                          org.apache.ibatis.session.RowBounds rowBounds)

从接口复制的说明: Dialect

执行分页前，返回 true 会进行分页查询，false 会返回默认查询结果

指定者:

beforePage 在接口中 Dialect

参数:

ms - MappedStatement

parameterObject - 方法参数

rowBounds - 分页参数

返回:

getPageSql

public String getPageSql(org.apache.ibatis.mapping.MappedStatement ms,
                         org.apache.ibatis.mapping.BoundSql boundSql,
                         Object parameterObject,
                         org.apache.ibatis.session.RowBounds rowBounds,
                         org.apache.ibatis.cache.CacheKey pageKey)

从接口复制的说明: Dialect

生成分页查询 sql

指定者:

getPageSql 在接口中 Dialect

参数:

ms - MappedStatement

boundSql - 绑定 SQL 对象

parameterObject - 方法参数

rowBounds - 分页参数

pageKey - 分页缓存 key

返回:

getPageSql

public String getPageSql(String sql,
                         Page page,
                         org.apache.ibatis.session.RowBounds rowBounds,
                         org.apache.ibatis.cache.CacheKey pageKey)

afterPage

public Object afterPage(List pageList,
                        Object parameterObject,
                        org.apache.ibatis.session.RowBounds rowBounds)

从接口复制的说明: Dialect

分页查询后，处理分页结果，拦截器中直接 return 该方法的返回值

指定者:

afterPage 在接口中 Dialect

参数:

pageList - 分页查询结果

parameterObject - 方法参数

rowBounds - 分页参数

返回:

afterAll

public void afterAll()

从接口复制的说明: Dialect

完成所有任务后

指定者:

afterAll 在接口中 Dialect

doBoundSql

public org.apache.ibatis.mapping.BoundSql doBoundSql(BoundSqlInterceptor.Type type,
                                                     org.apache.ibatis.mapping.BoundSql boundSql,
                                                     org.apache.ibatis.cache.CacheKey cacheKey)

指定者:

doBoundSql 在接口中 BoundSqlInterceptor.Chain

setProperties

public void setProperties(Properties properties)

从接口复制的说明: Dialect

设置参数

指定者:

setProperties 在接口中 Dialect

参数:

properties - 插件属性