Page (mybatis-plus-extension 3.3.2 API)

java.lang.Object
- com.baomidou.mybatisplus.extension.plugins.pagination.Page<T>

所有已实现的接口:

com.baomidou.mybatisplus.core.metadata.IPage<T>, java.io.Serializable
```
public class Page<T>
extends java.lang.Object
implements com.baomidou.mybatisplus.core.metadata.IPage<T>
```
简单分页模型

从以下版本开始:

2018-06-09

作者:

hubin

另请参阅:

序列化表格

字段概要

字段
限定符和类型	字段和说明
`protected long`	`current` 当前页
`protected boolean`	`hitCount` 是否命中count缓存
`protected boolean`	`isSearchCount` 是否进行 count 查询
`protected boolean`	`optimizeCountSql` 自动优化 COUNT SQL
`protected java.util.List<com.baomidou.mybatisplus.core.metadata.OrderItem>`	`orders` 排序字段信息
`protected java.util.List<T>`	`records` 查询数据列表
`protected long`	`size` 每页显示条数，默认 10
`protected long`	`total` 总数

构造器概要

构造器
构造器和说明
`Page()`
`Page(long current, long size)` 分页构造函数
`Page(long current, long size, boolean isSearchCount)`
`Page(long current, long size, long total)`
`Page(long current, long size, long total, boolean isSearchCount)`

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`Page<T>`	`addOrder(java.util.List<com.baomidou.mybatisplus.core.metadata.OrderItem> items)` 添加新的排序条件，构造条件可以使用工厂：`OrderItem.build(String, boolean)`
`Page<T>`	`addOrder(com.baomidou.mybatisplus.core.metadata.OrderItem... items)` 添加新的排序条件，构造条件可以使用工厂：`OrderItem.build(String, boolean)`
`java.lang.String[]`	`ascs()` 已过时。 3.2.0
`java.lang.String[]`	`descs()` 已过时。 3.2.0
`long`	`getCurrent()`
`java.util.List<com.baomidou.mybatisplus.core.metadata.OrderItem>`	`getOrders()`
`java.util.List<T>`	`getRecords()`
`long`	`getSize()`
`long`	`getTotal()`
`boolean`	`hasNext()` 是否存在下一页
`boolean`	`hasPrevious()` 是否存在上一页
`void`	`hitCount(boolean hit)`
`boolean`	`isHitCount()`
`boolean`	`isOptimizeCountSql()`
`boolean`	`isSearchCount()`
`boolean`	`optimizeCountSql()`
`java.util.List<com.baomidou.mybatisplus.core.metadata.OrderItem>`	`orders()`
`Page<T>`	`setAsc(java.lang.String... ascs)` 已过时。 3.2.0
`Page<T>`	`setAscs(java.util.List<java.lang.String> ascs)` 已过时。 3.2.0
`Page<T>`	`setCurrent(long current)`
`Page<T>`	`setDesc(java.lang.String... descs)` 已过时。 3.2.0
`Page<T>`	`setDescs(java.util.List<java.lang.String> descs)` 已过时。 3.2.0
`void`	`setHitCount(boolean hit)`
`Page<T>`	`setOptimizeCountSql(boolean optimizeCountSql)`
`void`	`setOrders(java.util.List<com.baomidou.mybatisplus.core.metadata.OrderItem> orders)`
`Page<T>`	`setRecords(java.util.List<T> records)`
`Page<T>`	`setSearchCount(boolean isSearchCount)`
`Page<T>`	`setSize(long size)`
`Page<T>`	`setTotal(long total)`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 com.baomidou.mybatisplus.core.metadata.IPage
cacheKey, condition, convert, getPages, offset, setPages

- 字段详细资料
  - records
```
protected java.util.List<T> records
```
    查询数据列表
  - total
```
protected long total
```
    总数
  - size
```
protected long size
```
    每页显示条数，默认 10
  - current
```
protected long current
```
    当前页
  - orders
```
protected java.util.List<com.baomidou.mybatisplus.core.metadata.OrderItem> orders
```
    排序字段信息
  - optimizeCountSql
```
protected boolean optimizeCountSql
```
    自动优化 COUNT SQL
  - isSearchCount
```
protected boolean isSearchCount
```
    是否进行 count 查询
  - hitCount
```
protected boolean hitCount
```
    是否命中count缓存
- 构造器详细资料
  - Page
```
public Page()
```
  - Page
```
public Page(long current,
            long size)
```
    分页构造函数
    
    参数:
    
    current - 当前页
    
    size - 每页显示条数
  - Page
```
public Page(long current,
            long size,
            long total)
```
  - Page
```
public Page(long current,
            long size,
            boolean isSearchCount)
```
  - Page
```
public Page(long current,
            long size,
            long total,
            boolean isSearchCount)
```
- 方法详细资料
  - hasPrevious
```
public boolean hasPrevious()
```
    是否存在上一页
    
    返回:
    
    true / false
  - hasNext
```
public boolean hasNext()
```
    是否存在下一页
    
    返回:
    
    true / false
  - getRecords
```
public java.util.List<T> getRecords()
```
    指定者:
    
    getRecords 在接口中 com.baomidou.mybatisplus.core.metadata.IPage<T>
  - setRecords
```
public Page<T> setRecords(java.util.List<T> records)
```
    指定者:
    
    setRecords 在接口中 com.baomidou.mybatisplus.core.metadata.IPage<T>
  - getTotal
```
public long getTotal()
```
    指定者:
    
    getTotal 在接口中 com.baomidou.mybatisplus.core.metadata.IPage<T>
  - setTotal
```
public Page<T> setTotal(long total)
```
    指定者:
    
    setTotal 在接口中 com.baomidou.mybatisplus.core.metadata.IPage<T>
  - getSize
```
public long getSize()
```
    指定者:
    
    getSize 在接口中 com.baomidou.mybatisplus.core.metadata.IPage<T>
  - setSize
```
public Page<T> setSize(long size)
```
    指定者:
    
    setSize 在接口中 com.baomidou.mybatisplus.core.metadata.IPage<T>
  - getCurrent
```
public long getCurrent()
```
    指定者:
    
    getCurrent 在接口中 com.baomidou.mybatisplus.core.metadata.IPage<T>
  - setCurrent
```
public Page<T> setCurrent(long current)
```
    指定者:
    
    setCurrent 在接口中 com.baomidou.mybatisplus.core.metadata.IPage<T>
  - ascs
```
@Nullable
 @Deprecated
public java.lang.String[] ascs()
```
    已过时。 3.2.0
    
    获取当前正序排列的字段集合
    为了兼容，将在不久后废弃
    
    指定者:
    
    ascs 在接口中 com.baomidou.mybatisplus.core.metadata.IPage<T>
    
    返回:
    
    正序排列的字段集合
    
    另请参阅:
    
    getOrders()
  - addOrder
```
public Page<T> addOrder(com.baomidou.mybatisplus.core.metadata.OrderItem... items)
```
    添加新的排序条件，构造条件可以使用工厂：OrderItem.build(String, boolean)
    
    参数:
    
    items - 条件
    
    返回:
    
    返回分页参数本身
  - addOrder
```
public Page<T> addOrder(java.util.List<com.baomidou.mybatisplus.core.metadata.OrderItem> items)
```
    添加新的排序条件，构造条件可以使用工厂：OrderItem.build(String, boolean)
    
    参数:
    
    items - 条件
    
    返回:
    
    返回分页参数本身
  - setAscs
```
@Deprecated
public Page<T> setAscs(java.util.List<java.lang.String> ascs)
```
    已过时。 3.2.0
    
    设置需要进行正序排序的字段
    Replaced:addOrder(OrderItem...)
    
    参数:
    
    ascs - 字段
    
    返回:
    
    返回自身
  - setAsc
```
@Deprecated
public Page<T> setAsc(java.lang.String... ascs)
```
    已过时。 3.2.0
    
    升序
    Replaced:addOrder(OrderItem...)
    
    参数:
    
    ascs - 多个升序字段
  - descs
```
@Deprecated
public java.lang.String[] descs()
```
    已过时。 3.2.0
    
    获取需简要倒序排列的字段数组
    
    指定者:
    
    descs 在接口中 com.baomidou.mybatisplus.core.metadata.IPage<T>
    
    返回:
    
    倒序排列的字段数组
    
    另请参阅:
    
    getOrders()
  - setDescs
```
@Deprecated
public Page<T> setDescs(java.util.List<java.lang.String> descs)
```
    已过时。 3.2.0
    
    Replaced:addOrder(OrderItem...)
    
    参数:
    
    descs - 需要倒序排列的字段
    
    返回:
    
    自身
  - setDesc
```
@Deprecated
public Page<T> setDesc(java.lang.String... descs)
```
    已过时。 3.2.0
    
    降序，这方法名不知道是谁起的
    Replaced:addOrder(OrderItem...)
    
    参数:
    
    descs - 多个降序字段
  - orders
```
public java.util.List<com.baomidou.mybatisplus.core.metadata.OrderItem> orders()
```
    指定者:
    
    orders 在接口中 com.baomidou.mybatisplus.core.metadata.IPage<T>
  - getOrders
```
public java.util.List<com.baomidou.mybatisplus.core.metadata.OrderItem> getOrders()
```
  - setOrders
```
public void setOrders(java.util.List<com.baomidou.mybatisplus.core.metadata.OrderItem> orders)
```
  - optimizeCountSql
```
public boolean optimizeCountSql()
```
    指定者:
    
    optimizeCountSql 在接口中 com.baomidou.mybatisplus.core.metadata.IPage<T>
  - isOptimizeCountSql
```
public boolean isOptimizeCountSql()
```
  - isSearchCount
```
public boolean isSearchCount()
```
    指定者:
    
    isSearchCount 在接口中 com.baomidou.mybatisplus.core.metadata.IPage<T>
  - setSearchCount
```
public Page<T> setSearchCount(boolean isSearchCount)
```
  - setOptimizeCountSql
```
public Page<T> setOptimizeCountSql(boolean optimizeCountSql)
```
  - hitCount
```
public void hitCount(boolean hit)
```
    指定者:
    
    hitCount 在接口中 com.baomidou.mybatisplus.core.metadata.IPage<T>
  - setHitCount
```
public void setHitCount(boolean hit)
```
  - isHitCount
```
public boolean isHitCount()
```
    指定者:
    
    isHitCount 在接口中 com.baomidou.mybatisplus.core.metadata.IPage<T>

类 Page<T>

字段概要

构造器概要

方法概要

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

从接口继承的方法 com.baomidou.mybatisplus.core.metadata.IPage

字段详细资料

records

total

size

current

orders

optimizeCountSql

isSearchCount

hitCount

构造器详细资料

Page

Page

Page

Page

Page

方法详细资料

hasPrevious

hasNext

getRecords

setRecords

getTotal

setTotal

getSize

setSize

getCurrent

setCurrent

ascs

addOrder

addOrder

setAscs

setAsc

descs

setDescs

setDesc

orders

getOrders

setOrders

optimizeCountSql

isOptimizeCountSql

isSearchCount

setSearchCount

setOptimizeCountSql

hitCount

setHitCount

isHitCount