SpringBoot 项目如何使用 MyBatis 的分页插件 PageHelper 做分页处理

已于 2025-04-12 11:43:17 修改
阅读量1w 收藏 45
点赞数 34
分类专栏： Java 组件 文章标签： 分页插件 PageHelper SpringBoot MyBatis
于 2024-09-20 18:13:37 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Reggie97/article/details/142388065
版权

大型项目中获取数据的体量一般很大，在前段界面进行展示时为了保障展示效果，会要求接口快速返回，这时候后端一般会选择分页获取数据，只传递要查询的页码数据就可以。这种情况就避免了大部分的问题，达到快速返回的效果。

现阶段常用的分页有两种：

  • MyBatis 分页插件：PageHelper ，这个插件很常用，支持多数据库分页，无需修改SQL语句即可实现分页功能。
    • 注意：这个插件的功能相当于在你代码中的第一个 SQL 语句的后面加上 LIMIT [offset], [limit] 子句，例如 LIMIT 20, 10 ，表示从21条记录开始，获取10条记录。
    • 这个插件 只会在你的第一条语句后面添加子句 ，如果代码后面还存在其他的 SQL 则会不生效。
    • 如果你使用这个插件获取 UserId 列表，并用该列表进行后续操作，要注意返回的 顺序问题 。
  • 手动分页：PageInfo 类。

本文只介绍分页插件 PageHelper ，包括使用的依赖，创建方式，代码示例和验证结果展示等。

文章目录

一、分页信息封装类 PageInfo 是什么？

我们在使用 MyBatis 分页时，不论是使用自动分页还是手动分页都会使用 PageInfo 对象作为承接介质。

PageInfo 是一个分页信息封装类，通常用于Web应用中的分页数据展示。它可以将分页查询结果和分页参数封装在一个对象中，便于传输和使用。我们使用时会遇到以下属性：

1、存储和管理分页相关的参数，自动分页时会自动设置，而手动分页时需要手动设置。

当前页码（pageNum）、每页记录数（pageSize）、总记录数（total）、总页数（pages）

2、分页导航信息参数

是否有上一页（hasPreviousPage）、是否有下一页（hasNextPage）、是否为第一页（isFirstPage）、是否为最后一页（isLastPage）、导航页码数组（navigatepageNums）

3、PageInfo 作为后端返回给前端的标准分页数据格式，便于前端渲染分页组件。前端在使用时无需手动计算分页参数，如总页数、是否有下一页等，提高可读性和可维护性。

二、分页插件的两种依赖引入方式

1、使用 pagehelper 包

在项目中使用 PageHelper 插件需要先添加依赖，使用这种方式需要定义一个 config 文件。

<dependency>
	<groupId>com.github.pagehelper</groupId>
	<artifactId>pagehelper</artifactId>
	<version>4.1.3</version>
</dependency>

package com.wen.config;

import com.github.pagehelper.PageHelper;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import java.util.Properties;

@Configuration
public class MyBatisConfig {
	// 设置相关的参数信息，下面有对参数的详细解释
    @Bean
    public PageHelper pageHelper() {
        PageHelper pageHelper = new PageHelper();
        Properties properties = new Properties();
        properties.setProperty("dialect", "Mysql");
        properties.setProperty("offsetAsPageNum", "true");
        properties.setProperty("rowBoundsWithCount", "true");
        pageHelper.setProperties(properties);
        return pageHelper;
    }
}

Properties 中需要设置的属性值的解释：

  • "dialect", "Mysql"：不同数据库 SQL 语句不同，指定了数据库方言为 Mysql 。
  • "offsetAsPageNum", "true"：这个属性通常用于指定是否将传入的 offset 参数当作 pageNum 页码使用。
    • 设置为 true ，意味着如果分页查询时传递了 offset 偏移量，PageHelper 会将其视为页码来处理。
    • 不是必需，因为 PageHelper 默认就是使用页码 pageNum 和每页记录数 pageSize 来进行分页的。
  • "rowBoundsWithCount", "true"：这个属性用于指定是否进行 count 查询以获取总记录数。
    • 在分页查询时，需要知道总记录数，它可以让你在前端展示总页数或总记录数。
    • 设置为 true 表示 PageHelper 在执行分页查询时，会先执行一个 count 查询来获取总记录数。

2、使用 pagehelper-spring-boot-starter 启动

SpringBoot 起步依赖也封装了关于分页插件的依赖，需要在配置文件 application.properties 或 application.yml 中进行配置。

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

配置内容和上面使用配置类的方式一致。下面是两种配置文件的配置方式。

pagehelper.helper-dialect=mysql   // 数据库  可选
pagehelper.reasonable=true        // 规整页码范围，应对负数或过大页码
pagehelper.support-methods-arguments=true  // 规整可以通过方法参数获取，可用可不用输入即可
pagehelper.params=count=countSql // 是否统计总数

pagehelper:
  helper-dialect: mysql
  reasonable: true
  support-methods-arguments: true
  params: count=countSql

三、创建示例展示使用分页插件

1、创建数据库表格示例

本文创建一个 tb_user 表，含有 id 、username 和password 字段。本文只做一个简单示例，不涉及复杂业务。

数据库表格

使用 pagehelper-spring-boot-starter 依赖时进行的分页条件配置。

pagehelper:
  helper-dialect: mysql
  reasonable: true   // 规整页码范围
  support-methods-arguments: true   // 规整方法参数获取

下面代码中存在部分代码是项目中必须代码，如统一封装返回，MyBatis 项目搭建等就不在本文展示，有兴趣可查看以下文章。

关于统一 API 响应结果封装，代码示例在 SpringBoot 项目统一 API 响应结果封装 。

关于 MyBatis 的项目搭建在 SpringBoot 项目整合 MyBatis 框架 。

2、TestController

package com.wen.controller;

import com.wen.data.Result;
import com.wen.data.ResultGenerator;
import com.wen.dto.TbUser;
import com.wen.service.TestService;
import org.apache.ibatis.annotations.Param;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/test")
public class TestController {

    @Autowired
    private TestService testService;

    @GetMapping("/select")
    public Result<?> selectUserByPage(
    					@Param("pageSize") Integer pageSize, 
    					@Param("pageNumber") Integer pageNumber){
        return ResultGenerator.genSuccessResult(testService.selectUserByPage(pageSize, pageNumber));
    }
}

3、TestService

package com.wen.service;

import com.github.pagehelper.PageInfo;
import com.wen.dto.TbUser;

public interface TestService {
    PageInfo<TbUser> selectUserByPage(Integer pageSize, Integer pageNumber);
}

4、TbUserMapper

package com.wen.mapper;

import com.wen.dto.TbUser;
import org.apache.ibatis.annotations.Mapper;
import java.util.List;

@Mapper
public interface TbUserMapper {
    List<TbUser> selectUser();
}

5、TestServiceImpl

package com.wen.service.impl;

import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import com.wen.dto.TbUser;
import com.wen.mapper.TbUserMapper;
import com.wen.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
    private TbUserMapper tbUserMapper;

    @Override
    public PageInfo<TbUser> selectUserByPage(Integer pageSize, Integer pageNumber) {
        // 这句代码要放在查询 mapper 语句的前面，用于对数据库查询 SQL 添加分页。
        PageHelper.startPage(pageNumber, pageSize);
        List<TbUser> tbUsers = tbUserMapper.selectUser();
        PageInfo<TbUser> tbUserPageInfo = new PageInfo<>(tbUsers);
        return tbUserPageInfo;
    }
}

6、TbUserMapper.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.wen.mapper.TbUserMapper">
    <select id="selectUser" resultType="com.wen.dto.TbUser">
        SELECT username, password FROM tb_user
    </select>
</mapper>

四、使用不同的依赖展示结果会有差别

由下面的 JSON 结果可以看到数据的总数，页数，每页数据数量等，还有导航页面数据。

1、使用 pagehelper 依赖结果展示

http://localhost:8080/test/select?pageSize=5&pageNumber=1
第一种依赖结果
JSON 数据格式。

{
    "code": 1,
    "message": "SUCCESS",
    "data": {
        "pageNum": 1,
        "pageSize": 5,
        "size": 5,
        "orderBy": null,
        "startRow": 1,
        "endRow": 5,
        "total": 7,
        "pages": 2,
        "list": [
            {
                "id": 0,
                "username": "laowang",
                "password": "112233"
            },
            {
                "id": 0,
                "username": "laoli",
                "password": "123456"
            },
            {
                "id": 0,
                "username": "lisi",
                "password": "3344"
            },
            {
                "id": 0,
                "username": "wangwu",
                "password": "6677"
            },
            {
                "id": 0,
                "username": "周周",
                "password": "111"
            }
        ],
        "firstPage": 1,
        "prePage": 0,
        "nextPage": 2,
        "lastPage": 2,
        "isFirstPage": true,
        "isLastPage": false,
        "hasPreviousPage": false,
        "hasNextPage": true,
        "navigatePages": 8,
        "navigatepageNums": [
            1,
            2
        ]
    }
}

2、使用 pagehelper-spring-boot-starter 依赖结果展示

http://localhost:8080/test/select?pageSize=5&pageNumber=1
第二种依赖展示结果
JSON 数据格式。

{
    "code": 1,
    "message": "SUCCESS",
    "data": {
        "total": 7,
        "list": [
            {
                "id": 0,
                "username": "laowang",
                "password": "112233"
            },
            {
                "id": 0,
                "username": "laoli",
                "password": "123456"
            },
            {
                "id": 0,
                "username": "lisi",
                "password": "3344"
            },
            {
                "id": 0,
                "username": "wangwu",
                "password": "6677"
            },
            {
                "id": 0,
                "username": "周周",
                "password": "111"
            }
        ],
        "pageNum": 1,
        "pageSize": 5,
        "size": 5,
        "startRow": 1,
        "endRow": 5,
        "pages": 2,
        "prePage": 0,
        "nextPage": 2,
        "isFirstPage": true,
        "isLastPage": false,
        "hasPreviousPage": false,
        "hasNextPage": true,
        "navigatePages": 8,
        "navigatepageNums": [
            1,
            2
        ],
        "navigateFirstPage": 1,
        "navigateLastPage": 2
    }
}
SpringBoot中使用PageHelper插件实现Mybatis分页
BADAO_LIUMANG_QIZHI的博客
02-20 1492
SpringBoot中整合Mybatis时一般添加的依赖为 如果要实现分页查询的话，可以使用Mybatis的分页插件PageHelperGitHub - pagehelper/Mybatis-PageHelper: Mybatis通用分页插件官方使用教程：https://github.com/pagehelper/Mybatis-PageHelper/blob/master/wikis/zh/HowToUse.md这里是SpringBoot项目，可直接使用pagehelper-spring-boot-s
springboot +mybatis分页插件PageHelper
软件老王
06-25 3368
文章目录1.问题描述2. 解决方案2.1 配置项目pom.xml2.2 配置PageHelper参数2.3 项目中使用 1.问题描述 JAVA界ORM的两位大佬Hibernate和Mybatis，hb自带分页（上手挺快，以前用了好几年hb，后期运维及优化快疯了），mybatis没有分页功能，需要借助第三方插件来完成，比较流行的三方框架：PageHelper，今天结合springboot做下介绍，直...
SpringBoot集成MyBatis的分页插件PageHelper实例代码
08-29
主要介绍了SpringBoot集成MyBatis的分页插件PageHelper的相关操作，需要的朋友可以参考下
PageHelper详解：使用方法与注意事项
最新发布
yk_dflkg的博客
04-09 1481
PageHelper是一个强大的MyBatis分页插件，通过简单的配置和调用，可以大大简化分页查询的实现。但在使用过程中需要注意各种细节和潜在问题，如线程安全、生命周期等。通过合理配置和使用最佳实践，PageHelper可以帮助开发者高效实现各种分页查询需求。希望这篇详细的PageHelper使用指南能够帮助你更好地理解和使用这个工具！
Mybatis分页插件pagehelper——详解
qq_41505160的博客
03-17 1386
使用方法 1.引入依赖 引入分页插件有下面2种方式，推荐使用 Maven 方式。（下面有我下载的依赖） <dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper</artifactId> <version>最...
Spring Boot集成PageHelper：轻松实现数据库分页功能
zeyeqianli的博客
03-18 1513
通过本文，您已掌握Spring Boot集成PageHelper的核心技巧。立即实践，让分页功能从此高效又优雅！发送SELECT ... LIMIT 10 OFFSET 10。请求/api/users?执行selectAllUsers()调用getUsers(2,10)包装为PageInfo。返回PageInfo。
【SpringBoot】SpringBoot中分页插件（PageHelper）的使用
qq_62555748的博客
08-14 4517
SpringBoot中分页插件（PageHelper）的使用
SpringBoot使用Mybatis-PageHelper
weixin_30429201的博客
06-22 690
前言 之前一篇文章介绍了《SpringBoot+Mybatis+MySql学习》的整合，这一片扩展一下Mybatis的分页插件-Mybatis-PageHelper。 新建项目 首先，pom文件中加入pagehelper依赖，完整pom代码如下： <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://mav...
springBoot中使用 pagehelper
呆萌Di狍子
12-26 3718
PageHelper。 　　我们知道，在mysql中，分页的sql是使用limit来做，如果我们自己写sql，那分页肯定是没有任何问题的。但是一旦model多了起来，复杂了起来，我们很自然的想到使用mybatis的逆向工程来生成相应的po和mapper，但是同时也会带来弊端，比如这里的分页问题就不好解决了。 在springboot中 使用pagehelper是比较简单的: 第一步:在pom中添加:...
pageHelper实现分页
hanghXU的博客
04-29 669
SpringBoot学习－（七）SpringBoot分页插件PageHelper_写代码的lorre的博客-CSDN博客_springboot分页插件
PageHelper实现分页
Rocky balboa
02-24 1487
PageHelper PageHelper是国内非常优秀的一款开源的mybatis分页插件，它支持基本主流与常用的数据库，例如mysql、 oracle、mariaDB、DB2、SQLite、Hsqldb等。 本项目在 github 的项目地址： PageHelper使用 本项目在 gitosc 的项目地址： PageHelper使用 PageHelper使用 1.在父项目的 pom.xml 中添加如下依赖： <dependency> <groupId>com.githu
PageHelper实现前端分页
06-02
使用Mabatis中的分页插件PageHelper实现分页功能，此插件使用简单加快项目的开发效率。
SpringBoot项目中分页插件PageHelper无效的问题及解决方法
08-19
SpringBoot项目中分页插件PageHelper无效的问题及解决方法 PageHelper是Java中一个非常流行的分页插件，广泛应用于各种 Java Web 项目中，包括 SpringBoot 项目。但是，在 SpringBoot 项目中使用 PageHelper 时，...
MyBatis 分页插件 PageHelper的使用
heiHelloWorld的博客
12-28 1619
PageHelper是MyBatis的一个插件，内部实现了一个PageInterceptor拦截器。Mybatis会加载这个拦截器到拦截器链中。在我们使用过程中先使用PageHelper.startPage这样的语句在当前线程上下文中设置一个ThreadLocal变量，再利用PageInterceptor这个分页拦截器拦截，从ThreadLocal中拿到分页的信息，如果有分页信息拼装分页SQL（limit语句等）进行分页查询，最后再把ThreadLocal中的东西清除掉。
Java学习 - springboot 注解方式整合 Mybatis + PageHelper 分页实例
paofuluolijiang的博客
07-19 1206
本篇博客主要利用 SpringBoot 通过注解的方式整合 Mybatis 同时利用 PageHelper 对结果分页。
分页查询实战：手把手教你用 PageHelper 实现优雅的分页功能！
Leaton的博客
03-03 1932
无论你是刚接触 MyBatis 的小白，还是有一定经验的开发者，这篇文章都能为你答疑解惑！是一个基于 MyBatis 的分页插件，它通过拦截 MyBatis 的执行器（Executor）来实现分页功能。从它的起源到现代应用，再到具体的代码实现和最佳实践，每一个环节都进行了详细的讲解。的核心思想是通过拦截 MyBatis 的 SQL 执行过程，在 SQL 执行前后动态添加分页逻辑。的不断发展，分页查询的功能会越来越强大。通过页分查询，我们可以将数据分成若干个“页面”，每次只加载当前页面的数据。
SpringBoot 通过注解的方式整合 Mybatis + PageHelper 分页显示
村雨遥
07-27 920
文章目录1. 前言2. 整合过程2.1 新建 Spring Boot 项目2.2 添加 pom 依赖2.3 准备数据库2.4 pojo 层2.5 dao 层2.6 util 层2.7 service 层2.8 controller 层2.9 入口程序配置2.10 网页测试 1. 前言 本篇博客主要利用 SpringBoot 通过注解的方式整合 Mybatis 同时利用 PageHelper 对结果分页，所有涉及的代码已经上传 Github mybatis-pagehelper。下面是整个整合过程，接下来开
springboot项目使用mybatis分页插件
07-27
在 Spring Boot 项目中使用 MyBatis 分页插件，你可以按照以下步骤进行操作： 1. 添加依赖：在 `pom.xml` 文件中添加 MyBatis 分页插件的依赖。可以使用常见的分页插件，例如 `PageHelper` 或 `MyBatis-Plus`。 2. 配置插件：在 Spring Boot 的配置文件（`application.properties` 或 `application.yml`）中配置分页插件。具体的配置方式取决于你选择使用的分页插件，可以参考对应插件的文档。 3. 在 Mapper 接口中定义查询方法：在对应的 Mapper 接口中定义查询方法，方法参数中包含分页相关的参数，例如 `pageNum`（当前页码）和 `pageSize`（每页显示数量）。 4. 在 Mapper XML 文件中编写 SQL：在对应的 Mapper XML 文件中编写查询 SQL，并使用分页插件提供的语法来实现分页功能。具体的语法和用法也取决于你选择使用的分页插件，可以参考对应插件的文档。 5. 在 Service 层调用 Mapper 方法：在 Service 层中调用 Mapper 接口定义的查询方法，传入分页相关的参数，并获取查询结果。 这样，你就可以在 Spring Boot 项目中使用 MyBatis 分页插件了。记得根据你选择的具体插件，按照对应的文档进行配置和使用。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值