一文詳解SpringBoot如何使用pageHelper做分頁(yè)處理
更新時(shí)間：2025年03月27日 09:30:36 作者：青燈文案
分頁(yè)是常見(jiàn)大型項(xiàng)目都需要的一個(gè)功能,PageHelper是一個(gè)非常流行的MyBatis分頁(yè)插件,下面就跟隨小編一起來(lái)了解下SpringBoot是如何使用pageHelper做分頁(yè)處理的吧
分頁(yè)是常見(jiàn)大型項(xiàng)目都需要的一個(gè)功能，PageHelper是一個(gè)非常流行的MyBatis分頁(yè)插件，它支持多數(shù)據(jù)庫(kù)分頁(yè)，無(wú)需修改SQL語(yǔ)句即可實(shí)現(xiàn)分頁(yè)功能。
本文在最后展示了兩種依賴驗(yàn)證的結(jié)果。
一、第一種依賴方式
1、在項(xiàng)目中使用 PageHelper 插件需要先添加依賴：
<dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper</artifactId> <version>4.1.3</version> </dependency>
2、這種方式需要配置一個(gè) config 文件
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;
/**
* @author : rjw
* @date : 2024-09-20
*/
@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;
}
}
3、setProperty 方法設(shè)置了三個(gè)分頁(yè)插件的屬性：
"dialect", "Mysql"：指定了數(shù)據(jù)庫(kù)方言為Mysql。（主要是因?yàn)镾QL語(yǔ)句不同）。
"offsetAsPageNum", "true"：這個(gè)屬性通常用于指定是否將傳入的 offset 參數(shù)當(dāng)作 pageNum （頁(yè)碼）使用。在這個(gè)配置中，它被設(shè)置為true，意味著如果分頁(yè)查詢時(shí)傳遞了offset（偏移量），PageHelper會(huì)將其視為頁(yè)碼來(lái)處理。然而，這個(gè)設(shè)置通常不是必需的，因?yàn)镻ageHelper默認(rèn)就是使用頁(yè)碼（pageNum）和每頁(yè)記錄數(shù)（pageSize）來(lái)進(jìn)行分頁(yè)的。
"rowBoundsWithCount", "true"：這個(gè)屬性用于指定是否進(jìn)行 count 查詢以獲取總記錄數(shù)。在分頁(yè)查詢時(shí)，知道總記錄數(shù)是有用的，因?yàn)樗梢宰屇阍谇岸苏故究傢?yè)數(shù)或總記錄數(shù)。設(shè)置為 true 表示 PageHelper 在執(zhí)行分頁(yè)查詢時(shí)，會(huì)先執(zhí)行一個(gè) count 查詢來(lái)獲取總記錄數(shù)。
二、第二種依賴方式
<dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper-spring-boot-starter</artifactId> <version>1.2.10</version> </dependency>
這種方式需要在配置文件配置一下，application.properties 或 application.yml 。
pagehelper.helper-dialect=mysql // 數(shù)據(jù)庫(kù) 可選 pagehelper.reasonable=true // 規(guī)整頁(yè)碼范圍，應(yīng)對(duì)負(fù)數(shù)或過(guò)大頁(yè)碼 pagehelper.support-methods-arguments=true // 規(guī)整可以通過(guò)方法參數(shù)獲取，可用可不用輸入即可 pagehelper.params=count=countSql
pagehelper: helper-dialect: mysql reasonable: true support-methods-arguments: true params: count=countSql
三、創(chuàng)建數(shù)據(jù)庫(kù)表格
分頁(yè)條件配置
pagehelper: helper-dialect: mysql reasonable: true // 規(guī)整頁(yè)碼范圍 support-methods-arguments: true // 規(guī)整方法參數(shù)獲取
四、代碼示例
關(guān)于統(tǒng)一 API 響應(yīng)結(jié)果封裝，代碼示例在 SpringBoot 項(xiàng)目統(tǒng)一 API 響應(yīng)結(jié)果封裝。
關(guān)于 mybatis 的項(xiàng)目搭建在 SpringBoot 項(xiàng)目整合 MyBatis 框架 。
1、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));
}
}
2、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);
}
3、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 語(yǔ)句的前面
PageHelper.startPage(pageNumber, pageSize);
List<TbUser> tbUsers = tbUserMapper.selectUser();
PageInfo<TbUser> tbUserPageInfo = new PageInfo<>(tbUsers);
return tbUserPageInfo;
}
}
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、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>
五、第一種依賴展示結(jié)果
http://localhost:8080/test/select?pageSize=5&pageNumber=1
{
"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
]
}
}
六、第二種依賴展示結(jié)果
http://localhost:8080/test/select?pageSize=5&pageNumber=1
{
"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
}
}
到此這篇關(guān)于一文詳解SpringBoot如何使用pageHelper做分頁(yè)處理的文章就介紹到這了,更多相關(guān)SpringBoot pageHelper分頁(yè)處理內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
這篇文章主要介紹了Java數(shù)組(Array)最全匯總(中篇)，本文章內(nèi)容詳細(xì)，通過(guò)案例可以更好的理解數(shù)組的相關(guān)知識(shí)，本模塊分為了三部分，本次為中篇，需要的朋友可以參考下2023-01-01
Java實(shí)現(xiàn)拓?fù)渑判虻氖纠a
這篇文章我們要講的是拓?fù)渑判?，這是一個(gè)針對(duì)有向無(wú)環(huán)圖的算法，主要是為了解決前驅(qū)后繼的關(guān)系，感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2022-05-05
Java web Hibernate如何與數(shù)據(jù)庫(kù)鏈接
這篇文章主要介紹了Java web Hibernate如何與數(shù)據(jù)庫(kù)鏈接,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-06-06
給定一個(gè)由多個(gè)a和b組成的字符串?dāng)?shù)組，字符串中有一個(gè)特殊的字符X,位于字符串的正中間，例如（aaaabbbbXabaabbbb）,如何判定該字符串是否回文2020-12-12
Spring事務(wù)失效的場(chǎng)景梳理總結(jié)
實(shí)際項(xiàng)目開(kāi)發(fā)中,如果涉及到多張表操作時(shí),為了保證業(yè)務(wù)數(shù)據(jù)的一致性,大家一般都會(huì)采用事務(wù)機(jī)制,好多小伙伴可能只是簡(jiǎn)單了解一下,遇到事務(wù)失效的情況,便會(huì)無(wú)從下手,下面這篇文章主要給大家介紹了關(guān)于Spring事務(wù)失效場(chǎng)景的相關(guān)資料,需要的朋友可以參考下2023-02-02
如何使用Gradle實(shí)現(xiàn)類(lèi)似Maven的profiles功能
這篇文章主要介紹了如何使用Gradle實(shí)現(xiàn)類(lèi)似Maven的profiles功能,本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì),感興趣的朋友跟隨小編一起看看吧2024-06-06
淺談java.util.concurrent包中的線程池和消息隊(duì)列
這篇文章主要介紹了淺談java.util.concurrent包中的線程池和消息隊(duì)列，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2019-08-08
文章介紹了如何在非Spring Cloud或Spring Boot項(xiàng)目中配置和使用Kafka,提供了一個(gè)簡(jiǎn)單的Kafka配置讀取類(lèi),可以靈活地從不同配置中讀取屬性,并提供默認(rèn)值2024-11-11
springboot?+rabbitmq+redis實(shí)現(xiàn)秒殺示例
本文主要介紹了springboot?+rabbitmq+redis實(shí)現(xiàn)秒殺示例，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2022-07-07
Netty分布式ByteBuf中PooledByteBufAllocator剖析
這篇文章主要為大家介紹了Netty分布式ByteBuf剖析PooledByteBufAllocator簡(jiǎn)述，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2022-03-03