com.github.pagehelper

接口 Dialect

所有已知实现类:

AbstractDialect, AbstractHelperDialect, AbstractRowBoundsDialect, Db2Dialect, Db2RowBoundsDialect, HsqldbDialect, HsqldbRowBoundsDialect, InformixDialect, InformixRowBoundsDialect, MySqlDialect, MySqlRowBoundsDialect, OracleDialect, OracleRowBoundsDialect, PageHelper, SqlServer2012Dialect, SqlServer2012RowBoundsDialect, SqlServerDialect, SqlServerRowBoundsDialect

public interface Dialect

数据库方言，针对不同数据库进行实现

作者:

liuzh

方法概要

限定符和类型	方法和说明
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 会返回默认查询结果
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
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 和 分页查询

方法详细资料

skip

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

跳过 count 和 分页查询

参数:

ms - MappedStatement

parameterObject - 方法参数

rowBounds - 分页参数

返回:

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

beforeCount

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

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

参数:

ms - MappedStatement

parameterObject - 方法参数

rowBounds - 分页参数

返回:

getCountSql

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

参数:

ms - MappedStatement

boundSql - 绑定 SQL 对象

parameterObject - 方法参数

rowBounds - 分页参数

countKey - count 缓存 key

返回:

afterCount

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

执行完 count 查询后

参数:

count - 查询结果总数

parameterObject - 接口参数

rowBounds - 分页参数

返回:

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

processParameterObject

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

处理查询参数对象

参数:

ms - MappedStatement

parameterObject -

boundSql -

pageKey -

返回:

beforePage

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

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

参数:

ms - MappedStatement

parameterObject - 方法参数

rowBounds - 分页参数

返回:

getPageSql

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

参数:

ms - MappedStatement

boundSql - 绑定 SQL 对象

parameterObject - 方法参数

rowBounds - 分页参数

pageKey - 分页缓存 key

返回:

afterPage

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

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

参数:

pageList - 分页查询结果

parameterObject - 方法参数

rowBounds - 分页参数

返回:

afterAll

void afterAll()

完成所有任务后

setProperties

void setProperties(Properties properties)

设置参数

参数:

properties - 插件属性