MyBatis-Plus 分頁插件配置的兩種方式實現

更新時間：2025年03月17日 09:41:01 作者：晟盾科技

本文主要介紹了MyBatis-Plus 分頁插件配置的兩種方式實現,包括使用PaginationInterceptor和MybatisPlusInterceptor兩種方式,具有一定的參考價值,感興趣的可以了解一下

一、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 來替代舊版本中的 PaginationInterceptor。MybatisPlusInterceptor作為一個繼集成了多種功能功能的攔截器，支持多種插件，如分頁插件、性能分析插件等，通過調用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;
    }