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

news2024/11/24 14:38:29

目录

  • 前言
  • 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/testdb
    username: root
    password: password
    driver-class-name: com.mysql.cj.jdbc.Driver
  mybatis:
    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 {
    @Autowired
    private 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 {
    @Autowired
    private 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.coloradmin.cn/o/2238794.html

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

相关文章

丹摩征文活动 | 丹摩智算:大数据治理的智慧引擎与实践探索

丹摩DAMODEL&#xff5c;让AI开发更简单&#xff01;算力租赁上丹摩&#xff01; 目录 一、引言 二、大数据治理的挑战与重要性 &#xff08;一&#xff09;数据质量问题 &#xff08;二&#xff09;数据安全威胁 &#xff08;三&#xff09;数据管理复杂性 三、丹摩智算…

彻底理解ARXML中的PDU

文章目录 一、DBC报文信号的发送二、ARXML报文信号的发送2.1 什么是PDU2.2 PDU的类型2.3 Container-I-PDU的发送 三、小结 在CANFD支持可变速率和更大的数据长度&#xff08;64字节&#xff09;的情况下&#xff0c;可以使用DBC和ARXML两种数据库格式来进行报文通信&#xff0c…

探索MoviePy:Python视频编辑的瑞士军刀

文章目录 &#x1f3ac; 探索MoviePy&#xff1a;Python视频编辑的瑞士军刀第一部分&#xff1a;背景介绍第二部分&#xff1a;MoviePy是什么&#xff1f;第三部分&#xff1a;如何安装MoviePy&#xff1f;第四部分&#xff1a;MoviePy的基本函数使用方法1. 视频剪辑2. 视频拼接…

前端请求后端php接口跨域 cors问题

只需要后端在网站的入口文件 一般都是 index.php 加上 这几行代码就可以了 具体的参数可以根据需要去修改 header("Access-Control-Allow-Origin: *"); header(Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS); header(Access-Control-Allow-Heade…

C++11的一些特性

1、列表初始化&#xff0c;对内置类型和自定义类型都可以使用列表进行初始化——一切都可以用列表初始化 不要和初始化列表混了 std::initializer_list临时对象作为函数的参数&#xff0c;用来接收{}括起来的的初始化列表 容器中有用initializer_list作为参数的构造函数&…

MySQL多系统安装配置教程(Windows、Ubuntu、Centos)

专题目标 • 掌握在Windows下安装MySQL数据库 • 掌握在CentOS下安装MySQL数据库 • 掌握在Ubuntu下安装MySQL数据库 一、在Windows下安装MySQL数据库 • Windows下推荐使用安装程序进行安装 • 安装程序下载地址&#xff1a;https://dev.mysql.com/downloads/ 通过上面的安装…

关于 npm 更新镜像源问题

npm&#xff08;Node Package Manager&#xff09;&#xff0c;是一个NodeJS包管理和分发工具&#xff0c;已经成为了非官方的发布Node模块&#xff08;包&#xff09;的标准。&#xff09; 查看当前npm版本 npm -v 10.9.0 执行以下命令报错 npm install --registryhttp…

Netty篇(入门编程)

目录 一、Hello World 1. 目标 2. 服务器端 3. 客户端 4. 流程梳理 &#x1f4a1; 提示 5. 运行结果截图 二、Netty执行流程 1. 流程分析 2. 代码案例 2.1. 引入依赖 2.2. 服务端 服务端 服务端处理器 2.3. 客户端 客户端 客户端处理器 2.4. 代码截图 一、Hel…

文本语义分块、RAG 系统的分块难题:小型语言模型如何找到最佳断点

文本语义分块、RAG 系统的分块难题&#xff1a;小型语言模型如何找到最佳断点&#xff1f; 转自jina最新的关于文本语义分块的分享和模型 之前我们聊过RAG 里文档分块 (Chunking) 的挑战&#xff0c;也介绍了 迟分 (Late Chunking) 的概念&#xff0c;它可以在向量化的时候减…

大数据技术在金融风控中的应用

&#x1f493; 博客主页&#xff1a;瑕疵的CSDN主页 &#x1f4dd; Gitee主页&#xff1a;瑕疵的gitee主页 ⏩ 文章专栏&#xff1a;《热点资讯》 大数据技术在金融风控中的应用 大数据技术在金融风控中的应用 大数据技术在金融风控中的应用 引言 大数据技术概述 定义与原理 发…

小程序中引入下载到本地的iconfont字体图标加载不出来问题解决

我这个是uniapp项目,字体图标都是一样的,在vue项目中web端、uniapp运行到h5都没问题,但是运行到小程序加载不出来,报错如下: 不让用本地路径,所以我们要转为base64编码,这里给大家提供一个工具,它可以把本地字体文件转为base64:transfonter 进入官网后,第一步: …

MYSQL隔离性原理——MVCC

表的隐藏字段 表的列包含用户自定义的列和由系统自动创建的隐藏字段。我们介绍3个隐藏字段&#xff0c;不理解也没有关系&#xff0c;理解后面的undo log就懂了&#xff1a; DB_TRX_ID &#xff1a;6 byte&#xff0c;最近修改( 修改/插入 )事务ID&#xff0c;记录创建这条记…

vue3 + element-plus 的 upload + axios + django 文件上传并保存

之前在网上搜了好多教程&#xff0c;一直没有找到合适自己的&#xff0c;要么只有前端部分没有后端&#xff0c;要么就是写的不是很明白。所以还得靠自己摸索出来后&#xff0c;来此记录一下整个过程。 其实就是不要用默认的 action&#xff0c;要手动实现上传方式 http-reque…

【C++课程学习】:二叉搜索树

&#x1f381;个人主页&#xff1a;我们的五年 &#x1f50d;系列专栏&#xff1a;C课程学习 &#x1f389;欢迎大家点赞&#x1f44d;评论&#x1f4dd;收藏⭐文章 目录 二叉树搜索树的概念&#xff1a; 节点的结构&#xff1a; ⚽️结构&#xff1a; ⚽️ 构造函数&…

Axure是什么软件?全方位解读助力设计入门

在产品设计和开发领域&#xff0c;Axure是一款大名鼎鼎且功能强大的软件&#xff0c;它为专业人士和团队提供了卓越的设计支持&#xff0c;帮助他们将创意转化为实际可操作的产品原型。 一、Axure 的基本介绍 Axure是一款专业的原型设计工具&#xff0c;主要用于创建交互式的…

java里面使用groovy案例+详解

场景&#xff1a; 最近有一个计算商品运费的&#xff0c;如果商品的数量大于快递公司设置的数量 10 那么超出部分也需要计算额外运费&#xff0c;那么这些计算过程代码我能不能不在java里面写呢&#xff0c;用一种可配置化的方式来根据不同的传参计算出运费&#xff1f; 页面传…

单体架构 IM 系统之核心业务功能实现

在上一篇技术短文&#xff08;单体架构的 IM 系统设计&#xff09;中&#xff0c;我们讨论了在 “用户规模小、开发人员少、开发时间短” 的业务背景下&#xff0c;采取 “怎么简单怎么做&#xff0c;怎么快怎么来” 的研发策略&#xff0c;于是设计了 单体架构的IM系统&#x…

Linux部署nginx访问文件403

问题描述&#xff1a;在linux服务器上通过nginx部署&#xff0c;访问文件403 新配置了一个用户来部署服务&#xff0c;将部署文件更新到原有目录下&#xff0c;结果nginx访问403 原因&#xff1a;没有配置文件的读写权限&#xff0c;默认不可读写&#xff0c;nginx无法访问到文…

解决 C/C++ 中 “invalid use of incomplete type” 编译错误

解决 C/C++ 中 “invalid use of incomplete type” 编译错误 一、错误原因二、常见场景三、解决方法四、最佳实践五、总结在 C 和 C++ 编程中,invalid use of incomplete type 错误通常发生在尝试使用一个未完全定义的类型时。这个错误表明编译器在当前上下文中没有足够的信息…

使用 Python 实现高效网页爬虫——从获取链接到数据保存

前言 在这个时代,网络爬虫已成为数据分析与信息收集不可或缺的技术之一。本文将通过一个具体的Python项目来介绍如何构建一个简单的网络爬虫,它能够自动抓取指定网站的文章链接、标题、正文内容以及图片链接,并将这些信息保存为CSV文件。 目标网站 一、准备工作 在开始编…