springboot項目中分頁查詢的使用示例解析
Spring Boot 分頁查詢詳解
本文詳細(xì)講解 Spring Boot 中兩種主流分頁方案:MyBatis + PageHelper 和 MyBatis Plus 的實現(xiàn)方式、原理、優(yōu)缺點及實際應(yīng)用場景。內(nèi)容涵蓋配置、代碼示例、注意事項和對比總結(jié)。
一、分頁查詢概述
分頁查詢是 Web 開發(fā)中處理大數(shù)據(jù)集的核心需求,其本質(zhì)是 按需加載數(shù)據(jù),避免一次性返回全部數(shù)據(jù)導(dǎo)致的性能問題。實現(xiàn)方式通常分為兩類:
- 物理分頁:通過 SQL 直接限制查詢范圍(如
LIMIT
)。 - 邏輯分頁:先查詢?nèi)繑?shù)據(jù),再在內(nèi)存中截取分頁(不推薦)。
Spring Boot 中常用 物理分頁,依賴 MyBatis 的插件機(jī)制動態(tài)修改 SQL。
二、MyBatis + PageHelper 分頁方案
1. 核心依賴
<dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper-spring-boot-starter</artifactId> <version>1.4.6</version> </dependency>
2. 配置參數(shù)(application.yml)
pagehelper: helper-dialect: mysql # 指定數(shù)據(jù)庫方言(mysql/oracle/postgresql) reasonable: true # 合理化分頁參數(shù)(超出范圍時自動修正) support-methods-arguments: true # 支持接口參數(shù)傳遞分頁
3. 分頁實現(xiàn)代碼
Service 層
public PageInfo<User> getUsersByPage(int pageNum, int pageSize) { try { // 開啟分頁:對緊接的第一個查詢生效 PageHelper.startPage(pageNum, pageSize); List<User> users = userMapper.selectAll(); return new PageInfo<>(users); // 包含總條數(shù)、總頁數(shù)等信息 } finally { PageHelper.clearPage(); // 清理 ThreadLocal } }
Mapper 接口
@Select("SELECT * FROM user WHERE status = 1") List<User> selectAll();
4. 分頁原理
- ThreadLocal 傳遞參數(shù):
PageHelper.startPage()
將分頁參數(shù)存入當(dāng)前線程的ThreadLocal
。 - 攔截器重寫 SQL:MyBatis 攔截器自動拼接
LIMIT offset, pageSize
。 - 自動執(zhí)行 COUNT 查詢:生成分頁數(shù)據(jù)后,自動查詢總記錄數(shù)。
5. 注意事項
- 調(diào)用順序:
startPage()
必須緊貼查詢方法,否則分頁不生效。 - 線程安全:異步或多線程場景需手動傳遞分頁參數(shù)。
- 性能優(yōu)化:復(fù)雜 SQL 可自定義 COUNT 查詢:
@Select("SELECT COUNT(*) FROM user WHERE status = 1") Long countUsers(); // 指定自定義 COUNT 方法 PageHelper.startPage(1, 10).count(true).setCountSql("countUsers");
三、MyBatis Plus 分頁方案
1. 核心依賴
<dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.5.3.1</version> </dependency>
2. 分頁插件配置
@Configuration public class MybatisPlusConfig { @Bean public MybatisPlusInterceptor mybatisPlusInterceptor() { MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor(); // 添加分頁攔截器,指定數(shù)據(jù)庫類型 interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL)); return interceptor; } }
3. 分頁實現(xiàn)代碼
Service 層
public IPage<User> getUsersByPage(int pageNum, int pageSize) { // 創(chuàng)建分頁對象 Page<User> page = new Page<>(pageNum, pageSize); // 執(zhí)行分頁查詢(自動處理 SQL) return userMapper.selectPage(page, new QueryWrapper<User>().eq("status", 1)); }
Mapper 接口
public interface UserMapper extends BaseMapper<User> { // 繼承 BaseMapper 默認(rèn)提供分頁方法 }
4. 分頁原理
- 內(nèi)置分頁攔截器:自動識別
IPage
參數(shù),重寫 SQL。 - 統(tǒng)一分頁模型:通過
IPage<T>
接口封裝分頁參數(shù)和結(jié)果。 - 多數(shù)據(jù)庫支持:根據(jù)
DbType
生成不同分頁 SQL(如 Oracle 的 ROWNUM)。
5. 注意事項
- Wrapper 條件:分頁需結(jié)合
QueryWrapper
或自定義 SQL。 - 性能優(yōu)化:大數(shù)據(jù)量分頁需手動優(yōu)化 COUNT 查詢:
// 關(guān)閉自動 COUNT 查詢 Page<User> page = new Page<>(pageNum, pageSize, false); List<User> users = userMapper.selectPage(page, wrapper); // 手動執(zhí)行 COUNT 查詢 page.setTotal(userMapper.selectCount(wrapper));
四、對比總結(jié)
對比維度 | MyBatis + PageHelper | MyBatis Plus |
---|---|---|
依賴復(fù)雜度 | 僅需 PageHelper 依賴 | 需引入 MyBatis Plus 全家桶 |
配置難度 | 需配置方言、合理化參數(shù) | 僅需定義分頁攔截器 |
侵入性 | 低(無需修改 Mapper) | 高(需繼承 BaseMapper ) |
SQL 靈活性 | 支持任意復(fù)雜 SQL,手動優(yōu)化空間大 | 簡單查詢高效,復(fù)雜 SQL 需自定義 |
線程安全 | 依賴 ThreadLocal ,需注意異步場景 | 無線程安全問題(參數(shù)傳遞) |
適用場景 | 已有 MyBatis 項目,需靈活分頁 | 新項目或深度集成 MyBatis Plus |
五、最佳實踐與常見問題
1. 最佳實踐
- 簡單分頁:優(yōu)先使用 MyBatis Plus,減少代碼量。
- 復(fù)雜 SQL:選擇 PageHelper,靈活控制 SQL。
- 性能優(yōu)化:
- 添加索引(如
CREATE INDEX idx_status ON user(status)
)。 - 避免
SELECT *
,僅查詢必要字段。 - 大數(shù)據(jù)量分頁使用 游標(biāo)分頁 或 延遲關(guān)聯(lián)。
- 添加索引(如
2. 常見問題
Q1:分頁不生效
- 原因:
startPage()
調(diào)用順序錯誤或未配置攔截器。 - 解決:確保
startPage()
在查詢方法前調(diào)用,檢查依賴和配置。
Q2:總條數(shù)(total)為 0
- 原因:COUNT 查詢未匹配條件或 SQL 錯誤。
- 解決:手動指定 COUNT 方法或檢查查詢條件。
Q3:性能低下
優(yōu)化:
-- 原始 SQL(性能差) SELECT * FROM orders ORDER BY id LIMIT 1000000, 10; -- 優(yōu)化 SQL(延遲關(guān)聯(lián)) SELECT * FROM orders WHERE id >= (SELECT id FROM orders ORDER BY id LIMIT 1000000, 1) ORDER BY id LIMIT 10;
六、附錄:完整代碼示例
PageHelper 完整示例
// Service public PageInfo<User> getUsers(int pageNum, int pageSize) { try { PageHelper.startPage(pageNum, pageSize); List<User> users = userMapper.selectByCondition("active"); return new PageInfo<>(users); } finally { PageHelper.clearPage(); } } // Mapper @Select("SELECT * FROM user WHERE status = #{status}") List<User> selectByCondition(String status);
MyBatis Plus 完整示例
// Service public IPage<User> getUsers(int pageNum, int pageSize) { Page<User> page = new Page<>(pageNum, pageSize); QueryWrapper<User> wrapper = new QueryWrapper<>(); wrapper.eq("status", "active"); return userMapper.selectPage(page, wrapper); }
到此這篇關(guān)于springboot項目中分頁查詢的使用解析的文章就介紹到這了,更多相關(guān)springboot分頁查詢使用內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
MyBatis在Spring環(huán)境下的事務(wù)管理
MyBatis的設(shè)計思想很簡單,可以看做是對JDBC的一次封裝,并提供強(qiáng)大的動態(tài)SQL映射功能。這篇文章主要介紹了MyBatis在Spring環(huán)境下的事務(wù)管理 ,需要的朋友可以參考下2019-07-07SpringMVC中的ConversionServiceExposingInterceptor工具類解析
這篇文章主要介紹了SpringMVC中的ConversionServiceExposingInterceptor工具類解析,ConversionServiceExposingInterceptor是Spring MVC的一個HandlerInterceptor,用于向請求添加一個屬性,需要的朋友可以參考下2023-12-12Java實現(xiàn)將列表數(shù)據(jù)導(dǎo)出為PDF文件并添加水印
這篇文章主要為大家詳細(xì)介紹了如何使用Java實現(xiàn)把列表數(shù)據(jù)導(dǎo)出為PDF文件,同時加上PDF水印,文中的示例代碼講解詳細(xì),需要的可以參考下2024-02-02