com.baomidou.mybatisplus.extension.plugins

类 PaginationInterceptor

java.lang.Object

com.baomidou.mybatisplus.extension.handlers.AbstractSqlParserHandler

com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor

所有已实现的接口:

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 PaginationInterceptor
extends AbstractSqlParserHandler
implements org.apache.ibatis.plugin.Interceptor

分页拦截器

从以下版本开始:

2016-01-23

作者:

hubin

字段概要

字段

限定符和类型	字段和说明
protected com.baomidou.mybatisplus.core.parser.ISqlParser	countSqlParser COUNT SQL 解析
protected java.lang.String	dialectClazz 方言实现类 注意！
protected java.lang.String	dialectType 方言类型(数据库名,全小写) 如果用的我们支持分页的数据库但获取数据库类型不正确则可以配置该值进行校正
protected long	limit 单页限制 500 条，小于 0 如 -1 不受限制
protected static org.apache.ibatis.logging.Log	logger
protected boolean	overflow 溢出总页数后是否进行处理

构造器概要

构造器

构造器和说明
PaginationInterceptor()

方法概要

限定符和类型	方法和说明
static java.lang.String	concatOrderBy(java.lang.String originalSql, com.baomidou.mybatisplus.core.metadata.IPage<?> page) 查询SQL拼接Order By
protected void	handlerLimit(com.baomidou.mybatisplus.core.metadata.IPage<?> page) 处理超出分页条数限制,默认归为限制数
protected void	handlerOverflow(com.baomidou.mybatisplus.core.metadata.IPage<?> page) 处理页数溢出,默认设置为第一页
java.lang.Object	intercept(org.apache.ibatis.plugin.Invocation invocation) Physical Page Interceptor for all the queries with parameter RowBounds
java.lang.Object	plugin(java.lang.Object target)
protected void	queryTotal(java.lang.String sql, org.apache.ibatis.mapping.MappedStatement mappedStatement, org.apache.ibatis.mapping.BoundSql boundSql, com.baomidou.mybatisplus.core.metadata.IPage<?> page, java.sql.Connection connection) 查询总记录条数
void	setProperties(java.util.Properties prop)

从类继承的方法 com.baomidou.mybatisplus.extension.handlers.AbstractSqlParserHandler

sqlParser

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

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

字段详细资料

logger

protected static final org.apache.ibatis.logging.Log logger

countSqlParser

protected com.baomidou.mybatisplus.core.parser.ISqlParser countSqlParser

COUNT SQL 解析

overflow

protected boolean overflow

溢出总页数后是否进行处理

limit

protected long limit

单页限制 500 条，小于 0 如 -1 不受限制

dialectType

protected java.lang.String dialectType

方言类型(数据库名,全小写)
如果用的我们支持分页的数据库但获取数据库类型不正确则可以配置该值进行校正

dialectClazz

protected java.lang.String dialectClazz

方言实现类
注意！实现 com.baomidou.mybatisplus.extension.plugins.pagination.dialects.IDialect 接口的子类

构造器详细资料

PaginationInterceptor

public PaginationInterceptor()

方法详细资料

concatOrderBy

public static java.lang.String concatOrderBy(java.lang.String originalSql,
                                             com.baomidou.mybatisplus.core.metadata.IPage<?> page)

查询SQL拼接Order By

参数:

originalSql - 需要拼接的SQL

page - page对象

返回:

ignore

intercept

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

Physical Page Interceptor for all the queries with parameter RowBounds

指定者:

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

抛出:

java.lang.Throwable

handlerLimit

protected void handlerLimit(com.baomidou.mybatisplus.core.metadata.IPage<?> page)

处理超出分页条数限制,默认归为限制数

参数:

page - IPage

queryTotal

protected void queryTotal(java.lang.String sql,
                          org.apache.ibatis.mapping.MappedStatement mappedStatement,
                          org.apache.ibatis.mapping.BoundSql boundSql,
                          com.baomidou.mybatisplus.core.metadata.IPage<?> page,
                          java.sql.Connection connection)

查询总记录条数

参数:

sql - count sql

mappedStatement - MappedStatement

boundSql - BoundSql

page - IPage

connection - Connection

handlerOverflow

protected void handlerOverflow(com.baomidou.mybatisplus.core.metadata.IPage<?> page)

处理页数溢出,默认设置为第一页

参数:

page - IPage

plugin

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

指定者:

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

setProperties

public void setProperties(java.util.Properties prop)

指定者:

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