Page (mybatis-plus-extension 3.4.3.1 API)

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

所有已实现的接口:

com.baomidou.mybatisplus.core.metadata.IPage<T>, java.io.Serializable

直接已知子类:

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

从以下版本开始:

2018-06-09

作者:

hubin

另请参阅:

序列化表格

字段概要

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

构造器概要

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

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`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`	`countId()`
`java.lang.String`	`getCountId()` 已过时。
`long`	`getCurrent()`
`java.lang.Long`	`getMaxLimit()` 已过时。
`java.util.List<com.baomidou.mybatisplus.core.metadata.OrderItem>`	`getOrders()` 已过时。
`long`	`getPages()`
`java.util.List<T>`	`getRecords()`
`long`	`getSize()`
`long`	`getTotal()`
`boolean`	`hasNext()` 是否存在下一页
`boolean`	`hasPrevious()` 是否存在上一页
`boolean`	`isOptimizeCountSql()` 已过时。
`boolean`	`isSearchCount()` 已过时。
`java.lang.Long`	`maxLimit()`
`static <T> Page<T>`	`of(long current, long size)`
`static <T> Page<T>`	`of(long current, long size, boolean searchCount)`
`static <T> Page<T>`	`of(long current, long size, long total)`
`static <T> Page<T>`	`of(long current, long size, long total, boolean searchCount)`
`boolean`	`optimizeCountSql()`
`java.util.List<com.baomidou.mybatisplus.core.metadata.OrderItem>`	`orders()`
`boolean`	`searchCount()`
`void`	`setCountId(java.lang.String countId)` countId
`Page<T>`	`setCurrent(long current)`
`void`	`setMaxLimit(java.lang.Long maxLimit)` countId
`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 searchCount)`
`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
convert, 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

searchCount
```
protected boolean searchCount
```
是否进行 count 查询

countId
```
protected java.lang.String countId
```
countId

maxLimit
```
protected java.lang.Long maxLimit
```
countId

构造器详细资料

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 searchCount)

Page

public Page(long current,
            long size,
            long total,
            boolean searchCount)

方法详细资料
- 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>
- countId
```
public java.lang.String countId()
```
  指定者:
  
  countId 在接口中 com.baomidou.mybatisplus.core.metadata.IPage<T>
- maxLimit
```
public java.lang.Long maxLimit()
```
  指定者:
  
  maxLimit 在接口中 com.baomidou.mybatisplus.core.metadata.IPage<T>
- 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 - 条件
  
  返回:
  
  返回分页参数本身
- orders
```
public java.util.List<com.baomidou.mybatisplus.core.metadata.OrderItem> orders()
```
  指定者:
  
  orders 在接口中 com.baomidou.mybatisplus.core.metadata.IPage<T>
- optimizeCountSql
```
public boolean optimizeCountSql()
```
  指定者:
  
  optimizeCountSql 在接口中 com.baomidou.mybatisplus.core.metadata.IPage<T>
- searchCount
```
public boolean searchCount()
```
  指定者:
  
  searchCount 在接口中 com.baomidou.mybatisplus.core.metadata.IPage<T>
- setSearchCount
```
public Page<T> setSearchCount(boolean searchCount)
```
- setOptimizeCountSql
```
public Page<T> setOptimizeCountSql(boolean optimizeCountSql)
```
- getPages
```
public long getPages()
```
  指定者:
  
  getPages 在接口中 com.baomidou.mybatisplus.core.metadata.IPage<T>
- of
```
public static <T> Page<T> of(long current,
                             long size)
```
- of
```
public static <T> Page<T> of(long current,
                             long size,
                             long total)
```
- of
```
public static <T> Page<T> of(long current,
                             long size,
                             boolean searchCount)
```
- of
```
public static <T> Page<T> of(long current,
                             long size,
                             long total,
                             boolean searchCount)
```
- getCountId
```
@Deprecated
public java.lang.String getCountId()
```
  已过时。
  
  --begin------------- 未来抛弃移除的方法 -------------begin-- 该部分属性转移至 PageDTO
- getMaxLimit
```
@Deprecated
public java.lang.Long getMaxLimit()
```
  已过时。
- getOrders
```
@Deprecated
public java.util.List<com.baomidou.mybatisplus.core.metadata.OrderItem> getOrders()
```
  已过时。
- isOptimizeCountSql
```
@Deprecated
public boolean isOptimizeCountSql()
```
  已过时。
- isSearchCount
```
@Deprecated
public boolean isSearchCount()
```
  已过时。
- setOrders
```
public void setOrders(java.util.List<com.baomidou.mybatisplus.core.metadata.OrderItem> orders)
```
  排序字段信息
- setCountId
```
public void setCountId(java.lang.String countId)
```
  countId
- setMaxLimit
```
public void setMaxLimit(java.lang.Long maxLimit)
```
  countId

类 Page<T>

字段概要

构造器概要

方法概要

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

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

字段详细资料

records

total

size

current

orders

optimizeCountSql

searchCount

countId

maxLimit

构造器详细资料

Page

Page

Page

Page

Page

方法详细资料

hasPrevious

hasNext

getRecords

setRecords

getTotal

setTotal

getSize

setSize

getCurrent

setCurrent

countId

maxLimit

addOrder

addOrder

orders

optimizeCountSql

searchCount

setSearchCount

setOptimizeCountSql

getPages

of

of

of

of

getCountId

getMaxLimit

getOrders

isOptimizeCountSql

isSearchCount

setOrders

setCountId

setMaxLimit