com.github.pagehelper

类 SqlUtil

java.lang.Object

com.github.pagehelper.SqlUtil

所有已实现的接口:

Constant

public class SqlUtil
extends Object
implements Constant

Mybatis - sql工具，获取分页和count的MappedStatement，设置分页参数

从以下版本开始:

3.6.0 项目地址 : http://git.oschina.net/free/Mybatis_PageHelper

作者:

liuzh/abel533/isea533

字段概要

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

ORIGINAL_PARAMETER_OBJECT, PAGEPARAMETER_FIRST, PAGEPARAMETER_SECOND, PROVIDER_OBJECT, SUFFIX_COUNT, SUFFIX_PAGE

构造器概要

构造器

构造器和说明
SqlUtil(String strDialect) 构造方法

方法概要

限定符和类型	方法和说明
static void	clearLocalPage() 移除本地变量
static Boolean	getCOUNT()
static <T> Page<T>	getLocalPage() 获取Page参数
Page	getPage(Object[] args) 获取分页参数
static <T> Page<T>	getPageFromObject(Object params) 对象中获取分页参数
static Object	getParamValue(org.apache.ibatis.reflection.MetaObject paramsObject, String paramName, boolean required) 从对象中取参数
boolean	isPageSqlSource(org.apache.ibatis.mapping.MappedStatement ms) 是否已经处理过
void	processMappedStatement(org.apache.ibatis.mapping.MappedStatement ms) 修改SqlSource
Object	processPage(org.apache.ibatis.plugin.Invocation invocation) Mybatis拦截器方法，这一步嵌套为了在出现异常时也可以清空Threadlocal
static void	setLocalPage(Page page)
void	setOffsetAsPageNum(boolean offsetAsPageNum)
void	setPageSizeZero(boolean pageSizeZero)
void	setParams(String params)
void	setProperties(Properties p)
void	setReasonable(boolean reasonable)
void	setRowBoundsWithCount(boolean rowBoundsWithCount)
void	setSqlUtilConfig(SqlUtilConfig config)
void	setSupportMethodsArguments(boolean supportMethodsArguments)
static void	testSql(Dialect dialect, String originalSql) 已过时。 将在5.x版本去掉
static void	testSql(String dialect, String originalSql) 已过时。 将在5.x版本去掉

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

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

构造器详细资料

SqlUtil

public SqlUtil(String strDialect)

构造方法

参数:

strDialect -

方法详细资料

getCOUNT

public static Boolean getCOUNT()

getLocalPage

public static <T> Page<T> getLocalPage()

获取Page参数

返回:

setLocalPage

public static void setLocalPage(Page page)

clearLocalPage

public static void clearLocalPage()

移除本地变量

getPageFromObject

public static <T> Page<T> getPageFromObject(Object params)

对象中获取分页参数

参数:

params -

返回:

getParamValue

public static Object getParamValue(org.apache.ibatis.reflection.MetaObject paramsObject,
                                   String paramName,
                                   boolean required)

从对象中取参数

参数:

paramsObject -

paramName -

required -

返回:

isPageSqlSource

public boolean isPageSqlSource(org.apache.ibatis.mapping.MappedStatement ms)

是否已经处理过

参数:

ms -

返回:

testSql

@Deprecated
public static void testSql(String dialect,
                                        String originalSql)

已过时。 将在5.x版本去掉

测试[控制台输出]count和分页sql

参数:

dialect - 数据库类型

originalSql - 原sql

testSql

@Deprecated
public static void testSql(Dialect dialect,
                                        String originalSql)

已过时。 将在5.x版本去掉

测试[控制台输出]count和分页sql

参数:

dialect - 数据库类型

originalSql - 原sql

processMappedStatement

public void processMappedStatement(org.apache.ibatis.mapping.MappedStatement ms)
                            throws Throwable

修改SqlSource

参数:

ms -

抛出:

Throwable

getPage

public Page getPage(Object[] args)

获取分页参数

参数:

args -

返回:

返回Page对象

processPage

public Object processPage(org.apache.ibatis.plugin.Invocation invocation)
                   throws Throwable

Mybatis拦截器方法，这一步嵌套为了在出现异常时也可以清空Threadlocal

参数:

invocation - 拦截器入参

返回:

返回执行结果

抛出:

Throwable - 抛出异常

setOffsetAsPageNum

public void setOffsetAsPageNum(boolean offsetAsPageNum)

setRowBoundsWithCount

public void setRowBoundsWithCount(boolean rowBoundsWithCount)

setPageSizeZero

public void setPageSizeZero(boolean pageSizeZero)

setReasonable

public void setReasonable(boolean reasonable)

setSupportMethodsArguments

public void setSupportMethodsArguments(boolean supportMethodsArguments)

setParams

public void setParams(String params)

setProperties

public void setProperties(Properties p)

setSqlUtilConfig

public void setSqlUtilConfig(SqlUtilConfig config)