Spring Boot 整合 MyBatis-Plus 和 PageHelper

Spring Boot 集成 MyBatis-Plus 和 PageHelper

什么是 MyBatis-Plus？

MyBatis-Plus

MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

POM

在 pom.xml 文件中引入 mybatis-plus-boot-starter 依赖，该依赖会自动引入 MyBaits 相关依赖

<properties>
    <!-- orm -->
    <mybatis-plus-boot-starter.version>3.3.1</mybatis-plus-boot-starter.version>    
</properties>


<!-- orm -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>${mybatis-plus-boot-starter.version}</version>
</dependency>

application.yml

## MyBatis-Plus
mybatis-plus:
  mapper-locations: classpath*:/mapper/**/*.xml
  global-config:
    banner: false

创建配置文件

创建 MyBatis-Plus 配置文件，设置 MyBatis-Plus 要扫描 mapper 的包路径 com.inspur.boot.volume.*.mapper

import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import com.baomidou.mybatisplus.extension.plugins.pagination.optimize.JsqlParserCountOptimize;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;

/**
 * Mybatis Plus 配置类
 *
 * @author Guo.wl
 */
@Configuration // 配置类
@EnableTransactionManagement // 开启事务
@MapperScan(basePackages = "com.inspur.boot.volume.*.mapper") // 扫描 mapper 的包路径
public class MybatisPlusConfig {

    /**
     * 分页
     */
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
        // 设置请求的页面大于最大页后操作， true调回到首页，false 继续请求  默认false
        paginationInterceptor.setOverflow(false);
        // 设置最大单页限制数量，默认 500 条，-1 不受限制
        paginationInterceptor.setLimit(500);
        // 开启 count 的 join 优化,只针对部分 left join
        paginationInterceptor.setCountSqlParser(new JsqlParserCountOptimize(true));
        return paginationInterceptor;
    }

}

什么是 PageHelper

PageHelper

PageHelper 是 Mybatis 的分页插件，支持多数据库、多数据源。可以简化数据库的分页查询操作，整合过程也极其简单，只需引入依赖即可。

POM

在 pom.xml 文件中引入 pagehelper-spring-boot-starter 依赖

<properties>
    <pagehelper-spring-boot-starter.version>1.2.12</pagehelper-spring-boot-starter.version>    
</properties>


<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper-spring-boot-starter</artifactId>
    <version>${pagehelper-spring-boot-starter.version}</version>
</dependency>

application.yml

# Mybatis分页插件pageHelper
pagehelper:
  helper-dialect: mysql
  reasonable: true
  support-methods-arguments: false
  params: count=countSql

使用

// use static method startPage
PageHelper.startPage(1, 10);
List<User> list = userMapper.selectIf(1);
PageInfo pageInfo = new PageInfo(list);
// pageInfo.getTotal() == 查询记录总数