后端框架 · RuoYi-Vue-Plus框架功能基础功能
分页功能
适用版本
- 3.5.0 版本
功能说明
- 基于
MyBatis-Plus分页插件实现 - 已开启分页合理化:页码溢出会返回第一页
- 用法与 MP 一致,可直接复用 MP 经验
- 常用入参为
pageNum、pageSize,也支持orderByColumn、isAsc排序
参考文档:MP分页文档

使用步骤
1. Controller 接收分页参数
使用 PageQuery 接收分页参数,具体字段可参考 PageQuery 类。
补充说明:
pageNum默认从1开始pageSize不传时会按PageQuery默认值处理,前端列表页一般都会显式传入- 排序参数示例:
orderByColumn=createTime、isAsc=desc

2. 构建 MP 分页对象
使用 PageQuery#build() 基于当前对象快速构建 MP 分页对象。
列表接口返回给前端时,通常直接使用 TableDataInfo.build(pageResult) 封装分页结果,前端表格组件可以直接复用这套返回结构。

3. 自定义 SQL 分页
自定义 SQL 需要在 Mapper 方法第一个参数传入分页对象,返回值为分页结果。

示例参数
pageNum=1pageSize=10orderByColumn=createTimeisAsc=desc