使用 PageHelper 在 Spring Boot 项目中实现分页查询

目录

  • 前言
  • 1. 项目环境配置
    • 1.1 添加 PageHelper 依赖
    • 1.2 数据库和 MyBatis 配置
  • 2. 统一的分页响应类
  • 3. 使用 PageHelper 实现分页查询
    • 3.1 Service 层分页查询实现
    • 3.2 PageHelper 分页注意事项
  • 4. 控制层调用示例
  • 5. 常见问题与解决方案
    • 5.1 `java.util.ArrayList cannot be cast to com.github.pagehelper.Page`
    • 5.2 分页参数未生效,返回全部数据
  • 结语

前言

在 Web 应用开发中,分页查询是非常常见的需求,特别是在涉及大量数据的应用场景中,通过分页可以减少数据加载压力,提升系统性能。然而,手动实现分页查询需要编写繁琐的 SQL 语句和逻辑代码,容易出现错误。为了简化分页实现,我们可以借助 PageHelper 这一优秀的分页插件,它能够无缝整合进 Spring Boot 项目,快速实现分页功能。本文将详细介绍如何在 Spring Boot 中整合 PageHelper,并通过示例演示如何进行分页查询。
在这里插入图片描述

1. 项目环境配置

1.1 添加 PageHelper 依赖

首先,在 Spring Boot 项目中的 pom.xml 文件中添加 PageHelper 的依赖项。本文使用 pagehelper-spring-boot-starter 作为依赖包,该依赖能够自动配置 PageHelper,减少手动配置的复杂性。以下是 Maven 依赖的示例:

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

添加依赖后,PageHelper 将会自动被 Spring Boot 扫描并加载到上下文中,无需额外配置。此处的 1.4.6 版本适用于 Spring Boot 2.0+ 版本,如果使用其他版本的 Spring Boot,确保选择兼容的 PageHelper 版本。

1.2 数据库和 MyBatis 配置

application.yml 中,完成数据库的基本配置,并确认已经集成了 MyBatis。以下是一个基础的数据库配置示例:

spring:datasource:url: jdbc:mysql://localhost:3306/testdbusername: rootpassword: passworddriver-class-name: com.mysql.cj.jdbc.Drivermybatis:mapper-locations: classpath:mapper/*.xml

2. 统一的分页响应类

为了方便返回分页数据并使返回结果具有一致性,可以定义一个统一的分页响应类。例如,定义一个 PageResponse<T> 类,该类包含总页数、总条数、当前页数据等信息。

public class PageResponse<T> {private long total;       // 总记录数private int pages;        // 总页数private List<T> data;     // 当前页数据public PageResponse(long total, int pages, List<T> data) {this.total = total;this.pages = pages;this.data = data;}// Getters and Setters
}

在实际使用中,通过 PageHelper 查询得到的 PageInfo 对象中包含分页信息,可以将其数据提取并填充到 PageResponse 中,以统一格式返回。

3. 使用 PageHelper 实现分页查询

在配置好依赖和基础环境后,接下来在 Service 层中使用 PageHelper 实现分页查询。假设有一个 UserService 用于处理用户数据查询,可以按以下步骤实现分页功能。

3.1 Service 层分页查询实现

PageHelper 的分页逻辑非常简单,只需在查询方法中通过 PageHelper.startPage(pageNum, pageSize) 设置分页参数,接着调用查询方法,即可获得分页结果。以下示例展示了 UserService 的实现:

@Service
public class UserService {@Autowiredprivate UserMapper userMapper;public PageResponse<User> getUsers(int pageNum, int pageSize) {PageHelper.startPage(pageNum, pageSize);   // 设置分页参数List<User> userList = userMapper.selectAll();  // 执行查询PageInfo<User> pageInfo = new PageInfo<>(userList); // 使用PageInfo包装分页结果// 使用PageResponse返回统一分页格式return new PageResponse<>(pageInfo.getTotal(), pageInfo.getPages(), pageInfo.getList());}
}

getUsers() 方法中,首先通过 PageHelper.startPage() 设置分页参数,随后调用 selectAll() 执行数据库查询。PageHelper 会拦截该查询并自动添加分页 SQL,返回的 userList 为分页结果,然后用 PageInfo 包装查询结果。

3.2 PageHelper 分页注意事项

  1. startPage 方法的调用位置PageHelper.startPage(pageNum, pageSize) 必须在查询方法之前调用,否则分页信息将不会生效。
  2. 自动分页结果类型selectAll() 返回的 userList 实际上是 Page 类型的 ListPage 实现了 List 接口,因此可以正常操作。但直接强制转换为 Page 可能会导致错误,正确的方式是将结果用 PageInfo 包装。
  3. 版本兼容性问题:如果使用 PageHelper 版本与 Spring Boot 不兼容,可能会导致分页信息不正确。确保选择正确的版本,如 PageHelper 1.4.6Spring Boot 2.0+ 兼容性良好。

4. 控制层调用示例

在控制器层调用 UserServicegetUsers() 方法,并将 PageResponse 数据返回给前端。以下是一个简单的控制层示例:

@RestController
@RequestMapping("/users")
public class UserController {@Autowiredprivate UserService userService;@GetMapping("/page")public ResponseEntity<PageResponse<User>> getUsers(@RequestParam int pageNum, @RequestParam int pageSize) {PageResponse<User> pageResponse = userService.getUsers(pageNum, pageSize);return ResponseEntity.ok(pageResponse);}
}

通过 @GetMapping("/page") 实现分页查询接口,前端可以通过传递 pageNumpageSize 参数来控制分页查询的页码和每页数量。

5. 常见问题与解决方案

5.1 java.util.ArrayList cannot be cast to com.github.pagehelper.Page

出现此异常的原因通常是因为尝试将 ArrayList 强制转换为 Page 类型。实际上,分页查询返回的 ListPage 的实例,但我们不应该直接进行类型转换,而是通过 PageInfo 进行包装,这样可以避免强制转换带来的问题。

5.2 分页参数未生效,返回全部数据

如果 PageHelper 无法获取正确的分页参数,导致返回所有数据,可能是以下原因之一:

  • 版本兼容性问题:确保 PageHelperSpring Boot 的版本兼容。推荐 PageHelper 1.4.6 版本与 Spring Boot 2.0+
  • 调用顺序问题PageHelper.startPage() 必须在查询数据库之前调用,否则分页不会生效。

通过确认上述设置,基本可以解决分页参数未生效的问题。

结语

在 Spring Boot 项目中整合 PageHelper 可以大大简化分页查询的实现。本文详细介绍了 PageHelper 的配置方法、Service 层分页查询的实现步骤,以及常见问题的解决方法。通过 PageHelper,我们可以方便地对数据库数据进行分页处理,提升系统的查询效率和用户体验。希望本文内容能为大家在实际开发中带来帮助。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/885540.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

【C++】C++移动语义、左值右值、左值引用右值引用、移动构造函数、std::move、移动赋值操作符

二十五、C移动语义、左值和右值、左值引用右值引用、移动构造函数、std::move、移动赋值操作符 本部分讨论一些更高级的C特性&#xff1a;C移动语义。但是讲移动语义之前我们得先了解什么左值右值、左值引用和右值引用。 1、C的左值和右值、左值引用和右值引用左值是有地址的…

【国内中间件厂商排名及四大中间件对比分析】

国内中间件厂商排名 随着新兴技术的涌入&#xff0c;一批国产中间件厂商破土而出&#xff0c;并在短时间内迅速发展&#xff0c;我国中间件市场迎来洗牌&#xff0c;根据市占率&#xff0c;当前我国中间件厂商排名依次为&#xff1a;东方通、宝兰德、中创股份、金蝶天燕、普元…

Android自启动管控

1. 自启动管控需求来源 自启动、关联启动、交叉启动、推送启动等现象的泛滥除了对个人信息保护带来隐患外&#xff0c;还会导致占用过多的系统CPU和内存资源&#xff0c;造成系统卡顿、发热、电池消耗过快&#xff1b;还可能引入一些包含“恶意代码”的进程在后台隐蔽启动&…

C++上机实验|多态性编程练习

1.实验目的 (1)理解多态性的概念。 (2)掌握如何用虚函数实现动态联编 (3)掌握如何利用虚基类。 2.实验内容 设计一个飞机类 plane,由它派生出歼击机类fighter和轰炸机类 bomber,歼击机类fighter 和轰炸机类bomber 又共同派生出歼轰机(多用途战斗机)。利用虚函数和虚基类描述…

ctfshow(328)--XSS漏洞--存储型XSS

Web328 简单阅读一下页面。 是一个登录系统&#xff0c;存在一个用户管理数据库。 那么我们注册一个账号&#xff0c;在账号或者密码中植入HTML恶意代码&#xff0c;当管理员访问用户管理数据库页面时&#xff0c;就会触发我们的恶意代码。 思路 我们向数据库中写入盗取管理员…

Kubernetes的概述与架构

Kubernetes 的概述 Kubernetes 是一个可移植、可扩展的开源平台&#xff0c;用于管理容器化的工作负载和服务&#xff0c;方便进行声明式配置和自动化。Kubernetes 拥有一个庞大且快速增长的生态系统&#xff0c;其服务、支持和工具的使用范围广泛。 Kubernetes 这个名字源于…

crond 任务调度 (Linux相关指令:crontab)

相关视频链接 crontab 进行 定时任务 的设置 概述 任务调度&#xff1a;是指系统在某个时间执行的特定的命令或程序 任务调度的分类&#xff1a; 1.系统工作&#xff1a;有些重要的工作必须周而复始地执行。如病毒扫描等。 2.个别用户可能希望执行某些程序&#xff0c;比如…

408最后冲刺阶段,怎么做题才能考到120+?

C哥专业提供——计软考研院校选择分析专业课备考指南规划 重要性排序如下&#xff1a;真题占据首位&#xff0c;紧随其后的是王道模拟题&#xff0c;王道书与题目则紧随其后&#xff0c;而408统考配套习题&#xff08;高教版&#xff09;与之大致相当。 真题&#xff0c;无疑…

uniapp上拉刷新下拉加载

方法一&#xff1a; z-paging 的组件库&#xff1a; show-loading-more-no-more-view"false" 该属性控制是否显示 "加载更多" 或 "没有更多" 的提示。如果设为 false&#xff0c;则不会显示这些提示。如果设为 true&#xff0c;当数据加载完毕…

Java I/O(输入/输出)——针对实习面试

目录 Java I/O&#xff08;输入/输出&#xff09;什么是Java I/O流&#xff1f;字节流和字符流有什么区别&#xff1f;什么是缓冲流&#xff1f;为什么要使用缓冲流&#xff1f;Java I/O中的设计模式有哪些&#xff1f;什么是BIO&#xff1f;什么是NIO&#xff1f;什么是AIO&am…

AJAX 全面教程:从基础到高级

AJAX 全面教程&#xff1a;从基础到高级 目录 什么是 AJAXAJAX 的工作原理AJAX 的主要对象AJAX 的基本用法AJAX 与 JSONAJAX 的高级用法AJAX 的错误处理AJAX 的性能优化AJAX 的安全性AJAX 的应用场景总结与展望 什么是 AJAX AJAX&#xff08;Asynchronous JavaScript and XML…

本地保存mysql凭据实现免密登录mysql

本地保存mysql凭据 mysql加密登录文件简介加密保存mysql用户的密码到本地凭据 mysql加密登录文件简介 要在 mysql客户端 上连接 MySQL 而无需在命令提示符上输入用户名和口令&#xff0c;下列三个位置可用于存储用户的mysql 凭证来满足此要求。 配置文件my.cnf或my.ini /etc…

图形几何之美系列:仿射变换矩阵(二)

“ 在几何计算、图形渲染、动画、游戏开发等领域&#xff0c;常需要进行元素的平移、旋转、缩放等操作&#xff0c;一种广泛应用且简便的方法是使用仿射变换进行处理。相关的概念还有欧拉角、四元数等&#xff0c;四元数在图形学中主要用于解决旋转问题&#xff0c;特别是在三维…

Jmeter的安装,设置中文,解决乱码问题

1.Jmeter安装 1-Jmeter如何下载 1---我这里提供一个下载快的方式 https://www.123684.com/s/lWZKVv-4jiav?提取码:4x4y 2---Jmeter官网下载地址 Apache JMeter - Download Apache JMeter 2-配置java环境 1---下载javaJDK 官方下载地址 https://www.oracle.com/java/techno…

【Uniapp】Uniapp Android原生插件开发指北

前言 在uniapp开发中当HBuilderX中提供的能力无法满足App功能需求&#xff0c;需要通过使用Andorid/iOS原生开发实现时&#xff0c;或者是第三方公司提供的是Android的库&#xff0c;这时候可使用App离线SDK开发原生插件来扩展原生能力。 插件类型有两种&#xff0c;Module模…

微信小程序——用户隐私保护指引填写(详细版)

✅作者简介&#xff1a;2022年博客新星 第八。热爱国学的Java后端开发者&#xff0c;修心和技术同步精进。 &#x1f34e;个人主页&#xff1a;Java Fans的博客 &#x1f34a;个人信条&#xff1a;不迁怒&#xff0c;不贰过。小知识&#xff0c;大智慧。 &#x1f49e;当前专栏…

reg注册表研究与物理Hack

reg注册表研究与物理Hack 声明&#xff1a;内容的只是方便各位师傅学习知识&#xff0c;以下网站只涉及学习内容&#xff0c;其他的都与本人无关&#xff0c;切莫逾越法律红线&#xff0c;否则后果自负。 目录 reg注册表研究与物理HackWindows注册表修改注册表实现应用程序开机…

[论文粗读][REALM: Retrieval-Augmented Language Model Pre-Training

引言 今天带来一篇检索增强语言模型预训练论文笔记——REALM: Retrieval-Augmented Language Model Pre-Training。这篇论文是在RAG论文出现之前发表的。 为了简单&#xff0c;下文中以翻译的口吻记录&#xff0c;比如替换"作者"为"我们"。 语言模型预训练…

深入浅出WebSocket(实践聊天室demo)

文章目录 什么是WebSocket?WebSocket连接过程WebSocket与Http的区别重连机制完整代码使用方法心跳机制实现聊天室demo(基于Socket.io)参考文章、视频小广告~什么是WebSocket? WebSocket 是一种在单个TCP连接上进行全双工通信的协议(计算机网络应用层的协议) 在 WebSocket A…

RabbitMQ队列详细属性(重要)

RabbitMQ队列详细属性 1、队列的属性介绍1.1、Type&#xff1a;队列类型1.2、Name&#xff1a;队列名称1.3、Durability&#xff1a;声明队列是否持久化1.4、Auto delete&#xff1a; 是否自动删除1.5、Exclusive&#xff1a;1.6、Arguments&#xff1a;队列的其他属性&#xf…