mybatis-plus分页插件新版本失效问题

在升级Mybatis-Plus到3.5.2版本后,发现原有的分页插件PaginationInterceptor已被移除,官方推荐使用PaginationInnerInterceptor。本文档记录了如何配置新的分页插件,包括防止全表更新删除的BlockAttackInnerInterceptor和分页插件PaginationInnerInterceptor的详细设置。

背景

搭建新环境时,升级了下mybatis-plus的版本到 3.5.2,结果发现原本的分页插件 PaginationInterceptor 已被剔除,从官网得知需使用 PaginationInnerInterceptor,在此记录一下。

代码

/**
 * mybatis-plus 全局配置
 *
 * @author wrx
 * @date 2022/7/19 10:52
 */
@Configuration
@MapperScan("com.tz4cloud.mapper")
public class MybatisPlusConfig {
    /**
     * 插件配置:1.阻止恶意或误操作的全表更新删除 2.分页插件
     *
     * @return MybatisPlusInterceptor
     * @author wrx
     * @date 2022/7/19 10:53
     */
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        //阻止恶意或误操作的全表更新删除
        interceptor.addInnerInterceptor(new BlockAttackInnerInterceptor());
        //分页插件
        PaginationInnerInterceptor pageInterceptor = new PaginationInnerInterceptor(DbType.MYSQL);
        pageInterceptor.setMaxLimit(500L);
        // 开启 count 的 join 优化,只针对部分 left join
        pageInterceptor.setOptimizeJoin(true);
        interceptor.addInnerInterceptor(pageInterceptor);
        return interceptor;
    }
}

有个奇怪的地方,新版本如果单独将 PaginationInnerInterceptor 作为@Bean配置,并不会起效果。

在使用 MyBatis 时,若希望同时使用 MyBatis-Plus分页功能和 PageHelper 分页插件,并实现兼容性处理,需要注意两者的集成方式和执行顺序,以避免冲突或分页失效问题。 ### 配置与依赖管理 首先,确保项目中正确入了 MyBatis-Plus 和 PageHelper 的相关依赖。通常,PageHelper 作为独立的插件,可以通过入其 JAR 包直接使用,而 MyBatis-Plus分页功能则需要集成其核心库。在 `pom.xml` 中添加如下依赖: ```xml <!-- MyBatis-Plus --> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.5.3</version> </dependency> <!-- PageHelper --> <dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper-spring-boot-starter</artifactId> <version>1.4.2</version> </dependency> ``` ### 插件加载顺序 在 MyBatis 配置中,插件的加载顺序会影响分页行为。PageHelper 的官方文档建议将其配置在 MyBatis 插件链的最前端,以确保其分页逻辑优先执行。如果使用的是 Spring Boot,可以通过配置类来调整插件顺序: ```java @Configuration public class MyBatisConfig { @Bean public PageInterceptor pageInterceptor() { return new PageInterceptor(); } @Bean public ConfigurationCustomizer configurationCustomizer() { return configuration -> { configuration.setMapUnderscoreToCamelCase(true); // 添加 PageHelper 插件 configuration.setInterceptors(Collections.singletonList(new PageInterceptor())); }; } } ``` ### 分页调用方式的选择 在实际调用时,MyBatis-Plus 和 PageHelper 使用同的方式启动分页操作。MyBatis-Plus 通过构造 `Page` 对象并传递给查询方法实现分页: ```java Page<User> page = new Page<>(pageNum, pageSize); IPage<User> userPage = userMapper.selectPage(page, null); ``` 而 PageHelper 则通过静态方法 `PageHelper.startPage()` 来开启分页: ```java PageHelper.startPage(pageNum, pageSize); List<User> users = userMapper.selectAll(); ``` 为了避免冲突,建议在同一个查询中只使用一种分页方式。如果确实需要在同场景下混合使用,可以将两种分页逻辑隔离在同的服务方法中,确保每次查询只使用一个分页插件。 ### 处理多表联查等复杂场景 对于多表联查等复杂 SQL 场景,MyBatis-Plus分页机制可能存在一定的限制,例如在嵌套查询中分页失效。此时,PageHelper 提供了更强的适应性,能够更好地支持复杂 SQL 的分页需求。在这种情况下,推荐优先使用 PageHelper 的分页插件。 ### 分页结果的封装与返回 无论使用哪种分页方式,最终都需要将分页结果封装为统一的响应格式。以 PageHelper 为例,可以通过 `PageInfo` 对象封装分页信息并返回: ```java PageHelper.startPage(pageNum, pageSize); List<User> users = userMapper.selectAll(); PageInfo<User> pageInfo = new PageInfo<>(users); return pageInfo; ``` 而对于 MyBatis-Plus分页结果,可以通过 `IPage` 接口获取总记录数和当前页数据,并自行封装为统一的响应格式。 ### 性能与 COUNT 查询控制 两者都支持自动执行 COUNT 查询来获取总记录数,但也可以通过配置关闭该功能以提升性能。例如,在 PageHelper 中可以通过 `PageHelper.offsetPage()` 方法跳过 COUNT 查询: ```java PageHelper.offsetPage((pageNum - 1) * pageSize, pageSize, false); List<User> users = userMapper.selectAll(); ``` 而在 MyBatis-Plus 中,可以通过 `Page` 对象的构造参数控制是否执行 COUNT 查询: ```java Page<User> page = new Page<>(pageNum, pageSize, false); IPage<User> userPage = userMapper.selectPage(page, null); ``` ### 多数据源支持 如果项目中涉及多数据源,PageHelper 天然支持多数据源环境下的分页操作,而 MyBatis-Plus 则需要额外的配置或使用动态数据源插件来实现多数据源下的分页支持。 ---
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值