PaginationInterceptor (mybatis-plus-extension 3.4.1 API)

java.lang.Object
- com.baomidou.mybatisplus.extension.handlers.AbstractSqlParserHandler
- - com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor

所有已实现的接口:: org.apache.ibatis.plugin.Interceptor

已过时。

3.4.0 please use MybatisPlusInterceptor PaginationInnerInterceptor

@Deprecated
 @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` 已过时。 3.3.1 `setDialect(IDialect)`
`protected java.lang.String`	`dialectType` 已过时。 3.3.1 `setDbType(DbType)`
`protected long`	`limit` 已过时。单页限制 500 条，小于 0 如 -1 不受限制
`protected static org.apache.ibatis.logging.Log`	`logger` 已过时。
`protected boolean`	`overflow` 已过时。溢出总页数后是否进行处理

构造器概要

构造器
构造器和说明

PaginationInterceptor()
已过时。

构造器
构造器和说明
`PaginationInterceptor()` 已过时。

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`java.lang.String`	`concatOrderBy(java.lang.String originalSql, com.baomidou.mybatisplus.core.metadata.IPage<?> page)` 已过时。查询SQL拼接Order By
`protected boolean`	`continueLimit(com.baomidou.mybatisplus.core.metadata.IPage<?> page)` 已过时。判断是否继续执行 Limit 逻辑
`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)` 已过时。查询总记录条数
`PaginationInterceptor`	`setCountSqlParser(com.baomidou.mybatisplus.core.parser.ISqlParser countSqlParser)` 已过时。 COUNT SQL 解析
`PaginationInterceptor`	`setDbType(com.baomidou.mybatisplus.annotation.DbType dbType)` 已过时。数据库类型
`PaginationInterceptor`	`setDialect(IDialect dialect)` 已过时。方言实现类
`void`	`setDialectClazz(java.lang.String dialectClazz)` 已过时。 3.3.1 `setDialect(IDialect)`}
`void`	`setDialectType(java.lang.String dialectType)` 已过时。 3.3.1 `setDbType(DbType)`
`PaginationInterceptor`	`setLimit(long limit)` 已过时。单页限制 500 条，小于 0 如 -1 不受限制
`PaginationInterceptor`	`setOverflow(boolean overflow)` 已过时。溢出总页数后是否进行处理
`void`	`setProperties(java.util.Properties prop)` 已过时。

从类继承的方法 com.baomidou.mybatisplus.extension.handlers.AbstractSqlParserHandler
canEqual, equals, getSqlParserFilter, getSqlParserList, hashCode, setSqlParserFilter, setSqlParserList, sqlParser, toString

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, 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
```
@Deprecated
protected java.lang.String dialectType
```
    已过时。 3.3.1 setDbType(DbType)
    
    方言类型(数据库名,全小写)
    如果用的我们支持分页的数据库但获取数据库类型不正确则可以配置该值进行校正
  - dialectClazz
```
@Deprecated
protected java.lang.String dialectClazz
```
    已过时。 3.3.1 setDialect(IDialect)
    
    方言实现类
    注意！实现 com.baomidou.mybatisplus.extension.plugins.pagination.dialects.IDialect 接口的子类
- 构造器详细资料
  - PaginationInterceptor
```
public PaginationInterceptor()
```
    已过时。
- 方法详细资料
  - concatOrderBy
```
public 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
  - continueLimit
```
protected boolean continueLimit(com.baomidou.mybatisplus.core.metadata.IPage<?> page)
```
    已过时。
    
    判断是否继续执行 Limit 逻辑
    
    参数:
    
    page - 分页对象
    
    返回:
  - 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
  - setDialectType
```
@Deprecated
public void setDialectType(java.lang.String dialectType)
```
    已过时。 3.3.1 setDbType(DbType)
    
    设置方言类型
    
    参数:
    
    dialectType - 数据库名,全小写
  - setDialectClazz
```
@Deprecated
public void setDialectClazz(java.lang.String dialectClazz)
```
    已过时。 3.3.1 setDialect(IDialect)}
    
    设置方言实现类
    
    参数:
    
    dialectClazz - 方言实现类
  - setCountSqlParser
```
public PaginationInterceptor setCountSqlParser(com.baomidou.mybatisplus.core.parser.ISqlParser countSqlParser)
```
    已过时。
    
    COUNT SQL 解析
    
    返回:
    
    this.
  - setOverflow
```
public PaginationInterceptor setOverflow(boolean overflow)
```
    已过时。
    
    溢出总页数后是否进行处理
    
    返回:
    
    this.
  - setLimit
```
public PaginationInterceptor setLimit(long limit)
```
    已过时。
    
    单页限制 500 条，小于 0 如 -1 不受限制
    
    返回:
    
    this.
  - setDbType
```
public PaginationInterceptor setDbType(com.baomidou.mybatisplus.annotation.DbType dbType)
```
    已过时。
    
    数据库类型
    
    返回:
    
    this.
    
    从以下版本开始:
    
    3.3.1
  - setDialect
```
public PaginationInterceptor setDialect(IDialect dialect)
```
    已过时。
    
    方言实现类
    
    返回:
    
    this.
    
    从以下版本开始:
    
    3.3.1

类 PaginationInterceptor

字段概要

构造器概要

方法概要

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

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

字段详细资料

logger

countSqlParser

overflow

limit

dialectType

dialectClazz

构造器详细资料

PaginationInterceptor

方法详细资料

concatOrderBy

intercept

continueLimit

handlerLimit

queryTotal

handlerOverflow

plugin

setProperties

setDialectType

setDialectClazz

setCountSqlParser

setOverflow

setLimit

setDbType

setDialect