mybatis-plus分頁(yè)查詢的實(shí)現(xiàn)實(shí)例
一、官方文檔
Mybatis-Plus分頁(yè)插件:https://baomidou.com/pages/97710a/
PageHelper分頁(yè)插件:https://pagehelper.github.io/
Tip??:官網(wǎng)鏈接,第一手資料。
二、內(nèi)置的分頁(yè)方法
1、內(nèi)置方法
在Mybatis-Plus的BaseMapper中,已經(jīng)內(nèi)置了2個(gè)支持分頁(yè)的方法:
public interface BaseMapper<T> extends Mapper<T> {
<P extends IPage<T>> P selectPage(P page, @Param("ew") Wrapper<T> queryWrapper);
<P extends IPage<Map<String, Object>>> P selectMapsPage(P page, @Param("ew") Wrapper<T> queryWrapper);
……
}
2、selectPage單元測(cè)試
使用selectPage方法分頁(yè)查詢年紀(jì)age = 13的用戶。
@Test
public void testPage() {
System.out.println("----- selectPage method test ------");
//分頁(yè)參數(shù)
Page<User> page = Page.of(1,10);
//queryWrapper組裝查詢where條件
LambdaQueryWrapper<User> queryWrapper = new LambdaQueryWrapper<>();
queryWrapper.eq(User::getAge,13);
userMapper.selectPage(page,queryWrapper);
page.getRecords().forEach(System.out::println);
}
執(zhí)行結(jié)果:

查詢出了表中滿足條件的所有記錄,說明默認(rèn)情況下,selectPage方法并不能實(shí)現(xiàn)分頁(yè)查詢。
3、PaginationInnerInterceptor分頁(yè)插件配置
mybatis-plus中的分頁(yè)查詢功能,需要PaginationInnerInterceptor分頁(yè)插件的支持,否則分頁(yè)查詢功能不能生效。
@Configuration
public class MybatisPlusConfig {
/**
* 新增分頁(yè)攔截器,并設(shè)置數(shù)據(jù)庫(kù)類型為mysql
*/
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
return interceptor;
}
}
再次執(zhí)行單元測(cè)試:

先執(zhí)行count查詢查詢滿足條件的記錄總數(shù),然后執(zhí)行l(wèi)imit分頁(yè)查詢,查詢分頁(yè)記錄,說明分頁(yè)查詢生效。
三、分頁(yè)原理分析
查看PaginationInnerInterceptor攔截器中的核心實(shí)現(xiàn):
//select查詢請(qǐng)求的前置方法
public void beforeQuery(Executor executor, MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) throws SQLException {
//根據(jù)請(qǐng)求參數(shù)來判斷是否采用分頁(yè)查詢,參數(shù)中含有IPage類型的參數(shù),則執(zhí)行分頁(yè)
IPage<?> page = (IPage)ParameterUtils.findPage(parameter).orElse((Object)null);
if (null != page) {
boolean addOrdered = false;
String buildSql = boundSql.getSql();
List<OrderItem> orders = page.orders();
if (CollectionUtils.isNotEmpty(orders)) {
addOrdered = true;
buildSql = this.concatOrderBy(buildSql, orders);
}
//根據(jù)page參數(shù),組裝分頁(yè)查詢sql
Long _limit = page.maxLimit() != null ? page.maxLimit() : this.maxLimit;
if (page.getSize() < 0L && null == _limit) {
if (addOrdered) {
PluginUtils.mpBoundSql(boundSql).sql(buildSql);
}
} else {
this.handlerLimit(page, _limit);
IDialect dialect = this.findIDialect(executor);
Configuration configuration = ms.getConfiguration();
DialectModel model = dialect.buildPaginationSql(buildSql, page.offset(), page.getSize());
MPBoundSql mpBoundSql = PluginUtils.mpBoundSql(boundSql);
List<ParameterMapping> mappings = mpBoundSql.parameterMappings();
Map<String, Object> additionalParameter = mpBoundSql.additionalParameters();
model.consumers(mappings, configuration, additionalParameter);
mpBoundSql.sql(model.getDialectSql());
mpBoundSql.parameterMappings(mappings);
}
}
}
再來看看ParameterUtils.findPage()方法的實(shí)現(xiàn):
//發(fā)現(xiàn)參數(shù)中的IPage對(duì)象
public static Optional<IPage> findPage(Object parameterObject) {
if (parameterObject != null) {
//如果是多個(gè)參數(shù),會(huì)轉(zhuǎn)為map對(duì)象;只要任意一個(gè)value中包含IPage類型的對(duì)象,返回IPage對(duì)象
if (parameterObject instanceof Map) {
Map<?, ?> parameterMap = (Map)parameterObject;
Iterator var2 = parameterMap.entrySet().iterator();
while(var2.hasNext()) {
Entry entry = (Entry)var2.next();
if (entry.getValue() != null && entry.getValue() instanceof IPage) {
return Optional.of((IPage)entry.getValue());
}
}
//如果只有單個(gè)參數(shù),且類型為IPage,則返回IPage對(duì)象
} else if (parameterObject instanceof IPage) {
return Optional.of((IPage)parameterObject);
}
}
return Optional.empty();
}
小結(jié):mybatis-plus分頁(yè)查詢的實(shí)現(xiàn)原理:
1、由分頁(yè)攔截器PaginationInnerInterceptor攔截所有查詢請(qǐng)求,在執(zhí)行查詢前判斷參數(shù)中是否包含IPage類型的參數(shù)。
2、如果包含IPage類型的參數(shù),則根據(jù)分頁(yè)信息,重新組裝成分頁(yè)查詢的SQL。
四、自定義分頁(yè)方法
搞清楚mybatis-plus中分頁(yè)查詢的原理,我們來自定義分頁(yè)查詢方法。
這里我使用的是mybatis-plus 3.5.2的版本。
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.5.2</version>
</dependency>
在UserMapper中新增selectPageByDto方法。
public interface UserMapper extends CommonMapper<User> {
/**
* 不分頁(yè)dto條件查詢
* @param userDto
* @return
*/
List<User> selectByDto(@Param("userDto") UserDto userDto);
/**
* 支持分頁(yè)的dto條件查詢
* @param page
* @param userDto
* @return
*/
IPage<User> selectPageByDto(IPage<User> page,@Param("userDto") UserDto userDto);
}
說明:
1、mybatis-plus中分頁(yè)接口需要包含一個(gè)IPage類型的參數(shù)。
2、多個(gè)實(shí)體參數(shù),需要添加@Param參數(shù)注解,方便在xml中配置sql時(shí)獲取參數(shù)值。
UserMapper.xml中的分頁(yè)sql配置:這里由于selectByDto和selectPageByDto兩個(gè)方法都是根據(jù)dto進(jìn)行查詢,
sql語句完全一樣,所以將相同的sql抽取了出來,然后用include標(biāo)簽去引用。
<sql id="selectByDtoSql">
select * from user t
<where>
<if test="userDto.name != null and userDto.name != '' ">
AND t.name like CONCAT('%',#{userDto.name},'%')
</if>
<if test="userDto.age != null">
AND t.age = #{userDto.age}
</if>
</where>
</sql>
<select id="selectByDto" resultType="com.laowan.mybatis_plus.model.User">
<include refid="selectByDtoSql"/>
</select>
<select id="selectPageByDto" resultType="com.laowan.mybatis_plus.model.User">
<include refid="selectByDtoSql"/>
</select>
1、2種分頁(yè)寫法
方式一:Page對(duì)象既作為參數(shù),也作為查詢結(jié)果接受體
@Test
public void testSelectPageByDto() {
System.out.println("----- SelectPageByDto method test ------");
//分頁(yè)參數(shù)Page,也作為查詢結(jié)果接受體
Page<User> page = Page.of(1,10);
//查詢參數(shù)
UserDto userDto = new UserDto();
userDto.setName("test");
userMapper.selectPageByDto(page,userDto);
page.getRecords().forEach(System.out::println);
}
- 方式二:Page作為參數(shù),用一個(gè)新的IPage對(duì)象接受查詢結(jié)果。
@Test
public void testSelectPageByDto() {
System.out.println("----- SelectPageByDto method test ------");
//查詢參數(shù)
UserDto userDto = new UserDto();
userDto.setName("test");
//PageDTO.of(1,10)對(duì)象只作為查詢參數(shù),
IPage<User> page = userMapper.selectPageByDto(PageDTO.of(1,10),userDto);
page.getRecords().forEach(System.out::println);
}
下面是官網(wǎng)的一些說明:

這是官網(wǎng)針對(duì)自定義分頁(yè)的說明。
個(gè)人建議:如果定義的方法名中包含Page,說明該方法是用來進(jìn)行分頁(yè)查詢的,返回結(jié)果盡量用IPage,而不要用List。防止出現(xiàn)不必要的錯(cuò)誤,也更符合見名知意和單一指責(zé)原則。
2、利用page.convert方法實(shí)現(xiàn)Do到Vo的轉(zhuǎn)換
public IPage<UserVO> list(PageRequest request) {
IPage<UserDO> page = new Page(request.getPageNum(), request.pageSize());
LambdaQueryWrapper<UserDO> qw = Wrappers.lambdaQuery();
page = userMapper.selectPage(page, qw);
return page.convert(u->{
UserVO v = new UserVO();
BeanUtils.copyProperties(u, v);
return v;
});
}
五、分頁(yè)插件 PageHelper
很多人已經(jīng)習(xí)慣了在mybatis框架下使用PageHelper進(jìn)行分頁(yè)查詢,在mybatis-plus框架下依然也可以使用,和mybatis-plus框架自帶的分頁(yè)插件沒有明顯的高下之分。
個(gè)人認(rèn)為mybatis-plus的分頁(yè)實(shí)現(xiàn)可以從方法命名、方法傳參方面更好的規(guī)整代碼。而PageHelper的實(shí)現(xiàn)對(duì)代碼的侵入性更強(qiáng),不符合單一指責(zé)原則。
推薦在同一個(gè)項(xiàng)目中,只選用一種分頁(yè)方式,統(tǒng)一代碼風(fēng)格。
PageHelper的使用:
1.引入maven依賴
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>最新版本</version>
</dependency>
2.PageHelper分頁(yè)查詢
代碼如下(示例):
//獲取第1頁(yè),10條內(nèi)容,默認(rèn)查詢總數(shù)count PageHelper.startPage(1, 10); List<Country> list = countryMapper.selectAll(); //用PageInfo對(duì)結(jié)果進(jìn)行包裝 PageInfo page = new PageInfo(list);
總結(jié)
本文主要對(duì)mybatis-plus分頁(yè)查詢的原理和使用進(jìn)行了詳細(xì)介紹。
1、要開啟mybatis-plus分頁(yè)查詢功能首先需要配置PaginationInnerInterceptor分頁(yè)查詢插件。
2、PaginationInnerInterceptor分頁(yè)查詢插件的實(shí)現(xiàn)原理是:攔截所有查詢請(qǐng)求,分析查詢參數(shù)中是否包含IPage類型的參數(shù)。如果有則根據(jù)分頁(yè)信息和數(shù)據(jù)庫(kù)類型重組sql。
3、提供了2種分頁(yè)查詢的寫法。
4、和經(jīng)典的PageHelper分頁(yè)插件進(jìn)行了對(duì)比。兩者的使用都非常簡(jiǎn)單,在單一項(xiàng)目中任選一種,統(tǒng)一代碼風(fēng)格即可。
到此這篇關(guān)于mybatis-plus分頁(yè)查詢的實(shí)現(xiàn)實(shí)例的文章就介紹到這了,更多相關(guān)mybatis-plus分頁(yè)查詢內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
- SpringBoot使用mybatis-plus分頁(yè)查詢無效的問題解決
- SpringBoot整合mybatis-plus實(shí)現(xiàn)分頁(yè)查詢功能
- mybatis-plus多表分頁(yè)查詢最佳實(shí)現(xiàn)方法(非常簡(jiǎn)單)
- mybatis-plus分頁(yè)查詢?nèi)N方法小結(jié)
- Mybatis-plus分頁(yè)查詢不生效問題排查全過程
- 如何使用mybatis-plus實(shí)現(xiàn)分頁(yè)查詢功能
- 一文搞懂Mybatis-plus的分頁(yè)查詢操作
- MyBatis-Plus?分頁(yè)查詢的實(shí)現(xiàn)示例
- springboot整合mybatis-plus 實(shí)現(xiàn)分頁(yè)查詢功能
- mybatis-plus分頁(yè)查詢的實(shí)現(xiàn)示例
- mybatis-plus 實(shí)現(xiàn)分頁(yè)查詢的示例代碼
相關(guān)文章
關(guān)于Map的遍歷以及轉(zhuǎn)JsonArray存儲(chǔ)方式
在Java開發(fā)過程中,經(jīng)常會(huì)遇到需要對(duì)復(fù)雜數(shù)據(jù)結(jié)構(gòu)進(jìn)行處理的情況,本案例以List<Map<String,Object>>為例,介紹了如何遍歷該數(shù)據(jù)結(jié)構(gòu),并根據(jù)特定條件篩選出符合要求的元素,通過自定義一個(gè)Edit類來模擬形成一個(gè)新的Map對(duì)象,實(shí)現(xiàn)了數(shù)據(jù)的有序存儲(chǔ)2024-11-11
java 方法重寫與權(quán)限修飾符以及多態(tài)和抽象類詳解概念和用法
重寫是子類對(duì)父類的允許訪問的方法的實(shí)現(xiàn)過程進(jìn)行重新編寫, 返回值和形參都不能改變。即外殼不變,核心重寫,權(quán)限修飾符用于控制被修飾變量、方法、類的可見范圍,說明了面向?qū)ο蟮姆庋b性,所以我們要適用他們盡可能的讓權(quán)限降到最低,從而安全性提高2021-10-10
SpringBoot使用@Async注解可能會(huì)遇到的8大坑點(diǎn)匯總
SpringBoot中,@Async注解可以實(shí)現(xiàn)異步線程調(diào)用,用法簡(jiǎn)單,體驗(yàn)舒適,但是你一定碰到過異步調(diào)用不生效的情況,今天,我就列出90%的人都可能會(huì)遇到的8大坑點(diǎn),需要的朋友可以參考下2023-09-09
spring mvc中直接注入的HttpServletRequst安全嗎
這篇文章主要給大家介紹了關(guān)于spring mvc中直接注入的HttpServletRequst是不是安全的相關(guān)資料,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面來一起看看吧。2018-04-04
eclipse+maven+spring mvc項(xiàng)目基本搭建過程
這篇文章主要介紹了eclipse+maven+spring mvc項(xiàng)目基本搭建過程,本文圖文并茂給大家介紹的非常詳細(xì),具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2019-09-09
SpringBoot靜態(tài)資源映射規(guī)則淺析
這篇文章主要介紹了SpringBoot靜態(tài)資源映射規(guī)則,今天在玩SpringBoot的demo的時(shí)候,放了張圖片在resources目錄下,啟動(dòng)區(qū)訪問的時(shí)候,突然好奇是識(shí)別哪些文件夾來展示靜態(tài)資源的, 為什么有時(shí)候放的文件夾不能顯示,有的卻可以2023-02-02
通過System.getProperty配置JVM系統(tǒng)屬性
這篇文章主要介紹了通過System.getProperty配置JVM系統(tǒng)屬性,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-10-10
java實(shí)現(xiàn)簡(jiǎn)單的驗(yàn)證碼功能
這篇文章主要為大家詳細(xì)介紹了java實(shí)現(xiàn)簡(jiǎn)單的驗(yàn)證碼功能,文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2020-04-04
解決springmvc關(guān)于前臺(tái)日期作為實(shí)體類對(duì)象參數(shù)類型轉(zhuǎn)換錯(cuò)誤的問題
下面小編就為大家?guī)硪黄鉀Qspringmvc關(guān)于前臺(tái)日期作為實(shí)體類對(duì)象參數(shù)類型轉(zhuǎn)換錯(cuò)誤的問題。小編覺得挺不錯(cuò)的,現(xiàn)在就分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧2017-06-06

