MyBatis系列之分页插件及问题

2024-06-24 08:44
文章标签 插件 mybatis 分页 系列 问题

本文主要是介绍MyBatis系列之分页插件及问题，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

概述

无论是C端产品页面，还是后台系统页面，不可能一次性将全部数据加载出来。后台系统一般都是PC端登录，用Table组件（如Ant Design Table）渲染展示数据，可点击列表的下一页（或指定某一页）查看数据。C端产品如App，在下滑时可查看更多数据，看起来像是一次性加载数据，实际上也是分批请求后台系统获取数据。而这，就是分页功能。

如果没有使用Hibernate或MyBatis这样的ORM工具，假如面对的是MySQL数据库，则可考虑自己拼接SQL，在末尾加上LIMIT M OFFSET N，有两种写法：

select * from order LIMIT 1, 3;
select * from order LIMIT 3 OFFSET 1;

解释：

  • limit后面跟两个参数时，第一个数表示要跳过的数量，后一位表示要取的数量
  • OFFSET表示要跳过的数量，LIMIT表示要取的数量

问题

大部分人几乎不会看到上面这种分页查询数据的写法，因为这种写法存在性能问题。如果表的数据量级只有几万或十几万，单表查询的性能损耗几乎可省略不计。但如果面对单表高达百万级别的数据量时，上面这种写法的执行耗时就不能忽略不计。

为了实现分页，每次收到分页请求时，数据库都需要进行低效的全表遍历。全表遍历，就是根据双向链表把磁盘上的数据页加载到磁盘的缓存页里去，然后在缓存页内部查找那条数据。

解决方案：

  1. 增加where条件，并且在where条件里使用索引过滤掉无关数据，即想要通过OFFSET跳过的数据，一般都是where id > 3000000；
  2. 增加order by子句并确保order by的字段上有索引，这样可利用索引进行排序，而不是在内存中对所有行进行排序；
  3. 使用覆盖索引优化：SELECT * FROM order a INNER JOIN (SELECT id FROM order LIMIT 3000000, 20) b USING (id);

总之，可通过MySQL explain命令验证一下SQL。如果索引被使用，输出中的type列通常会显示range、ref或index等，而不是ALL（表示全表扫描）。

使用MyBatis后时，如何分页查询数据？一般会考虑使用分页插件，主要有以下3个（实际上远远不止这3个，记得刚工作时还用过一个MyBatis-Pagination，在Maven里搜索不到，不是下面列出的MyBatis-Paginator）：

PageHelper

支持多种数据库（如MySQL、PostgreSQL、Oracle等）且配置简单，支持多数据库、自动分页、分页参数合理化、分页插件链式调用、自定义count查询。开源GitHub。

对应的Maven依赖为：

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

有提供对应的spring-boot-starter，依赖如下：

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

pagehelper-spring-boot-starter某个版本具体使用什么版本的pagehelper，可通过IDEA查看pom文件得知。

一定要知道**-spring-boot-starter实际上引用的还是**。

简单使用：

// 省略其他非分页插件相关的import语句，下同
import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;public void query() {SqlSession session = MyBatisUtil.getSqlSessionFactory().openSession();try {MyMapper mapper = session.getMapper(MyMapper.class);PageHelper.startPage(1, 10);List<MyObject> list = mapper.selectMyObjects();PageInfo<MyObject> pageInfo = new PageInfo<>(list);} finally {session.close();}
}

MyBatis-Plus

MyBatis的一个增强工具包，提供许多开箱即用的功能（除mybatis-plus外无需额外引入其他依赖），包括分页。目标是简化开发，提高生产力。支持自动分页、多数据库、代码生成器，提供丰富的条件构造器。开源GitHub。

对应的Maven依赖最新版为：

<dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus</artifactId><version>3.5.7</version>
</dependency>

有提供对应的spring-boot-starter，依赖如下：

<dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><version>3.5.7</version>
</dependency>

可知，mybatis-plus-boot-starter和mybatis-plus保持同步更新和版本发布。

需要配置@Bean方法：

import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;@Configuration
public class MyBatisPlusConfig {@Beanpublic PaginationInterceptor paginationInterceptor() {return new PaginationInterceptor();}
}

高版本的配置方法：

@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));return interceptor;
}

简单使用：

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;@Service
public class MyService {@Autowiredprivate MyMapper myMapper;public IPage<MyObject> getMyObjects(int page, int size) {Page<MyObject> myPage = new Page<>(page, size);return myMapper.selectPage(myPage, new QueryWrapper<>());}
}

MyBatis-Paginator

对应的Maven依赖为：

<dependency><groupId>com.github.miemiedev</groupId><artifactId>mybatis-paginator</artifactId><version>1.2.17</version>
</dependency>

开源GitHub。
简单使用：

import com.github.miemiedev.mybatis.paginator.domain.PageBounds;
import com.github.miemiedev.mybatis.paginator.domain.PageList;public void example() {SqlSession session = MyBatisUtil.getSqlSessionFactory().openSession();try {MyMapper mapper = session.getMapper(MyMapper.class);PageBounds pageBounds = new PageBounds(1, 10);List<MyObject> list = mapper.selectMyObjects(pageBounds);PageList<MyObject> pageList = (PageList<MyObject>) list;} finally {session.close();}
}

选型

插件\对比项最后发布时间ForkStar
PageHelper2023.12.163.1k12.1k
MyBatis-Plus2024.06.104.2k16
MyBatis-Paginator2015.05.07218368

如果项目使用的是MyBatis，则可考虑使用PageHelper。
如果项目使用的是MyBatis-Plus，则可直接使用自带的分页功能。

原理

面试时可能会遇到的一个问题，MyBatis-Plus（或PageHelper）的实现原理是什么？

MybatisPlus基于MyBatis物理分页

以MyBatis-Plus低版本为例，分析分页原理的入口类是PaginationInterceptor，核心方法是：

public Object intercept(Invocation invocation) throws Throwable {StatementHandler statementHandler = (StatementHandler)PluginUtils.realTarget(invocation.getTarget());MetaObject metaObject = SystemMetaObject.forObject(statementHandler);this.sqlParser(metaObject);MappedStatement mappedStatement = (MappedStatement)metaObject.getValue("delegate.mappedStatement");// 只考虑SELECTif (!SqlCommandType.SELECT.equals(mappedStatement.getSqlCommandType())) {return invocation.proceed();} else {RowBounds rowBounds = (RowBounds)metaObject.getValue("delegate.rowBounds");// 不需要分页if (rowBounds == null || rowBounds == RowBounds.DEFAULT) {if (!this.localPage) {return invocation.proceed();}// 从ThreadLocal获取本地线程PaginationrowBounds = PageHelper.getPagination();if (rowBounds == null) {return invocation.proceed();}}BoundSql boundSql = (BoundSql)metaObject.getValue("delegate.boundSql");String originalSql = boundSql.getSql();Connection connection = (Connection)invocation.getArgs()[0];DBType dbType = StringUtils.isNotEmpty(this.dialectType) ? DBType.getDBType(this.dialectType) : JdbcUtils.getDbType(connection.getMetaData().getURL());// Pagination是RowBounds的子类if (rowBounds instanceof Pagination) {Pagination page = (Pagination)rowBounds;boolean orderBy = true;// searchCount默认为trueif (page.isSearchCount()) {// SqlInfo sqlInfo = SqlUtils.getOptimizeCountSql(page.isOptimizeCountSql(), this.sqlParser, originalSql);orderBy = sqlInfo.isOrderBy();this.queryTotal(this.overflowCurrent, sqlInfo.getSql(), mappedStatement, boundSql, page, connection);// 可等价替换为==0L，应该不存在<0的情况？if (page.getTotal() <= 0L) {return invocation.proceed();}}// 构建SQL追加order by子句String buildSql = SqlUtils.concatOrderBy(originalSql, page, orderBy);originalSql = DialectFactory.buildPaginationSql(page, buildSql, dbType, this.dialectClazz);} else {originalSql = DialectFactory.buildPaginationSql((RowBounds)rowBounds, originalSql, dbType, this.dialectClazz);}metaObject.setValue("delegate.boundSql.sql", originalSql);// 禁用内存分页,内存分页会查询所有结果出来处理,如果结果变化频繁这个数据还会不准metaObject.setValue("delegate.rowBounds.offset", 0);metaObject.setValue("delegate.rowBounds.limit", Integer.MAX_VALUE);return invocation.proceed();}
}

高版本的拦截器类是PaginationInnerInterceptor，比PaginationInterceptor要复杂一些，核心方法有两个：

/*** 进行count,如果count为0返回false,不再执行sql*/
@Override
public boolean willDoQuery(Executor executor, MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) throws SQLException {// 都是先解析Page信息IPage<?> page = ParameterUtils.findPage(parameter).orElse(null);if (page == null || page.getSize() < 0 || !page.searchCount() || resultHandler != Executor.NO_RESULT_HANDLER) {return true;}BoundSql countSql;MappedStatement countMs = buildCountMappedStatement(ms, page.countId());if (countMs != null) {countSql = countMs.getBoundSql(parameter);} else {countMs = buildAutoCountMappedStatement(ms);String countSqlStr = autoCountSql(page, boundSql.getSql());PluginUtils.MPBoundSql mpBoundSql = PluginUtils.mpBoundSql(boundSql);countSql = new BoundSql(countMs.getConfiguration(), countSqlStr, mpBoundSql.parameterMappings(), parameter);PluginUtils.setAdditionalParameter(countSql, mpBoundSql.additionalParameters());}// 缓存CacheKey cacheKey = executor.createCacheKey(countMs, parameter, rowBounds, countSql);List<Object> result = executor.query(countMs, parameter, rowBounds, resultHandler, cacheKey, countSql);long total = 0;if (CollectionUtils.isNotEmpty(result)) {// 个别数据库 count 没数据不会返回 0Object o = result.get(0);if (o != null) {total = Long.parseLong(o.toString());}}page.setTotal(total);return continuePage(page);
}@Override
public void beforeQuery(Executor executor, MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) throws SQLException {IPage<?> page = ParameterUtils.findPage(parameter).orElse(null);if (null == page) {return;}// 处理 orderBy 拼接boolean addOrdered = false;String buildSql = boundSql.getSql();List<OrderItem> orders = page.orders();if (CollectionUtils.isNotEmpty(orders)) {addOrdered = true;buildSql = this.concatOrderBy(buildSql, orders);}// size 小于 0 且不限制返回值则不构造分页sqlLong _limit = page.maxLimit() != null ? page.maxLimit() : maxLimit;if (page.getSize() < 0 && null == _limit) {if (addOrdered) {PluginUtils.mpBoundSql(boundSql).sql(buildSql);}return;}// 最大为_limithandlerLimit(page, _limit);// 解析dialectIDialect dialect = findIDialect(executor);// 核心方法,根据各个Dialect构建SQLDialectModel model = dialect.buildPaginationSql(buildSql, page.offset(), page.getSize());PluginUtils.MPBoundSql mpBoundSql = PluginUtils.mpBoundSql(boundSql);List<ParameterMapping> mappings = mpBoundSql.parameterMappings();Map<String, Object> additionalParameter = mpBoundSql.additionalParameters();final Configuration configuration = ms.getConfiguration();model.consumers(mappings, configuration, additionalParameter);mpBoundSql.sql(model.getDialectSql());mpBoundSql.parameterMappings(mappings);
}

伏笔

个人猜测：很多开发者（和团队）最开始使用MyBatis，并使用PageHelper分页插件。后发现MyBatis-Plus确实比MyBatis好用，于是迁移到MP，形成MP+PageHelper共存的局面。在MP框架下PageHelper插件依然可以正常使用（有条件）。鄙人已经在至少两个公司的项目团队里看到这种混杂使用的情况：
在这里插入图片描述

问题

多依赖

后台系统，有一个列表页，点击第2页，没有响应。F12查看Chrome Console，控制台没有报错，说明不是前端JS报错。查看接口responseBody，发现分页有问题，nextPage=0：
在这里插入图片描述
后端分页有问题，对应的分页代码片段：

public String strategyList(JSONObject jsonObject) {PageHelper.startPage(Integer.parseInt(jsonObject.get("pageNo") + ""), Integer.parseInt(jsonObject.get("pageSize") + ""));list = channelPublicStrategyMapper.strategyList(jsonObject);PageInfo<Map> pageInfo = new PageInfo<>(list);return JSONObject.toJSONString(ServiceUtil.returnSuccessData(pageInfo));
}

看不出任何问题。调试，入参jsonObject.get("pageSize") == 10，前端传参没问题，但是最后返回的pageInfo包装信息不对劲：
在这里插入图片描述
到此时还是一脸懵逼。。

后来无意中点到源码，才发现PageHelper和PageInfo不是同一个依赖包的API：
在这里插入图片描述
同事随手提交的代码，这不坑人么？

反思

推荐在同一个项目中，只选用一种分页方式，统一代码风格。

参考

这篇关于MyBatis系列之分页插件及问题的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1089667。

相关文章

linux生产者，消费者问题

linux生产者，消费者问题

pthread_cond_wait() ：用于阻塞当前线程，等待别的线程使用pthread_cond_signal()或pthread_cond_broadcast来唤醒它。 pthread_cond_wait() 必须与pthread_mutex 配套使用。pthread_cond_wait()函数一进入wait状态就会自动release mutex。当其他线程通过pthread
阅读更多...
问题：第一次世界大战的起止时间是 #其他#学习方法#微信

问题：第一次世界大战的起止时间是 #其他#学习方法#微信

问题：第一次世界大战的起止时间是 A.1913 ~1918 年 B.1913 ~1918 年 C.1914 ~1918 年 D.1914 ~1919 年 参考答案如图所示
阅读更多...
2024.6.24 IDEA中文乱码问题（服务器 控制台 TOMcat）实测已解决

2024.6.24 IDEA中文乱码问题（服务器 控制台 TOMcat）实测已解决

1.问题产生原因： 1.文件编码不一致：如果文件的编码方式与IDEA设置的编码方式不一致，就会产生乱码。确保文件和IDEA使用相同的编码，通常是UTF-8。2.IDEA设置问题：检查IDEA的全局编码设置和项目编码设置是否正确。3.终端或控制台编码问题：如果你在终端或控制台看到乱码，可能是终端的编码设置问题。确保终端使用的是支持你的文件的编码方式。 2.解决方案： 1.File -> S
阅读更多...
持久层 技术选型如何决策？JPA，Hibernate，ibatis(mybatis)

持久层 技术选型如何决策？JPA，Hibernate，ibatis(mybatis)

转自：http://t.51jdy.cn/thread-259-1-1.html 持久层 是一个项目 后台 最重要的部分。他直接 决定了 数据读写的性能，业务编写的复杂度，数据结构(对象结构)等问题。 因此 架构师在考虑 使用那个持久层框架的时候 要考虑清楚。 选择的 标准： 1，项目的场景。 2，团队的技能掌握情况。 3，开发周期(开发效率)。 传统的 业务系统，通常业
阅读更多...
vcpkg安装opencv中的特殊问题记录（无法找到opencv_corexd.dll）

vcpkg安装opencv中的特殊问题记录（无法找到opencv_corexd.dll）

我是按照网上的vcpkg安装opencv方法进行的（比如这篇：从0开始在visual studio上安装opencv（超详细，针对小白）），但是中间出现了一些别人没有遇到的问题，虽然原因没有找到，但是本人给出一些暂时的解决办法： 问题1： 我在安装库命令行使用的是 .\vcpkg.exe install opencv 我的电脑是x64，vcpkg在这条命令后默认下载的也是opencv2:x6
阅读更多...
问题-windows-VPN不正确关闭导致网页打不开

问题-windows-VPN不正确关闭导致网页打不开

为什么会发生这类事情呢？ 主要原因是关机之前vpn没有关掉导致的。 至于为什么没关掉vpn会导致网页打不开，我猜测是因为vpn建立的链接没被更改。 正确关掉vpn的时候，会把ip链接断掉，如果你不正确关掉，ip链接没有断掉，此时你vpn又是没启动的，没有域名解析，所以就打不开网站。 你可以在打不开网页的时候，把vpn打开，你会发现网络又可以登录了。 方法一 注意：方法一虽然方便，但是可能会有
阅读更多...
vue同页面多路由懒加载-及可能存在问题的解决方式

vue同页面多路由懒加载-及可能存在问题的解决方式

先上图，再解释 图一是多路由页面，图二是路由文件。从图一可以看出每个router-view对应的name都不一样。从图二可以看出层路由对应的组件加载方式要跟图一中的name相对应，并且图二的路由层在跟图一对应的页面中要加上components层，多一个s结尾，里面的的方法名就是图一路由的name值，里面还可以照样用懒加载的方式。 页面上其他的路由在路由文件中也跟图二是一样的写法。 附送可能存在
阅读更多...
vue+elementui分页输入框回车与页面中@keyup.enter事件冲突解决

vue+elementui分页输入框回车与页面中@keyup.enter事件冲突解决

解决这个问题的思路只要判断事件源是哪个就好。el分页的回车触发事件是在按下时，抬起并不会再触发。而keyup.enter事件是在抬起时触发。 so，找不到分页的回车事件那就拿keyup.enter事件搞事情。只要判断这个抬起事件的$event中的锚点样式判断不等于分页特有的样式就可以了 @keyup.enter="allKeyup($event)" //页面上的//js中allKeyup(e
阅读更多...
vue+elementui--$message提示框被dialog遮罩层挡住问题解决

vue+elementui--$message提示框被dialog遮罩层挡住问题解决

最近碰到一个先执行this.$message提示内容，然后接着弹出dialog带遮罩层弹框。那么问题来了，message提示框会默认被dialog遮罩层挡住，现在就是要解决这个问题。 由于都是弹框，问题肯定是出在z-index比重问题。由于用$message方式是写在js中而不是写在html中所以不是很好直接去改样式。 不过好在message组件中提供了customClass 属性，我们可以利用
阅读更多...
Visual Studio中，MSBUild版本问题

Visual Studio中，MSBUild版本问题

假如项目规定了MSBUild版本，那么在安装完Visual Studio后，假如带的MSBUild版本与项目要求的版本不符合要求，那么可以把需要的MSBUild添加到系统中，然后即可使用。步骤如下：            假如项目需要使用V12的MSBUild，而安装的Visual Studio带的MSBUild版本为V14。 ①到MSDN下载V12 MSBUild包，把V12包解压到目录（
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2