一、步骤概览

二、步骤说明

1.引入依赖

在 pom.xml 文件中引入 mybatis-plus 依赖包

<dependency>
  <groupId>com.baomidou</groupId>
 <artifactId>mybatis-plus-boot-starter</artifactId>
 <version>3.5.5</version>
</dependency>

2.定义配置项

在application.yml 配置文件中定义 mybatis-plus 配置项

# MyBatis Plus配置
mybatis-plus:
  # 搜索指定包别名
  typeAliasesPackage: com.shawn.**.model
  # 配置mapper的扫描，找到所有的mapper.xml映射文件
  mapperLocations: classpath*:mapper/**/*Mapper.xml
  # 加载全局的配置文件
  configLocation: classpath:mybatis/mybatis-config.xml

① typeAliasesPackage

指定包的别名，用于将包下的实体类注册为 MyBatis 的别名。在这个例子中，com.shawn.**.model 表示将 com.shawn 包及其子包下的所有 model 类都注册为别名。

② mapperLocations

配置 Mapper 的扫描路径，用于指定 MyBatis Plus 找到所有的 Mapper.xml 文件。classpath*:mapper/**/*Mapper.xml 表示在 classpath 下的 mapper 目录及其子目录中查找以 Mapper.xml 结尾的文件。

③ mapperLocations

加载全局的配置文件。classpath:mybatis/mybatis-config.xml 表示在 classpath 下的 mybatis 目录中查找 mybatis-config.xml 文件。mybatis-config.xml 详情如下所示：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <!-- 全局参数 -->
    <settings>
        <!-- 使全局的映射器启用或禁用缓存 -->
        <setting name="cacheEnabled"             value="true"   />
        <!-- 允许JDBC 支持自动生成主键 -->
        <setting name="useGeneratedKeys"         value="true"   />
        <!-- 配置默认的执行器.SIMPLE就是普通执行器;REUSE执行器会重用预处理语句(prepared statements);BATCH执行器将重用语句并执行批量更新 -->
        <setting name="defaultExecutorType"      value="SIMPLE" />
        <!-- 指定 MyBatis 所用日志的具体实现 -->
        <setting name="logImpl"                  value="SLF4J"  />
        <!-- 使用驼峰命名法转换字段 -->
        <!-- <setting name="mapUnderscoreToCamelCase" value="true"/> -->
    </settings>
</configuration>

3.配置 mybatis-plus

定义MyBatis Plus 的配置类，用于配置 MyBatis Plus 的插件和拦截器。代码概览如图所示：

• MybatisPlusConfig#mybatisPlusInterceptor：创建 MybatisPlusInterceptor 对象，并添加多个内部拦截器。

@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
  MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
  // 分页插件
  interceptor.addInnerInterceptor(paginationInnerInterceptor());
  // 乐观锁插件
  interceptor.addInnerInterceptor(optimisticLockerInnerInterceptor());
  // 阻断插件
  interceptor.addInnerInterceptor(blockAttackInnerInterceptor());
  return interceptor;
}

• MybatisPlusConfig#paginationInnerInterceptor：创建 PaginationInnerInterceptor 对象，用于分页查询。可以根据数据库类型设置不同的分页方言，默认设置为 MySQL

public PaginationInnerInterceptor paginationInnerInterceptor() {
  PaginationInnerInterceptor paginationInnerInterceptor = new PaginationInnerInterceptor();
  // 设置数据库类型为mysql
  paginationInnerInterceptor.setDbType(DbType.MYSQL);
  // 设置最大单页限制数量，默认 500 条，-1 不受限制
  paginationInnerInterceptor.setMaxLimit(-1L);
  return paginationInnerInterceptor;
}

• MybatisPlusConfig#optimisticLockerInnerInterceptor：创建 OptimisticLockerInnerInterceptor 对象，用于实现乐观锁功能。

public OptimisticLockerInnerInterceptor optimisticLockerInnerInterceptor() {
  return new OptimisticLockerInnerInterceptor();
}

• MybatisPlusConfig#blockAttackInnerInterceptor：创建BlockAttackInnerInterceptor 对象，用于阻止对全表的删除或更新操作。

public BlockAttackInnerInterceptor blockAttackInnerInterceptor() {
  return new BlockAttackInnerInterceptor();
}

4.设置扫描路径

在 springboot 启动类上添加 @MapperScan ，这样就可以自动扫描指定的 Mapper 接口，并生成相应的 Mapper Bean。设置示例如图所示：

5.封装分页参数

①. 封装请求

客户端发起分页查询请求，如果分页请求肯定包含页码和分页大小。我们单独封装基类，用于接收分页请求参数，接收请求参数的类(DTO) 后续可以直接集成分页请求基类。

• BasePageReq：分页请求基类

@Data
public class BasePageReq {
    private Long pageNum;
    private Long pageSize;
}

②. 封装返回

响应给客户端的数据，需要包含数据列表和分页详情，我们将其封装成统一的数据格式，便于客户端解析。

• BasePageRes：分页返回信息

@Data
@AllArgsConstructor
public class BasePageRes<T> {
    private int total;
    private int size;
    private int pages;
    private int current;
    private List<T> records;

    public BasePageRes(List<T> records, int total, int size, int current) {
        this.records = getCurrentList(records, size, current);
        this.total = total;
        this.size = size;
        this.current = current;
        this.pages = (int) Math.ceil((double) total / size);
    }

    public List<T> getCurrentList(List<T> records, int size, int current) {
        int toIndex = current * size > records.size() ? records.size() : current * size;
        return records.subList((current - 1) * size, toIndex);
    }

    public BasePageRes(IPage<T> page) {
        this.records = page.getRecords();
        this.total = (int) page.getTotal();
        this.size = (int) page.getSize();
        this.current = (int) page.getCurrent();
        this.pages = (int) page.getPages();
    }

    public static <E> BasePageRes<E> newInstance(IPage<E> page) {
        return new BasePageRes(page);
    }
}

三、代码测试

1.测试代码

①. mapper

②. service

③. controller

④. dto

2.测试结果