com.github.pagehelper

Class PageHelper

java.lang.Object

com.github.pagehelper.page.PageMethod

com.github.pagehelper.PageHelper

All Implemented Interfaces:

BoundSqlInterceptor.Chain, Dialect

public class PageHelper
extends PageMethod
implements Dialect, BoundSqlInterceptor.Chain

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

Version:

5.0.0

Author:

liuzh/abel533/isea533

Field Summary

Fields inherited from class com.github.pagehelper.page.PageMethod

DEFAULT_COUNT, LOCAL_PAGE

Fields inherited from interface com.github.pagehelper.BoundSqlInterceptor.Chain

DO_NOTHING

Constructor Summary

Constructors

Constructor and Description
PageHelper()

Method Summary

Modifier and Type	Method and Description
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 和 分页查询

Methods inherited from class com.github.pagehelper.page.PageMethod

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PageHelper

public PageHelper()

Method Detail

skip

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

Description copied from interface: Dialect

跳过 count 和 分页查询

Specified by:

skip in interface Dialect

Parameters:

ms - MappedStatement

parameterObject - 方法参数

rowBounds - 分页参数

Returns:

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

beforeCount

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

Description copied from interface: Dialect

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

Specified by:

beforeCount in interface Dialect

Parameters:

ms - MappedStatement

parameterObject - 方法参数

rowBounds - 分页参数

Returns:

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)

Description copied from interface: Dialect

生成 count 查询 sql

Specified by:

getCountSql in interface Dialect

Parameters:

ms - MappedStatement

boundSql - 绑定 SQL 对象

parameterObject - 方法参数

rowBounds - 分页参数

countKey - count 缓存 key

Returns:

afterCount

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

Description copied from interface: Dialect

执行完 count 查询后

Specified by:

afterCount in interface Dialect

Parameters:

count - 查询结果总数

parameterObject - 接口参数

rowBounds - 分页参数

Returns:

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)

Description copied from interface: Dialect

处理查询参数对象

Specified by:

processParameterObject in interface Dialect

Parameters:

ms - MappedStatement

Returns:

beforePage

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

Description copied from interface: Dialect

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

Specified by:

beforePage in interface Dialect

Parameters:

ms - MappedStatement

parameterObject - 方法参数

rowBounds - 分页参数

Returns:

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)

Description copied from interface: Dialect

生成分页查询 sql

Specified by:

getPageSql in interface Dialect

Parameters:

ms - MappedStatement

boundSql - 绑定 SQL 对象

parameterObject - 方法参数

rowBounds - 分页参数

pageKey - 分页缓存 key

Returns:

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)

Description copied from interface: Dialect

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

Specified by:

afterPage in interface Dialect

Parameters:

pageList - 分页查询结果

parameterObject - 方法参数

rowBounds - 分页参数

Returns:

afterAll

public void afterAll()

Description copied from interface: Dialect

完成所有任务后

Specified by:

afterAll in interface Dialect

doBoundSql

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

Specified by:

doBoundSql in interface BoundSqlInterceptor.Chain

setProperties

public void setProperties(Properties properties)

Description copied from interface: Dialect

设置参数

Specified by:

setProperties in interface Dialect

Parameters:

properties - 插件属性