com.github.pagehelper

类 PageHelper

java.lang.Object

com.github.pagehelper.PageHelper

所有已实现的接口:

org.apache.ibatis.plugin.Interceptor

public class PageHelper
extends Object
implements org.apache.ibatis.plugin.Interceptor

Mybatis - 通用分页拦截器

版本:

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

作者:

liuzh/abel533/isea533

构造器概要

构造器

构造器和说明
PageHelper()

方法概要

限定符和类型	方法和说明
static long	count(ISelect select) 获取任意查询方法的count总数
static String	getOrderBy() 获取orderBy
SqlUtil	getSqlUtil(org.apache.ibatis.plugin.Invocation invocation) 根据daatsource创建对应的sqlUtil
String	getUrl(DataSource dataSource) 获取url
void	initSqlUtil(org.apache.ibatis.plugin.Invocation invocation) 初始化sqlUtil
Object	intercept(org.apache.ibatis.plugin.Invocation invocation) Mybatis拦截器方法
static <E> Page<E>	offsetPage(int offset, int limit) 开始分页
static <E> Page<E>	offsetPage(int offset, int limit, boolean count) 开始分页
static <E> Page<E>	offsetPage(int offset, int limit, String orderBy) 开始分页
static void	orderBy(String orderBy) 排序
Object	plugin(Object target) 只拦截Executor
void	setProperties(Properties p) 设置属性值
void	setSqlUtilConfig(SqlUtilConfig config) 设置属性值
static <E> Page<E>	startPage(int pageNum, int pageSize) 开始分页
static <E> Page<E>	startPage(int pageNum, int pageSize, boolean count) 开始分页
static <E> Page<E>	startPage(int pageNum, int pageSize, boolean count, Boolean reasonable) 开始分页
static <E> Page<E>	startPage(int pageNum, int pageSize, boolean count, Boolean reasonable, Boolean pageSizeZero) 开始分页
static <E> Page<E>	startPage(int pageNum, int pageSize, String orderBy) 开始分页
static <E> Page<E>	startPage(Object params) 开始分页

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

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

构造器详细资料

PageHelper

public PageHelper()

方法详细资料

count

public static long count(ISelect select)

获取任意查询方法的count总数

参数:

select -

返回:

startPage

public static <E> Page<E> startPage(int pageNum,
                                    int pageSize)

开始分页

参数:

pageNum - 页码

pageSize - 每页显示数量

startPage

public static <E> Page<E> startPage(int pageNum,
                                    int pageSize,
                                    boolean count)

开始分页

参数:

pageNum - 页码

pageSize - 每页显示数量

count - 是否进行count查询

startPage

public static <E> Page<E> startPage(int pageNum,
                                    int pageSize,
                                    String orderBy)

开始分页

参数:

pageNum - 页码

pageSize - 每页显示数量

orderBy - 排序

offsetPage

public static <E> Page<E> offsetPage(int offset,
                                     int limit)

开始分页

参数:

offset - 页码

limit - 每页显示数量

offsetPage

public static <E> Page<E> offsetPage(int offset,
                                     int limit,
                                     boolean count)

开始分页

参数:

offset - 页码

limit - 每页显示数量

count - 是否进行count查询

offsetPage

public static <E> Page<E> offsetPage(int offset,
                                     int limit,
                                     String orderBy)

开始分页

参数:

offset - 页码

limit - 每页显示数量

orderBy - 排序

startPage

public static <E> Page<E> startPage(int pageNum,
                                    int pageSize,
                                    boolean count,
                                    Boolean reasonable)

开始分页

参数:

pageNum - 页码

pageSize - 每页显示数量

count - 是否进行count查询

reasonable - 分页合理化,null时用默认配置

startPage

public static <E> Page<E> startPage(int pageNum,
                                    int pageSize,
                                    boolean count,
                                    Boolean reasonable,
                                    Boolean pageSizeZero)

开始分页

参数:

pageNum - 页码

pageSize - 每页显示数量

count - 是否进行count查询

reasonable - 分页合理化,null时用默认配置

pageSizeZero - true且pageSize=0时返回全部结果，false时分页,null时用默认配置

startPage

public static <E> Page<E> startPage(Object params)

开始分页

参数:

params -

orderBy

public static void orderBy(String orderBy)

排序

参数:

orderBy -

getOrderBy

public static String getOrderBy()

获取orderBy

返回:

intercept

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

Mybatis拦截器方法

指定者:

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

参数:

invocation - 拦截器入参

返回:

返回执行结果

抛出:

Throwable - 抛出异常

initSqlUtil

public void initSqlUtil(org.apache.ibatis.plugin.Invocation invocation)

初始化sqlUtil

参数:

invocation -

getUrl

public String getUrl(DataSource dataSource)

获取url

参数:

dataSource -

返回:

getSqlUtil

public SqlUtil getSqlUtil(org.apache.ibatis.plugin.Invocation invocation)

根据daatsource创建对应的sqlUtil

参数:

invocation -

plugin

public Object plugin(Object target)

只拦截Executor

指定者:

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

参数:

target -

返回:

setProperties

public void setProperties(Properties p)

设置属性值

指定者:

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

参数:

p - 属性值

setSqlUtilConfig

public void setSqlUtilConfig(SqlUtilConfig config)

设置属性值

参数:

config -