MyBatis-Plus 分页插件配置的两种方式实现

 更新时间:2025年03月17日 09:41:01   作者:晟盾科技  
本文主要介绍了MyBatis-Plus 分页插件配置的两种方式实现,包括使用PaginationInterceptor和MybatisPlusInterceptor两种方式,具有一定的参考价值,感兴趣的可以了解一下

在使用 MyBatis-Plus 进行数据库操作时,分页查询是一个非常常见的需求。MyBatis-Plus 提供了方便的分页插件来简化这一过程。本文将详细介绍如何正确配置 MyBatis-Plus 的分页插件(包括 MybatisPlusInterceptor 和 PaginationInterceptor)。

一、pom.xml文件配置

为了使用 MyBatis-Plus 的分页插件,你需要确保在你的 Maven 项目的 pom.xml 文件中正确添加了必要的依赖:(一般情况下,只添加mybatis-plus的起步依赖mybatis-plus-boot-starter就可以)

注意:将${mybatis-plus.version}替换为你的项目的mybatis-plus的版本号,或者在pom.xml的<properties>的标签中统一管理版本信息

<!-- MyBatis-Plus Boot Starter -->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>${mybatis-plus.version}</version>
    </dependency>
<!-- MyBatis-Plus Extension for PaginationInterceptor or MybatisPlusInterceptor -->                                                                            
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-extension</artifactId>
        <version>${mybatis-plus.version}</version>
    </dependency>

二、使用PaginationInterceptor

  • 适用于 MyBatis-Plus 3.4.0 之前的版本

如果你正在使用的是 MyBatis-Plus 3.4.0 之前的版本,那么你需要使用 PaginationInterceptor,它是专门用于处理分页逻辑的拦截器,在早期版本中,作为一个单独的插件提供分页功能,在Springboot框架下的应该采用如下方式进行配置:

import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * mybatis-plus配置
 */@ConfigurationpublicclassMybatisPlusConfig {

    /**
     * 添加分页插件
     */@Beanpublic PaginationInterceptor paginationInterceptor() {
        returnnewPaginationInterceptor();
    }

}

三、使用MybatisPlusInterceptor

  • 适用于 MyBatis-Plus 3.4.0 之后的版本

从 MyBatis-Plus 3.4.0 版本开始,官方推荐使用 MybatisPlusInterceptor 来替代旧版本中的 PaginationInterceptorMybatisPlusInterceptor作为一个继集成了多种功能功能的拦截器,支持多种插件,如分页插件、性能分析插件等,通过调用addInnerInterceptor()方法来使该拦截器具备各种功能。以下是官方文档中在SpringBoot框架下进行分页插件配置的方式

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * mybatis-plus配置
 */@ConfigurationpublicclassMybatisPlusConfig {

    /**
     * 添加分页插件
     */@Beanpublic MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptorinterceptor=newMybatisPlusInterceptor();
        // 添加分页插件, 如果配置多个插件, 切记分页最后添加
        interceptor.addInnerInterceptor(newPaginationInnerInterceptor(DbType.MYSQL));
        // 如果有多数据源可以不配具体类型, 否则都建议配上具体的 DbTypereturn interceptor;
    }

四、两种拦截器的对比

1. PaginationInterceptor:

  • 主要关注于分页功能,适用于只需要简单的分页逻辑的应用场景

2. MybatisPlusInterceptor:

  • 分页插件:实现分页逻辑
  • 性能分析插件:帮助监控 SQL 执行时间。
  • SQL 注入防护插件:提高应用安全性。
  • 多租户插件:支持多租户架构下的数据隔离。
  • 乐观锁插件:简化并发控制。

五、总结及建议

如果你正在开发或维护一个基于 MyBatis-Plus 3.4.0 之前的项目,并且你的需求仅仅是分页功能,那么 PaginationInterceptor 就足够了。

对于 MyBatis-Plus 3.4.0 及之后的版本,官方推荐使用 MybatisPlusInterceptor,因为它提供了更高的灵活性和更多的内置功能,可以根据实际需要轻松扩展应用的功能。

到此这篇关于MyBatis-Plus 分页插件配置的两种方式实现的文章就介绍到这了,更多相关MyBatis-Plus 分页内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java timezone设置和mybatis连接数据库时区设置方式

    Java timezone设置和mybatis连接数据库时区设置方式

    这篇文章主要介绍了Java timezone设置和mybatis连接数据库时区设置方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • Java异常处理机制throws举例详解

    Java异常处理机制throws举例详解

    这篇文章主要介绍了Java中异常处理机制,包括finally的使用、异步处理的方式(throws)、以及手动抛出异常,finally用于确保资源释放,throws用于声明方法可能抛出的异常,由调用者处理,手动抛出异常则是在特定条件下主动抛出异常对象,需要的朋友可以参考下
    2024-11-11
  • Java和Dubbo的SPI机制原理解析

    Java和Dubbo的SPI机制原理解析

    这篇文章主要介绍了Java和Dubbo的SPI机制原理解析,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-03-03
  • java连接mysql数据库实现单条插入和批量插入

    java连接mysql数据库实现单条插入和批量插入

    这篇文章主要为大家详细介绍了java连接mysql数据库实现单条插入和批量插入,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-08-08
  • Java中 !=null 的判断

    Java中 !=null 的判断

    空指针异常是出现频率比较高的bug,在出现空指针时,很多小伙伴都是习惯性地加一个 !=null 的判断,本文就来介绍一下如何使用,给感兴趣的可以了解下
    2025-02-02
  • 解决SpringBoot webSocket 资源无法加载、tomcat启动报错的问题

    解决SpringBoot webSocket 资源无法加载、tomcat启动报错的问题

    这篇文章主要介绍了解决SpringBoot webSocket 资源无法加载、tomcat启动报错的问题,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-11-11
  • Java Scanner对象中hasNext()与next()方法的使用

    Java Scanner对象中hasNext()与next()方法的使用

    这篇文章主要介绍了Java Scanner对象中hasNext()与next()方法的使用,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-10-10
  • java高级用法之JNA中的回调问题

    java高级用法之JNA中的回调问题

    这篇文章主要介绍了java高级用法之:JNA中的回调,为了方便和native方法进行交互,JNA中同样提供了Callback用来进行回调,JNA中回调的本质是一个指向native函数的指针,通过这个指针可以调用native函数中的方法,一起来看看吧
    2022-05-05
  • springboot+websocket+redis搭建的实现

    springboot+websocket+redis搭建的实现

    这篇文章主要介绍了springboot+websocket+redis搭建的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-04-04
  • IDEA打开java项目后里面的java文件不能运行解决办法

    IDEA打开java项目后里面的java文件不能运行解决办法

    这篇文章主要给大家介绍了关于IDEA打开java项目后里面的java文件不能运行的解决办法,有时候想运行别人的项目,但是别人的项目并非IDEA项目(甚至只有源码),当我们打开项目时候,并不能运行,需要的朋友可以参考下
    2023-10-10

最新评论