MyBatis-Plus 分页插件中 pageSize 为 -1 时的处理机制解析

MyBatis-Plus 作为 MyBatis 的增强工具，其分页插件是开发者常用的功能之一。在实际开发中，我们可能会遇到需要查询全部数据而不进行分页的情况，这时通常会设置 pageSize 为 -1。本文将深入分析 MyBatis-Plus 分页插件在此场景下的处理机制。

问题背景

在 MyBatis-Plus 3.5.6 版本中，当开发者设置 Page 对象的 size 为 -1 时，期望的行为是不拼接 LIMIT 子句，从而获取全部数据。然而在某些配置下，插件会错误地拼接出 LIMIT -1 这样的 SQL 语句，导致数据库执行报错。

核心机制分析

MyBatis-Plus 分页插件通过 PaginationInnerInterceptor 类实现分页功能。其处理 LIMIT 子句的核心逻辑如下：

1. 首先检查是否启用了分页功能
2. 然后判断是否需要跳过 LIMIT 拼接
3. 最后计算 offset 和 limit 值

关键判断逻辑位于 beforeQuery 方法中，涉及三个重要参数：

• page.size：当前页大小
• page.maxLimit：页面级别的最大限制
• interceptor.maxLimit：拦截器级别的最大限制

问题根源

当同时满足以下条件时会出现问题：

1. page.size 设置为 -1
2. page.maxLimit 未设置（null）
3. interceptor.maxLimit 设置为 -1

在这种情况下，插件会错误地继续执行 LIMIT 拼接逻辑，最终生成 LIMIT -1 这样的非法 SQL。

解决方案

开发者可以通过以下方式避免此问题：

1. 推荐方案：将 interceptor.maxLimit 设置为 null 而不是 -1
2. 替代方案：在 Page 对象中明确设置 maxLimit 为 null
3. 代码修正：修改判断逻辑为 page.getSize() < 0 && _limit < 0

最佳实践

在使用 MyBatis-Plus 分页插件时，建议：

1. 明确区分"不分页"和"分页"两种场景
2. 对于不分页查询，设置 page.size = -1 并确保 maxLimit 为 null
3. 避免混用 -1 和 null 的配置方式
4. 升级到最新版本以获得更稳定的分页处理

总结

MyBatis-Plus 分页插件的这一行为提醒我们，在使用开源框架时需要充分理解其内部机制。特别是在处理边界条件时，如 pageSize 为 -1 的情况，应当仔细检查相关配置。通过合理配置 maxLimit 参数，可以确保分页插件在各种场景下都能正确工作。