【SpringBoot】SpringBoot中分页插件（PageHelper）的使用

于 2024-08-14 20:18:15 发布
阅读量454 收藏 4
点赞数 12
分类专栏： SpringBoot的学习 文章标签： SpringBoot java 后端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_62555748/article/details/141144654
版权

目录

1.分页概念

2.原生写法

3.PageHelper插件分页查询

3.1 介绍

3.2 使用

3.3 Page对象和PageInf对象

1.分页概念

用户查询的数据不可能一次性全部展示给用户（如果用户有一万条数据呢），而是分页展示给用户，这就是分页查询。

2.原生写法

步骤：

controller层：

  1. 接受请求，请求数据=页码+每页数量+查询条件（非必须）
  2. 调用业务层完成分页查询
  3. 将结果响应给前端

service层：

  1. 换算起始查询的行号（就是用户点击的第几页，该页的第一条是数据的第几行）
  2. 调用数据层完成分页查询
  3. 调用数据层完成数量的查询
  4. 封装结果（数据+数量）【创建一个对象接受】
  5. 返回给controller层

mapper层：

  1. 动态SQL拼接带条件的分页查询数据（数据）
  2. 动态查询符合条件的数据总数（数量）

为啥要封装一个对象接受呢？

客户端需要两条数据，一个是分页查询的数据，还有一个是分页查询的总条数，但是返回值只能返回一个，因此要封装在一个对象中，代码如下。

package com.its.domain;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.util.List;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class PageResult {
    private Object data;
    private Long total;
}

案例测试

需求：将所有的房间分页查询出来展示。

controller层方法

package com.its.controller;

import com.its.domain.PageResult;
import com.its.domain.Result;
import com.its.domain.Room;
import com.its.service.TestService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {
    @PostMapping("/selectAllRoom")
    public Result selectAllRoom(Room room, Integer pageNo, Integer pageSize){
//        1.接受请求，请求数据为 页码数+每页的数量+查询的条件
        return testService.selectAllRoom(room,pageNo,pageSize);
    }
}

service层代码

package com.its.service.Impl;

import com.github.pagehelper.Page;
import com.github.pagehelper.PageHelper;
import com.its.domain.PageResult;
import com.its.domain.Result;
import com.its.domain.Room;
import com.its.mapper.TestMapper;
import com.its.service.TestService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class TestServiceImpl implements TestService {

    @Override
    public Result selectAllRoom(Room room, Integer pageNo, Integer pageSize) {
//        将页码数换算成行数
        int pageStart = (pageNo-1)*pageSize;
//        调用mapper层完成分页查询
        List<Room> rooms = testMapper.selectAllRoom(room, pageStart, pageSize);
//        再查询总数量
        long total = testMapper.selectTotal(room);
//        封装成对象返回
        Result result = new Result(rooms, total);
        return result;
    }
}

mapper

package com.its.mapper;

import com.its.domain.PageResult;
import com.its.domain.Room;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Param;

import java.util.List;

@Mapper
public interface TestMapper {
//    原生分页查询
    List<Room> selectAllRoom(@Param("room") Room room,
                             @Param("pageStart") Integer pageStart,
                             @Param("pageSize") Integer pageSize);
    int selectTotal(@Param("room") Room room);
}

xml映射SQL文件

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.its.mapper.TestMapper">
//分页查询符合条件的数据
    <select id="selectAllRoom" resultType="com.its.domain.Room">
        select * from room
        <where>
            <if test="room.info!=null and room.info!=''">
                info like concat('%',#{room.info},'%')
            </if>
        </where>
        limit #{pageStart},#{pageSize}
    </select>
//查询总数量
    <select id="selectTotal" resultType="java.lang.Integer">
        select count(1) from room
        <where>
            <if test="room.info!=null and room.info!=''">
                info like concat('%',#{room.info},'%')
            </if>
        </where>

    </select>
</mapper>

在postMan中测试得到如下结果，分页查询完成

3.PageHelper插件分页查询

3.1 介绍

步骤：

controller层（不变）：

  1. 接受请求，请求数据=页码+每页数量+查询条件（非必须）
  2. 调用业务层完成分页查询
  3. 将结果响应给前端

service层：

  1. 调用PageHelper中的 startPage(参数页码，每页数量) 方法，然后返回一个Page对象。
  2. 调用数据层完成分页查询
  3. 直接用Page对象中的方法封装结果(数据+数量)
  4. 返回给controller层

mapper层：

  1. 直接动态SQL拼接带查询条件的查询(SQL语句中不用使用limit)

【原理介绍】

流程其实是一样的，只是该插件在内部封装了一些方法供我们使用。PageHelper插件基于拦截的原理实现对mapper层编写的SQL语句进行二次处理，如下：

  • 会给查询的SQL语句进行语句拼接，添加limit，并赋值分页条件
  • 会动态生成查询数量的SQL语句并执行。
  • 会将分页相关的所有结果（分页数量+数量+页码数+起始查询行号+每页的数量等）封装到一个Page对象中。

Page中方法介绍：

3.2 使用

代码书写，还是以上面为例。

（1）导入PageHelper所需依赖

<!--分页插件依赖-->
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper-spring-boot-starter</artifactId>
            <version>1.4.7</version>
        </dependency>

（2）controller层

package com.its.controller;

import com.its.domain.PageResult;
import com.its.domain.Result;
import com.its.domain.Room;
import com.its.service.TestService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {
    @Autowired
    TestService testService;
    @PostMapping("/selectAll")
//参数为查询条件，页数，每页的展示数
    public PageResult selectAll(Room room,Integer pageNo,Integer pageSize){
        PageResult pageResult = testService.selectAll(room, pageNo, pageSize);
        return pageResult;
    }
 
}

（3）service层

package com.its.service.Impl;

import com.github.pagehelper.Page;
import com.github.pagehelper.PageHelper;
import com.its.domain.PageResult;
import com.its.domain.Result;
import com.its.domain.Room;
import com.its.mapper.TestMapper;
import com.its.service.TestService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class TestServiceImpl implements TestService {
    @Autowired
    TestMapper testMapper;
    @Override
    public PageResult selectAll(Room room, Integer pageNo, Integer pageSize) {
//        开启分页查询,当执行查询时，插件进行相关的sql拦截进行分页操作，返回一个page对象
        Page<Room> page = PageHelper.startPage(pageNo, pageSize);
//        调用mapper层完成查询
        testMapper.selectAll(room);
//        封装结果
        PageResult pageResult = new PageResult(page.getResult(), page.getEndRow());
        System.out.println(pageResult);
        System.out.println(page);
        return pageResult;
    }

   
}

（4）mapper层

package com.its.mapper;

import com.its.domain.PageResult;
import com.its.domain.Room;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Param;

import java.util.List;

@Mapper
public interface TestMapper {
//    使用分页插件分页查询
    List<Room> selectAll(@Param("room") Room room);
}

（5）xml映射文件

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.its.mapper.TestMapper">


    <select id="selectAll" resultType="com.its.domain.Room">
        select * from room
    </select>
   
</mapper>

（6）测试结果：

3.3 Page对象和PageInf对象

在 PageHelper 中，Page 和 PageInfo 都是用来处理分页数据的重要类。

Page对象

  • Page 是一个接口，它包含分页数据以及一些基本的分页信息（如总记录数、当前页等）。当使用 PageHelper 进行分页查询时，查询结果会被自动封装到一个实现了 Page 接口的对象中。

PageInfo对象

  • PageInfo 是 PageHelper 提供的一个类，用于封装更详细的分页信息。它不仅包含了分页数据，还提供了更多的辅助信息，如是否为第一页、最后一页、导航页码等。

使用PageInfo进行上面的替换，业务层代码为

空谷忧人
关注
  • 12
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
SpringBoot集成MyBatis的分页插件PageHelper实例代码
08-29
本文主要介绍了 SpringBoot 集成 MyBatis 的分页插件 PageHelper 的相关操作，涵盖了 PageHelper 的基本概念、使用步骤、集成 MyBatis 的分页插件 PageHelper 的实例代码等内容。 一、PageHelper 简介 PageHelper ...
SpringBoot+Mybatis+Druid+PageHelper实现多数据源并分页方法
08-26
在本文中，我们将深入探讨如何使用SpringBoot、Mybatis、Druid和PageHelper来实现多数据源和分页功能。首先，SpringBoot是基于Spring框架的简化版本，它旨在简化微服务开发，提供了自动配置、内嵌式Web服务器以及...
SpringBoot中分页插件PageHelper的使用
qq_42012908的博客
03-11 173
1、引入依赖 <!--分页插件pagehelper--> <dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper-spring-boot-starter</artifactId> <version>1.2.10</version>
springboot中分页插件pageHelper的使用
wickedvalley
03-12 4797
优点：无需你自己去封装以及关心sql分页等问题，使用很方便，前端取数据也很方便。 1.包的依赖 &lt;!--pagehelper --&gt; &lt;dependency&gt; &lt;groupId&gt;com.github.pagehelper&lt;/groupId&gt; &lt;artifac...
SpringBoot中使用Mybatis分页插件PageHelper
xdscode的博客
04-13 356
1.引入依赖 <dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper</artifactId> <version>4.1.3</version> </dependency> 2.代码中调用 ...
spring boot 中分页插件PageHelper的使用
y19980522的博客
06-21 671
PageHelper它的优缺点： 优点：封装分页sql，使我们不需要每个地方都去写分页的查询语句；同时，使我们select的sql语句向下兼容，换了数据库也不需要更改sql代码。 缺点：pagehelper数据量达到一定数量时limit分页时会特别慢，count（*）会把数据库卡死。 (1)加入PageHelper的启动依赖 <dependency> <groupId>com.github.pagehelper</groupId> <a
SpringBoot项目中分页插件PageHelper无效的问题及解决方法
08-19
但是，在 SpringBoot 项目中使用 PageHelper 时，经常会遇到一些问题，例如插件失效、无法分页等问题。今天，我们将要讨论的就是 SpringBoot 项目中分页插件 PageHelper 无效的问题及解决方法。 首先，让我们了解...
Springboot整合分页插件PageHelper步骤解析
08-18
Springboot整合分页插件PageHelper步骤解析 一、概述 在本文中，我们将详细介绍如何在 Spring Boot 项目中整合分页插件 PageHelper，包括引入依赖、配置文件配置和使用方法。PageHelper 是一个功能强大且广泛使用...
springBoot+mybatis集成插件pageHelper
08-09
PageHelper是MyBatis的一个分页插件，它使得在进行数据查询时能够方便地实现分页功能。下面我们将详细介绍如何将PageHelper集成到Spring Boot项目中，以及它的工作原理和优势。 **1. 集成PageHelper** 首先，我们...
springboot民办高校科研项目管理系统-计算机毕业设计源码54009
VX_DZbishe的博客
08-11 475
论文主要是对基于springboot的民办高校科研项目管理系统进行了介绍，包括研究的现状，还有涉及的开发背景，然后还对系统的设计目标进行了论述，还有系统的需求以及整个的设计方案，对系统的设计以及实现，也都论述的比较细致，最后对基于springboot的民办高校科研项目管理系统进行了一些具体测试。本次报告，首先分析了研究的背景、作用、意义，为研究工作的合理性打下了基础。
SpringBoot快速入门（手动创建）
m0_74124657的博客
08-11 419
代码如下//引导类项目的入口//注解添加导入进来你可以浏览器中查看自己编写的代码，看是否正确localhost：你命名的端口号（默认是8080。后面你也可以在配置文件修改）
集合（1）
最新发布
supercool7的博客
08-12 763
表示不同的类型集合，Collection、Map、List、Set、Queue、Deque等，以及辅助性质的接口Iterator、LinkIterator、Comparator、Comparable这些接口是为迭代和比较元素而准备。对接口的具体实现，主要常用的有：ArrayList、LinkedList、HashMap、HashSet、TreeMap等等。理解Java集合体系可以从三个层次：最上层的接口、中间的抽象类、最后的实现类。是所有集合框架的根接口，包含了对集合进行基本操作的方法。
反射和注解
supercool7的博客
08-08 298
反射的基本步骤包括获取Class对象、获取类的信息（构造函数、方法、字段等），然后通过Constructor、Method、Field等类的实例进行具体的操作。注解以@符号开头，通常紧跟着一个标识符，后面可以跟一些参数，用于给类、方法、字段等添加元数据信息，这些信息可以在编译时、运行时被读取和处理。通过Class类，可以获取类的构造函数、方法、字段等信息，而不需要在编译时确定这些信息。Spring、SpringBoot、Mybatis等框架中都大量使用了反射机制。此外，开发者还可以定义自己的注解，通过。
安卓Android & JAVA校招/实习面试合集:多线程、强软弱虚引用、进程、内存管理、Activity、Fragment......
qq_41915623的博客
08-10 471
安卓Android、java面试资料合集：内存管理、多线程、进程、强软弱虚应用、Activity
Java：继承，this，super
m0_75257168的博客
08-10 378
可以同名，但参数列表不能相同（有参无参构造）
Spring一个强大便捷的代理工厂类
330553352的专栏
08-10 306
但如果你需要一种更加灵活和可配置性，那么Spring还提供了一个非常方便强大的ProxyFactoryBean类，该类特别适合那些需要更多自定义和控制的场景，例如当你需要为特定的Bean创建代理，或者需要在不修改原始代码的情况下为现有类添加额外的功能时。在Spring框架中，AOP（面向切面编程）是一种强大的编程范式，它允许开发者在不修改原有代码的情况下，为程序添加额外的功能，如日志记录、事务管理、安全控制等。在上面配置拦截器时，我们都是指定的具体拦截器，其实我们还可以使用通配符，指定拦截器。
DSL domain specific language of Kola
AK15221736052的博客
08-08 764
Kola 从 SmartBear 的 PactFlow, Spring clout Contract, Spock, Karate 等前辈上得到很多参考和灵感；直接用 ApiHug 上下文的 api 可以有更丰富的上下文， 关于request, response 的定义， path, 参数， 校验规则。但是 BDD 的表达方式，真的是太好了，兼顾程序世界的结构化，和非程序世界的通俗易懂；更不用说， 测试界的基石: Junit5, TestNG, AssertJ 等基础框架；在 ApiHug 上下文，
【智能排班系统】SpringBoot整合邮件发送服务
记录一名在读研究生的学习笔记、感悟、开发产物
08-12 296
本文档指导如何配置Spring Boot应用以通过QQ邮箱发送邮件。首先，用户需登录QQ邮箱并开启SMTP服务以获取授权码。随后，在Spring Boot项目中，通过`application.yml`配置文件指定SMTP服务器的地址、端口及认证信息等参数。此外，还介绍了如何创建一个配置类`MailConfig`来读取这些配置，并使用Lombok简化getter和setter方法。为了封装邮件发送所需的属性，文档还提供了`EmailDto`类。
springboot导入com.github.pagehelper.PageHelper
07-28
要在Spring Boot项目中导入com.github.pagehelper.PageHelper，你需要按照以下步骤进行操作： 1. 在你的项目的pom.xml文件中，添加以下依赖项： ```xml <dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper-spring-boot-starter</artifactId> <version>1.2.13</version> </dependency> ``` 2. 在你的Spring Boot应用程序的配置文件（通常是application.properties或application.yml）中，配置PageHelper的属性。例如，你可以添加以下属性： ```properties # 开启PageHelper支持 pagehelper.helper-dialect=mysql pagehelper.reasonable=true pagehelper.support-methods-arguments=true pagehelper.params=count=countSql ``` 这些属性可以根据你的具体需求进行配置。 3. 在你的Mapper接口中使用PageHelper来实现分页查询。例如： ```java import com.github.pagehelper.PageHelper; import org.apache.ibatis.annotations.Mapper; import java.util.List; @Mapper public interface YourMapper { // 分页查询方法示例 List<YourEntity> selectByPage(int pageNum, int pageSize); } ``` 4. 在你的Service或Controller层调用Mapper接口中的分页查询方法，并传入页码和每页大小参数。例如： ```java import com.github.pagehelper.PageInfo; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; import java.util.List; @Service public class YourService { @Autowired private YourMapper yourMapper; public PageInfo<YourEntity> getEntitiesByPage(int pageNum, int pageSize) { // 使用PageHelper进行分页查询 PageHelper.startPage(pageNum, pageSize); List<YourEntity> entities = yourMapper.selectByPage(pageNum, pageSize); return new PageInfo<>(entities); } } ``` 这样，你就成功地在Spring Boot项目中导入了com.github.pagehelper.PageHelper，并可以使用它进行分页查询了。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值