当前位置:

首页 > 编程开发 > SpringBoot整合PageHelper实现分页查询功能

SpringBoot整合PageHelper实现分页查询功能

在SpringBoot+MyBatis项目中,通过PageHelper插件可零侵入实现分页查询。只需在查询前调用startPage(),插件自动拦截SQL并拼接LIMIT语句,同时执行count查询。通过封装PageBean结果类,利用Page对象强转获取总记录数和当前页数据,有效提升大数据量下的查询性能。

一、为什么需要分页?

在数据量面前,一个不争的事实是——如果不做分页,应用就得一次性地把所有满足条件的数据都查出来、渲染出来。后果是什么?查询越来越慢,页面越来越卡,直到某一天,用户等得不耐烦了直接关掉页面。

分页查询,是解决这个问题的经典方案。这篇文章就专注于一个场景:在 Spring Boot + MyBatis 项目中,如何用 PageHelper 快速落地一个高效、可用的分页功能。

SpringBoot整合PageHelper实现分页查询功能

二、PageHelper 简介

简单来说,PageHelper 是 MyBatis 生态里一个相当成熟的分页插件,它的核心卖点就在这几个字上:操作简单、自动化、易集成。

它的典型优势在于:

  • 操作简单:查询前只加一行 startPage() 就行,原有的 SQL 一句不用动。
  • 自动拦截:它会自动帮你拦截 SQL,拼接出正确的 LIMIT 语句,顺便完成 count 查询。说白了,就是替你写了那条 LIMIT 语句。
  • 开箱即用:自带 Spring Boot Starter,引入依赖就能干活。

三、环境搭建

先把依赖加到 pom.xml 里:



    com.github.pagehelper
    pagehelper-spring-boot-starter
    1.4.6

为了让前后端的数据交互有统一规范,我们先定义一个通用的分页结果类 PageBean:

public class PageBean {
    private Long total;      // 总记录数
    private List items;   // 当前页数据列表
}

其中 total 告诉前端一共有多少条数据,用来算总页数;items 就是当前页要展示的具体数据。

四、核心使用方式

真的只需要一行代码:

// 开启分页查询
PageHelper.startPage(pageNum, pageSize);
// 直接进入 Mapper 层,PageHelper 会自动插入 LIMIT 语句
List
as = articleMapper.list(userid, categoryId, state);

这背后的原理就是把分页参数塞进 ThreadLocal,等下次查询时拦截器自动识别并处理。

五、实战:文章列表分页查询

下面以项目中的文章列表为例,完整跑一遍从 Controller 到 Mapper 的全链路。

Controller 层

接收前端的分页参数和查询条件:

@GetMapping
public Result> list(
    Integer pageNum,
    Integer pageSize,
    @RequestParam(required = false) Integer categoryId,
    @RequestParam(required = false) String state
) {
    PageBean
pb = articleService.list(pageNum, pageSize, categoryId, state); return Result.success(pb); }

几个关键点:pageNum 是当前页码,从 1 开始;pageSize 是每页条数;categoryId 和 state 是可选的业务查询条件,用 required = false 来标记。注意控制器的返回值类型要跟 Result 统一。

Service 层

这里是分页逻辑的核心所在:

@Override
public PageBean
list(Integer pageNum, Integer pageSize, Integer categoryId, String state) { // 1. 创建 PageBean 对象 PageBean
pb = new PageBean<>(); // 2. 开启分页查询 PageHelper.startPage(pageNum, pageSize); // 3. 调用 Mapper 查询(此时返回的 List 实际上是 Page 类型) Map map = ThreadLocalUtil.get(); Integer userid = (Integer) map.get("id"); List
as = articleMapper.list(userid, categoryId, state); // 4. 强转为 Page 对象,获取分页信息 Page
p = (Page
) as; // 5. 封装结果 pb.setTotal(p.getTotal()); pb.setItems(p.getResult()); return pb; }

第 4 步的强转是为了拿到 Page 类里封装好的分页信息——这个 Page 类就是 PageHelper 自己提供的。

Mapper 层

这里基本不用动,该怎么写就怎么写:

PageHelper 会在后台悄悄地做两件事:

  • 先执行一条 SELECT COUNT(*) FROM article WHERE ... 来拿总记录数。
  • 再在原 SQL 后面拼接 LIMIT offset, pageSize,完成分页查询。

六、PageHelper 工作原理(简述)

一句话概括:PageHelper 通过 MyBatis 的 Interceptor(拦截器)机制,在执行真正的查询之前对 SQL 进行改写。startPage() 方法把分页参数塞进 ThreadLocal,确保同一线程中的下一次查询被拦截处理。这本质上是 AOP 的思想,但并不是通过 Spring Boot 的 AOP 去实现的,而是直接基于 MyBatis 自身的拦截器机制。

七、总结

回过头来看,通过 PageHelper,我们在 Spring Boot 项目里几乎是以零侵入的方式完成了分页功能:

  • 加一个依赖:pagehelper-spring-boot-starter
  • 封装一个结果类:PageBean
  • 一行代码开启分页:PageHelper.startPage(pageNum, pageSize)
  • 正常写查询:Mapper 的 SQL 一句不用动
  • 强转获取分页信息:Page 类型的转换
  • 提取结果:通过 Page.getTotal() 和 Page.getResult() 拿到数据

这种设计让分页逻辑和业务代码完全解耦,在日常开发中,算是非常推荐的一种方案了。

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
作者最新文章
编程开发
相关文章 更多
ServBay安装配置详细教程与操作指南
ServBay安装配置详细教程与操作指南

新手入门 ServBay 本地开发环境,详解安装包下载、Dashboard 状态监控、Packages 组件安装、Services 服务控制及 Websites 项目配置。掌握 .servbay.config 版本管理与日志排查技巧,快速搭建稳定的 PHP、Node.js 等多语言开发环境。

codekit环境配置指南从安装到环境搭建完整教程
codekit环境配置指南从安装到环境搭建完整教程

详解 CodeKit 在 macOS 下的安装步骤、项目导入方法、Sass与JavaScript编译设置及浏览器自动刷新功能,助您快速搭建高效的前端开发环境。

codex安装windows 命令行完整操作教程
codex安装windows 命令行完整操作教程

详解Windows环境下安装OpenAI Codex CLI的步骤,包括WSL环境检查、Node.js/npm配置、npm全局安装命令及首次启动验证,适合开发者快速上手。

NativeRest环境配置要求与完整操作教程
NativeRest环境配置要求与完整操作教程

学习如何配置 NativeRest REST API 客户端。涵盖 Windows/macOS/Linux 安装后的工作区创建、环境变量管理、请求编辑及响应查看步骤,帮助开发者快速完成基础环境搭建与连通性测试。

CSS设置透明度的注意事项有哪些?opacity属性详解
CSS设置透明度的注意事项有哪些?opacity属性详解

深入解析CSS中设置透明度的核心属性opacity,剖析子元素继承、事件穿透、层叠上下文等关键注意事项,并提供与rgba、hsla的实用选型对比。

flutter页面传值到后台的方法及示例代码
flutter页面传值到后台的方法及示例代码

flutter页面传值到后台的完整实现方法及示例代码,帮助读者快速掌握相关技术要点。

Java 8至21新特性代码写法对比:Lambda、Record与Switch
Java 8至21新特性代码写法对比:Lambda、Record与Switch

本文通过具体的旧版与新版代码对比,详细剖析Java 8引入的Lambda表达式、Java 14/16引入的Record类,以及Java 12至21逐步演进完善的Switch表达式与模式匹配,展示代码简化路径与避坑要点。

AI智能体开发培训课程学什么及实战内容介绍
AI智能体开发培训课程学什么及实战内容介绍

系统梳理AI智能体开发培训的核心知识模块、技术栈选型与典型实战项目,解析低代码平台与纯代码框架的差异,提供从零构建可落地智能体的完整学习与实施路径。

Java子类未实现抽象方法编译错误修复指南
Java子类未实现抽象方法编译错误修复指南

针对Java开发中常见的“子类未实现抽象方法”编译错误,深入分析报错原因,提供重写实现、声明抽象子类两种标准修复路径,并总结参数签名、访问修饰符等典型避坑要点。

解决PHP递归报错:max_nesting_level限制与内存溢出处理
解决PHP递归报错:max_nesting_level限制与内存溢出处理

遇到PHP递归报错时,不要盲目调大max_nesting_level。本文教你区分Xdebug限制、内存耗尽和正则递归错误,提供代码级的终止条件优化与迭代替代方案,彻底解决栈溢出问题。

查看更多
精品专题 更多
装机必备
装机必备

正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

Windows
Windows

正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

PDF教程
PDF教程

正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

Mac软件 更多
Shapr3D macOS版
Shapr3D macOS版
Mac

Shapr3D是一款面向工业设计、机械工程、建筑概念和三维打印工作流的CAD软件。Mac版采用Parasolid建模内核,支持草图约束、实体建模、工程图、可视化渲染及常见CAD格式交换,并可通过账户在多台设备之间同步项目。

REAPER macOS版
REAPER macOS版
Mac

REAPER是Cockos开发的数字音频工作站,提供多轨音频与MIDI录制、剪辑、处理、混音和母带制作工具。Mac版兼容Intel与Apple芯片,支持AU、VST、VST3、CLAP等插件格式,并提供高度可定制的工作流程。

Ableton Live macOS版
Ableton Live macOS版
Mac

Ableton Live 是面向音乐制作人与现场表演者的数字音频工作站,提供编曲视图、独具特色的现场视图、音频录制、MIDI创作、实时变速、乐器及效果器。Mac版原生支持Apple芯片,并可连接音频接口、MIDI控制器和第三方插件。

WINDOWS 更多
3dmax(3ds max)
3dmax(3ds max)
Windows

Autodesk 3ds Max 是一款专业的三维建模、动画与渲染软件,广泛应用于建筑可视化、游戏开发、影视动画、广告设计和产品展示等领域。

photoshop
photoshop
Windows、macOS 、 iPad

Photoshop 2026 是 Adobe 推出的专业图像处理与视觉设计软件,支持 Windows、macOS 和 iPad 等平台,广泛应用于摄影修图、电商设计、平面海报、数字绘画及视觉合成等创作场景。

Blender
Blender
Windows、macOS 和 Linux

Blender 是一款免费开源、跨平台的专业 3D 创作软件,集建模、动画、渲染、视频编辑与视觉合成等功能于一体,广泛应用于影视动画、游戏设计和建筑可视化等领域。软件支持 Cycles 物理渲染器与 Eevee 实时渲染引擎,并提供多边形建模、骨骼绑定、物理模拟等专业工具。Blender 兼容 Windows、macOS 和 Linux 系统,安装包轻巧、运行流畅,依托活跃的全球开发者社区持续更新,是从初学者到专业创作者都值得选择的正版 3D 创作工具。