com.kdayun.z1.core.mybatis

类 PagingPlugin

java.lang.Object

com.kdayun.z1.core.mybatis.PagingPlugin

所有已实现的接口:

org.apache.ibatis.plugin.Interceptor

@Intercepts(value=@Signature(type=org.apache.ibatis.executor.statement.StatementHandler.class,method="prepare",args={java.sql.Connection.class,java.lang.Integer.class}))
public class PagingPlugin
extends java.lang.Object
implements org.apache.ibatis.plugin.Interceptor

分页插件 支持oracle mysql sqlserver 这个插件使用起来十分简单，只要传递给MyBatis的SqlMap以下的方式都是允许的： 1.继承com.kdayun.z1.core.common.PageParams 2.使用map，但是map中的键值对应，有一个值是com.kdayun.z1.core.common.PageParams类型 3.使用@Param注解，只要里面有一个参数是com.kdayun.z1.core.common.PageParams类型 4.使用POJO，但是这个POJO中有一个属性为com.kdayun.z1.core.common.PageParams类型 5.使用map时候包含有page和limit参数 就会在map内增加了一个key是PAGEPARAMS的PageParams类型数据

作者:

gk

date:

2018-3-26 下午6:35:17

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	DB_TYPE_DM 达梦
static java.lang.String	DB_TYPE_JC 金仓
static java.lang.String	DB_TYPE_MYSQL
static java.lang.String	DB_TYPE_ORACLE
static java.lang.String	DB_TYPE_SQLSERVER
java.lang.Boolean	defaultCheckFlag 默认是否检测页码参数
java.lang.Boolean	defaultCleanOrderBy 默认是否清除最后一个order by 后的语句
java.lang.Integer	defaultPage 插件默认参数，可配置 默认页码
java.lang.Integer	defaultPageSize 默认每页条数
java.lang.Boolean	defaultUseFlag 默认是否启用插件

构造器概要

构造器

构造器和说明
PagingPlugin()

方法概要

限定符和类型	方法和说明
static void	clearnPageParams()
static PageParams	getPageParams() 获取当前的pageParams
PageParams	getPageParamsForParamObj(java.lang.Object parameterObject, java.lang.String[] condition) 分离出分页参数.
java.lang.Object	intercept(org.apache.ibatis.plugin.Invocation invocation) 插件实现方法
java.lang.Object	plugin(java.lang.Object statementHandler) 生成代理对象
void	setProperties(java.util.Properties props) 设置插件配置参数。

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

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

字段详细资料

defaultPage

public java.lang.Integer defaultPage

插件默认参数，可配置 默认页码

defaultPageSize

public java.lang.Integer defaultPageSize

默认每页条数

defaultUseFlag

public java.lang.Boolean defaultUseFlag

默认是否启用插件

defaultCheckFlag

public java.lang.Boolean defaultCheckFlag

默认是否检测页码参数

defaultCleanOrderBy

public java.lang.Boolean defaultCleanOrderBy

默认是否清除最后一个order by 后的语句

DB_TYPE_MYSQL

public static final java.lang.String DB_TYPE_MYSQL

另请参阅:

常量字段值

DB_TYPE_ORACLE

public static final java.lang.String DB_TYPE_ORACLE

另请参阅:

常量字段值

DB_TYPE_SQLSERVER

public static final java.lang.String DB_TYPE_SQLSERVER

另请参阅:

常量字段值

DB_TYPE_DM

public static final java.lang.String DB_TYPE_DM

达梦

另请参阅:

常量字段值

DB_TYPE_JC

public static final java.lang.String DB_TYPE_JC

金仓

另请参阅:

常量字段值

构造器详细资料

PagingPlugin

public PagingPlugin()

方法详细资料

intercept

public java.lang.Object intercept(org.apache.ibatis.plugin.Invocation invocation)
                           throws java.lang.Throwable

插件实现方法

指定者:

intercept 在接口中 org.apache.ibatis.plugin.Interceptor

抛出:

java.lang.Throwable

getPageParams

public static PageParams getPageParams()

获取当前的pageParams

返回:

分页参数

getPageParamsForParamObj

public PageParams getPageParamsForParamObj(java.lang.Object parameterObject,
                                           java.lang.String[] condition)
                                    throws java.lang.Exception

分离出分页参数.

参数:

parameterObject - --执行参数

condition - 条件

返回:

分页参数

抛出:

java.lang.Exception - 出错会抛出异常

plugin

public java.lang.Object plugin(java.lang.Object statementHandler)

生成代理对象

指定者:

plugin 在接口中 org.apache.ibatis.plugin.Interceptor

参数:

statementHandler - 原始对象

返回:

代理对象

setProperties

public void setProperties(java.util.Properties props)

设置插件配置参数。

指定者:

setProperties 在接口中 org.apache.ibatis.plugin.Interceptor

参数:

props - 属性

clearnPageParams

public static void clearnPageParams()