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

 更新时间:2026年04月29日 09:45:16   作者:ffqws_  
本文介绍了在SpringBoot+MyBatis项目中使用PageHelper实现分页功能的方法,包括PageHelper的简要介绍,环境搭建,核心使用方式,实战案例,以及PageHelper的工作原理,通过PageHelper,可以实现近乎零侵入的分页功能,使分页逻辑与业务代码解耦,需要的朋友可以参考下

一、为什么需要分页?

如果不进行分页,那么就意味着要查询和渲染数据库中所有的符合条件的数据,会出现查询缓慢,渲染大量数据造成卡顿。

分页查询是解决上述问题的经典方案。本文介绍在 Spring Boot + MyBatis 项目中,如何使用 PageHelper 快速实现分页功能。

二、PageHelper 简介

PageHelper 是 MyBatis 生态中非常流行的分页插件,它的核心优势在于:

1.操作简单,只需在查询前调用 startPage(),无需修改原有 SQL。

2.自动化,自动拦截 SQL,拼接 LIMIT 语句并执行 count 查询,其原理就是帮你写LIMIT语句。

3.易集成,提供 Spring Boot Starter,开箱即用。

三、环境搭建

在 pom.xml 中添加 PageHelper 的 Spring Boot Starter:

<!-- pageHelper 坐标 -->
<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper-spring-boot-starter</artifactId>
    <version>1.4.6</version>
</dependency>

为了前后端数据格式统一,定义一个通用的分页结果类 PageBean:

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

total:告诉前端一共有多少条数据,用于计算总页数
items:当前页的具体数据

四、核心使用方式

十分简单,只需一行代码就能开启分页查询:

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

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

 以项目中的文章列表查询为例,完整展示从 Controller 到 Mapper 的分页实现链路。

Controller 层


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

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

要点说明:
pageNum:当前页码(从 1 开始)
pageSize:每页显示条数
categoryId 和 state 是业务查询条件,使用 required = false 表示可选

注意返回值的类型。

Service 层

这是分页逻辑的核心层:

@Override
public PageBean<Article> list(Integer pageNum, Integer pageSize, 
                              Integer categoryId, String state) {
    // 1. 创建 PageBean 对象
    PageBean<Article> pb = new PageBean<>();

    // 2. 开启分页查询
    PageHelper.startPage(pageNum, pageSize);

    // 3. 调用 Mapper 查询(此时返回的 List 实际是 Page 类型)
    Map<String, Object> map = ThreadLocalUtil.get();
    Integer userid = (Integer) map.get("id");
    List<Article> as = articleMapper.list(userid, categoryId, state);

    // 4. 强转为 Page 对象,获取分页信息
    Page<Article> p = (Page<Article>) as;

    // 5. 封装结果
    pb.setTotal(p.getTotal());
    pb.setItems(p.getResult());
    return pb;
}

第四步转化的目的是使用Page类中的方法获取具体的分页信息,这个类是由Pagehelper提供的。

Mapper 层

正常写就行,没有什么变动:

<select id="list" resultType="org.example.pojo.Article">
    select * from article
    <where>
        <if test="categoryId != null">
            category_id = #{categoryId}
        </if>
        <if test="state != null">
            and state = #{state}
        </if>
        and create_user = #{userid}
    </where>
</select>

PageHelper 会自动完成两件事:
执行 count 查询:SELECT COUNT(*) FROM article WHERE ...
拼接分页 SQL:在原 SQL 后添加 LIMIT offset, pageSize

六、PageHelper 工作原理(简述)

PageHelper 通过 MyBatis 的 Interceptor(拦截器) 机制,在执行查询时自动改写 SQL。startPage() 方法将分页参数放入 ThreadLocal,确保同一线程中的下一次查询被拦截处理。属于AOP编程思想,但并不是通过SpringBoot的AOP实现的,而是基于MyBatis的拦截机制。

七、总结

通过 PageHelper,我们在 Spring Boot 项目中实现了近乎零侵入的分页功能:
加依赖:pagehelper-spring-boot-starter
封装结果 : PageBean<T>
一行开启 : PageHelper.startPage(pageNum, pageSize)
正常查询 : Mapper SQL 无需改动

进行强转:List->Page
提取结果 : Page.getTotal() + Page.getResult()
这种设计让分页逻辑与业务代码完全解耦,是我们日常开发中非常推荐的分页方案。

以上就是SpringBoot整合PageHelper实现分页查询功能的详细内容,更多关于SpringBoot PageHelper分页查询的资料请关注脚本之家其它相关文章!

相关文章

  • SpringBoot3实战教程之实现接口签名验证功能

    SpringBoot3实战教程之实现接口签名验证功能

    接口签名是一种重要的安全机制,用于确保 API 请求的真实性、数据的完整性以及防止重放攻击,这篇文章主要介绍了SpringBoot3实战教程之实现接口签名验证功能,需要的朋友可以参考下
    2025-04-04
  • Java设计模式之原型模式的示例详解

    Java设计模式之原型模式的示例详解

    原型模式(Prototype Pattern)指使用原型实例指定创建对象的种类,并且通过拷贝这些原型创建新的对象。本文将通过案例详细讲解一下原型模式,感兴趣的可以了解一下
    2022-02-02
  • 深入了解volatile和Java内存模型

    深入了解volatile和Java内存模型

    在本篇文章当中,主要给大家深入介绍Volatile关键字和Java内存模型。在文章当中首先先介绍volatile的作用和Java内存模型,然后层层递进介绍实现这些的具体原理、JVM底层是如何实现volatile的和JVM实现的汇编代码以及CPU内部结构,感兴趣的可以了解一下
    2022-08-08
  • 详解java创建一个女朋友类(对象啥的new一个就是)==建造者模式,一键重写

    详解java创建一个女朋友类(对象啥的new一个就是)==建造者模式,一键重写

    这篇文章主要介绍了java建造者模式一键重写,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-04-04
  • Java中使用正则表达式获取网页中所有图片的路径

    Java中使用正则表达式获取网页中所有图片的路径

    这篇文章主要介绍了Java中使用正则表达式获取网页中所有图片的路径,本文直接给出实例代码,需要的朋友可以参考下
    2015-06-06
  • JAVA设计模式---原型模式你了解吗

    JAVA设计模式---原型模式你了解吗

    这篇文章主要介绍了JAVA 原型模式的的相关资料,文中讲解非常细致,实例帮助大家更好的理解和学习,感兴趣的朋友可以了解下
    2021-09-09
  • hadoop 单机安装配置教程

    hadoop 单机安装配置教程

    单机安装主要用于程序逻辑调试。安装步骤基本通分布式安装,包括环境变量,主要Hadoop配置文件,SSH配置等,需要的朋友可以参考下
    2012-11-11
  • Java的StringBuilder在高性能场景下的正确用法

    Java的StringBuilder在高性能场景下的正确用法

    StringBuilder 对字符串的操作是直接改变字符串对象本身,而不是生成新的对象,所以新能开销小.与StringBuffer相比StringBuilder的性能略高,StringBuilder则没有保证线程的安全,从而性能略高于StringBuffer,需要的朋友可以参考下
    2023-05-05
  • MyBatis实现CRUD的示例代码

    MyBatis实现CRUD的示例代码

    本文主要介绍了MyBatis实现CRUD的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2024-12-12
  • eclipse项目在IDEA中打开并运行的详细图文教程

    eclipse项目在IDEA中打开并运行的详细图文教程

    这篇文章主要给大家介绍了关于eclipse项目在IDEA中打开并运行的详细图文教程,至从使用IDEA开发工具以来,不少次有使用IDEA运行Eclipse项目或非Maven项目,所以这里给大家总结下,需要的朋友可以参考下
    2023-09-09

最新评论