【MyBatis-Plus】快速精通Mybatis-plus框架—快速入门

傷城~ 2024-02-25 07:46 13阅读 0赞

大家在日常开发中应该能发现，单表的CRUD功能代码重复度很高，也没有什么难度。而这部分代码量往往比较大，开发起来比较费时。

因此，目前企业中都会使用一些组件来简化或省略单表的CRUD开发工作。目前在国内使用较多的一个组件就是MybatisPlus.

官方网站如下：

![4147e5c481e84d359f3a52bfe2c492ec.png][]

当然，MybatisPlus不仅仅可以简化单表操作，而且还对Mybatis的功能有很多的增强。可以让我们的开发更加的简单，高效。

通过今天的学习，我们要达成下面的目标：

*  能利用MybatisPlus实现基本的CRUD
 *  会使用条件构建造构建查询和更新语句
 *  会使用MybatisPlus中的常用注解
 *  会使用MybatisPlus处理枚举、JSON类型字段
 *  会使用MybatisPlus实现分页

为了方便测试，我们先创建一个新的项目，并准备一些基础数据。

## 1.环境准备 ##

复制课前资料提供好的一个项目到你的工作空间（不要包含空格和特殊字符）：

![f4f7175966ee4f2e95109f53e405ebc6.png][]

然后用你的IDEA工具打开，项目结构如下：

![9488aed630ec4b869a58e2898aadadf5.png][]

注意配置一下项目的JDK版本为JDK11。首先点击项目结构设置：

![91795f57a8524865836f77604dc6985f.png][]

在弹窗中配置JDK：

![c2f7025096a84c06bd858771bbe009e8.png][]

接下来，要导入两张表，在课前资料中已经提供了SQL文件：

![6bb83ed77065413d8dfb8450215fb18d.png][]

对应的数据库表结构如下：

![f9dcb7b529ac44e29e212602738e7ff3.png][]

最后，在`application.yaml`中修改jdbc参数为你自己的数据库参数：

spring:
      datasource:
        url: jdbc:mysql://127.0.0.1:3306/mp?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
        driver-class-name: com.mysql.cj.jdbc.Driver
        username: root
        password: MySQL123
    logging:
      level:
        com.itheima: debug
      pattern:
        dateformat: HH:mm:ss

## 2.快速开始 ##

比如我们要实现User表的CRUD，只需要下面几步：

*  引入MybatisPlus依赖
 *  定义Mapper

### 2.1引入依赖 ###

MybatisPlus提供了starter，实现了自动Mybatis以及MybatisPlus的自动装配功能，坐标如下：

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

由于这个starter包含对mybatis的自动装配，因此完全可以替换掉Mybatis的starter。 最终，项目的依赖如下：

<dependencies>
 <dependency>
 <groupId>com.baomidou</groupId>
 <artifactId>mybatis-plus-boot-starter</artifactId>
 <version>3.5.3.1</version>
 </dependency>
 <dependency>
 <groupId>com.mysql</groupId>
 <artifactId>mysql-connector-j</artifactId>
 <scope>runtime</scope>
 </dependency>
 <dependency>
 <groupId>org.projectlombok</groupId>
 <artifactId>lombok</artifactId>
 <optional>true</optional>
 </dependency>
 <dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-test</artifactId>
 <scope>test</scope>
 </dependency>
 </dependencies>

### 2.2定义Mapper ###

为了简化单表CRUD，MybatisPlus提供了一个基础的`BaseMapper`接口，其中已经实现了单表的CRUD：

![54d2ff54ccd74615a400068f1b0ffe02.png][]

因此我们自定义的Mapper只要实现了这个`BaseMapper`，就无需自己实现单表CRUD了。 修改mp-demo中的`com.itheima.mp.mapper`包下的`UserMapper`接口，让其继承`BaseMapper`：

![4d097d77ca334687b77a2a80ed2a0be1.png][]

代码如下：

package com.itheima.mp.mapper;
 
 import com.baomidou.mybatisplus.core.mapper.BaseMapper;
 import com.itheima.mp.domain.po.User;
 
 public interface UserMapper extends BaseMapper<User> {
 }

### 2.3测试 ###

新建一个测试类，编写几个单元测试，测试基本的CRUD功能：

package com.itheima.mp.mapper;
 
 import com.itheima.mp.domain.po.User;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.context.SpringBootTest;
 
 import java.time.LocalDateTime;
 import java.util.List;
 
 @SpringBootTest
 class UserMapperTest {
 
 @Autowired
 private UserMapper userMapper;
 
 @Test
 void testInsert() {
 User user = new User();
 user.setId(5L);
 user.setUsername("Lucy");
 user.setPassword("123");
 user.setPhone("18688990011");
 user.setBalance(200);
 user.setInfo("{\"age\": 24, \"intro\": \"英文老师\", \"gender\": \"female\"}");
 user.setCreateTime(LocalDateTime.now());
 user.setUpdateTime(LocalDateTime.now());
 userMapper.insert(user);
 }
 
 @Test
 void testSelectById() {
 User user = userMapper.selectById(5L);
 System.out.println("user = " + user);
 }
 
 @Test
 void testSelectByIds() {
 List<User> users = userMapper.selectBatchIds(List.of(1L, 2L, 3L, 4L, 5L));
 users.forEach(System.out::println);
 }
 
 @Test
 void testUpdateById() {
 User user = new User();
 user.setId(5L);
 user.setBalance(20000);
 userMapper.updateById(user);
 }
 
 @Test
 void testDelete() {
 userMapper.deleteById(5L);
 }
 }

可以看到，在运行过程中打印出的SQL日志，非常标准：

11:05:01 INFO 15524 --- [ main] com.zaxxer.hikari.HikariDataSource : HikariPool-1 - Starting...
 11:05:02 INFO 15524 --- [ main] com.zaxxer.hikari.HikariDataSource : HikariPool-1 - Start completed.
 11:05:02 DEBUG 15524 --- [ main] c.i.mp.mapper.UserMapper.selectById : ==> Preparing: SELECT id,username,password,phone,info,status,balance,create_time,update_time FROM user WHERE id=?
 11:05:02 DEBUG 15524 --- [ main] c.i.mp.mapper.UserMapper.selectById : ==> Parameters: 5(Long)
 11:05:02 DEBUG 15524 --- [ main] c.i.mp.mapper.UserMapper.selectById : <== Total: 1
 user = User(id=5, username=Lucy, password=123, phone=18688990011, info={"age": 21}, status=1, balance=20000, createTime=Fri Jun 30 11:02:30 CST 2023, updateTime=Fri Jun 30 11:02:30 CST 2023)

## 3.常见注解 ##

在刚刚的入门案例中，我们仅仅引入了依赖，继承了BaseMapper就能使用MybatisPlus，非常简单。但是问题来了： MybatisPlus如何知道我们要查询的是哪张表？表中有哪些字段呢？

大家回忆一下，UserMapper在继承BaseMapper的时候指定了一个泛型：

![567df99daf9a4b3a851a03c627446e4b.png][]

泛型中的User就是与数据库对应的PO.

MybatisPlus就是根据PO实体的信息来推断出表的信息，从而生成SQL的。默认情况下：

*  MybatisPlus会把PO实体的类名驼峰转下划线作为表名
 *  MybatisPlus会把PO实体的所有变量名驼峰转下划线作为表的字段名，并根据变量类型推断字段类型
 *  MybatisPlus会把名为id的字段作为主键

但很多情况下，默认的实现与实际场景不符，因此MybatisPlus提供了一些注解便于我们声明表信息。

### 3.1@TableName ###

说明：

*  描述：表名注解，标识实体类对应的表
 *  使用位置：实体类

示例：

@TableName("user")
    public class User {
        private Long id;
        private String name;
    }

TableName注解除了指定表名以外，还可以指定很多其它属性：

<table> 
 <tbody> 
 <tr> 
 <td colspan="1"> 属性 </td> 
 <td colspan="1"> 类型 </td> 
 <td colspan="1"> 必须指定 </td> 
 <td colspan="1"> 默认值 </td> 
 <td colspan="1"> 描述 </td> 
 </tr> 
 <tr> 
 <td colspan="1"> value </td> 
 <td colspan="1"> String </td> 
 <td colspan="1"> 否 </td> 
 <td colspan="1"> "" </td> 
 <td colspan="1"> 表名 </td> 
 </tr> 
 <tr> 
 <td colspan="1"> schema </td> 
 <td colspan="1"> String </td> 
 <td colspan="1"> 否 </td> 
 <td colspan="1"> "" </td> 
 <td colspan="1"> schema </td> 
 </tr> 
 <tr> 
 <td colspan="1"> keepGlobalPrefix </td> 
 <td colspan="1"> boolean </td> 
 <td colspan="1"> 否 </td> 
 <td colspan="1"> false </td> 
 <td colspan="1"> 是否保持使用全局的 tablePrefix 的值（当全局 tablePrefix 生效时） </td> 
 </tr> 
 <tr> 
 <td colspan="1"> resultMap </td> 
 <td colspan="1"> String </td> 
 <td colspan="1"> 否 </td> 
 <td colspan="1"> "" </td> 
 <td colspan="1"> xml 中 resultMap 的 id（用于满足特定类型的实体类对象绑定） </td> 
 </tr> 
 <tr> 
 <td colspan="1"> autoResultMap </td> 
 <td colspan="1"> boolean </td> 
 <td colspan="1"> 否 </td> 
 <td colspan="1"> false </td> 
 <td colspan="1"> 是否自动构建 resultMap 并使用（如果设置 resultMap 则不会进行 resultMap 的自动构建与注入） </td> 
 </tr> 
 <tr> 
 <td colspan="1"> excludeProperty </td> 
 <td colspan="1"> String[] </td> 
 <td colspan="1"> 否 </td> 
 <td colspan="1"> {} </td> 
 <td colspan="1"> 需要排除的属性名 @since 3.3.1 </td> 
 </tr> 
 </tbody> 
</table>

### 3.2@TableId ###

说明：

*  描述：主键注解，标识实体类中的主键字段
 *  使用位置：实体类的主键字段

示例：

@TableName("user")
    public class User {
        @TableId
        private Long id;
        private String name;
    }

`TableId`注解支持两个属性：

<table> 
 <thead> 
 <tr> 
 <th colspan="1"> 属性 </th> 
 <th colspan="1"> 类型 </th> 
 <th colspan="1"> 必须指定 </th> 
 <th colspan="1"> 默认值 </th> 
 <th colspan="1"> 描述 </th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td colspan="1"> value </td> 
 <td colspan="1"> String </td> 
 <td colspan="1"> 否 </td> 
 <td colspan="1"> "" </td> 
 <td colspan="1"> 表名 </td> 
 </tr> 
 <tr> 
 <td colspan="1"> type </td> 
 <td colspan="1"> Enum </td> 
 <td colspan="1"> 否 </td> 
 <td colspan="1"> IdType.NONE </td> 
 <td colspan="1"> 指定主键类型 </td> 
 </tr> 
 </tbody> 
</table>

`IdType`支持的类型有：

<table> 
 <thead> 
 <tr> 
 <th colspan="1"> 值 </th> 
 <th colspan="1"> 描述 </th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td colspan="1"> AUTO </td> 
 <td colspan="1"> 数据库 ID 自增 </td> 
 </tr> 
 <tr> 
 <td colspan="1"> NONE </td> 
 <td colspan="1"> 无状态，该类型为未设置主键类型（注解里等于跟随全局，全局里约等于 INPUT） </td> 
 </tr> 
 <tr> 
 <td colspan="1"> INPUT </td> 
 <td colspan="1"> insert 前自行 set 主键值 </td> 
 </tr> 
 <tr> 
 <td colspan="1"> ASSIGN_ID </td> 
 <td colspan="1"> 分配 ID(主键类型为 Number(Long 和 Integer)或 String)(since 3.3.0),使用接口IdentifierGenerator的方法nextId(默认实现类为DefaultIdentifierGenerator雪花算法) </td> 
 </tr> 
 <tr> 
 <td colspan="1"> ASSIGN_UUID </td> 
 <td colspan="1"> 分配 UUID,主键类型为 String(since 3.3.0),使用接口IdentifierGenerator的方法nextUUID(默认 default 方法) </td> 
 </tr> 
 <tr> 
 <td colspan="1"> ID_WORKER </td> 
 <td colspan="1"> 分布式全局唯一 ID 长整型类型(please use ASSIGN_ID) </td> 
 </tr> 
 <tr> 
 <td colspan="1"> UUID </td> 
 <td colspan="1"> 32 位 UUID 字符串(please use ASSIGN_UUID) </td> 
 </tr> 
 <tr> 
 <td colspan="1"> ID_WORKER_STR </td> 
 <td colspan="1"> 分布式全局唯一 ID 字符串类型(please use ASSIGN_ID) </td> 
 </tr> 
 </tbody> 
</table>

这里比较常见的有三种：

*  `AUTO`：利用数据库的id自增长
 *  `INPUT`：手动生成id
 *  `ASSIGN_ID`：雪花算法生成`Long`类型的全局唯一id，这是默认的ID策略

### 3.3@TableField ###

说明：

> 描述：普通字段注解

示例：

@TableName("user")
    public class User {
        @TableId
        private Long id;
        private String name;
        private Integer age;
        @TableField("isMarried")
        private Boolean isMarried;
        @TableField("concat")
        private String concat;
    }

一般情况下我们并不需要给字段添加`@TableField`注解，一些特殊情况除外：

*  成员变量名与数据库字段名不一致
 *  成员变量是以`isXXX`命名，按照`JavaBean`的规范，`MybatisPlus`识别字段时会把`is`去除，这就导致与数据库不符。
 *  成员变量名与数据库一致，但是与数据库的关键字冲突。使用`@TableField`注解给字段名添加\`\`\`\`转义

支持的其它属性如下：

<table> 
 <tbody> 
 <tr> 
 <td colspan="1"> 属性 </td> 
 <td colspan="1"> 类型 </td> 
 <td colspan="1"> 必填 </td> 
 <td colspan="1"> 默认值 </td> 
 <td colspan="1"> 描述 </td> 
 </tr> 
 <tr> 
 <td colspan="1"> value </td> 
 <td colspan="1"> String </td> 
 <td colspan="1"> 否 </td> 
 <td colspan="1"> "" </td> 
 <td colspan="1"> 数据库字段名 </td> 
 </tr> 
 <tr> 
 <td colspan="1"> exist </td> 
 <td colspan="1"> boolean </td> 
 <td colspan="1"> 否 </td> 
 <td colspan="1"> true </td> 
 <td colspan="1"> 是否为数据库表字段 </td> 
 </tr> 
 <tr> 
 <td colspan="1"> condition </td> 
 <td colspan="1"> String </td> 
 <td colspan="1"> 否 </td> 
 <td colspan="1"> "" </td> 
 <td colspan="1"> 字段 where 实体查询比较条件，有值设置则按设置的值为准，没有则为默认全局的 %s=#{%s}，<a href="https://github.com/baomidou/mybatis-plus/blob/3.0/mybatis-plus-annotation/src/main/java/com/baomidou/mybatisplus/annotation/SqlCondition.java" title="参考(opens new window)" rel="nofollow">参考(opens new window)</a> </td> 
 </tr> 
 <tr> 
 <td colspan="1"> update </td> 
 <td colspan="1"> String </td> 
 <td colspan="1"> 否 </td> 
 <td colspan="1"> "" </td> 
 <td colspan="1"> 字段 update set 部分注入，例如：当在version字段上注解update="%s+1" 表示更新时会 set version=version+1 （该属性优先级高于 el 属性） </td> 
 </tr> 
 <tr> 
 <td colspan="1"> insertStrategy </td> 
 <td colspan="1"> Enum </td> 
 <td colspan="1"> 否 </td> 
 <td colspan="1"> FieldStrategy.DEFAULT </td> 
 <td colspan="1"> 举例：NOT_NULL insert into table_a(&lt;if test="columnProperty != null"&gt;column&lt;/if&gt;) values (&lt;if test="columnProperty != null"&gt;#{columnProperty}&lt;/if&gt;) </td> 
 </tr> 
 <tr> 
 <td colspan="1"> updateStrategy </td> 
 <td colspan="1"> Enum </td> 
 <td colspan="1"> 否 </td> 
 <td colspan="1"> FieldStrategy.DEFAULT </td> 
 <td colspan="1"> 举例：IGNORED update table_a set column=#{columnProperty} </td> 
 </tr> 
 <tr> 
 <td colspan="1"> whereStrategy </td> 
 <td colspan="1"> Enum </td> 
 <td colspan="1"> 否 </td> 
 <td colspan="1"> FieldStrategy.DEFAULT </td> 
 <td colspan="1"> 举例：NOT_EMPTY where &lt;if test="columnProperty != null and columnProperty!=''"&gt;column=#{columnProperty}&lt;/if&gt; </td> 
 </tr> 
 <tr> 
 <td colspan="1"> fill </td> 
 <td colspan="1"> Enum </td> 
 <td colspan="1"> 否 </td> 
 <td colspan="1"> FieldFill.DEFAULT </td> 
 <td colspan="1"> 字段自动填充策略 </td> 
 </tr> 
 <tr> 
 <td colspan="1"> select </td> 
 <td colspan="1"> boolean </td> 
 <td colspan="1"> 否 </td> 
 <td colspan="1"> true </td> 
 <td colspan="1"> 是否进行 select 查询 </td> 
 </tr> 
 <tr> 
 <td colspan="1"> keepGlobalFormat </td> 
 <td colspan="1"> boolean </td> 
 <td colspan="1"> 否 </td> 
 <td colspan="1"> false </td> 
 <td colspan="1"> 是否保持使用全局的 format 进行处理 </td> 
 </tr> 
 <tr> 
 <td colspan="1"> jdbcType </td> 
 <td colspan="1"> JdbcType </td> 
 <td colspan="1"> 否 </td> 
 <td colspan="1"> JdbcType.UNDEFINED </td> 
 <td colspan="1"> JDBC 类型 (该默认值不代表会按照该值生效) </td> 
 </tr> 
 <tr> 
 <td colspan="1"> typeHandler </td> 
 <td colspan="1"> TypeHander </td> 
 <td colspan="1"> 否 </td> 
 <td colspan="1"> </td> 
 <td colspan="1"> 类型处理器 (该默认值不代表会按照该值生效) </td> 
 </tr> 
 <tr> 
 <td colspan="1"> numericScale </td> 
 <td colspan="1"> String </td> 
 <td colspan="1"> 否 </td> 
 <td colspan="1"> "" </td> 
 <td colspan="1"> 指定小数点后保留的位数 </td> 
 </tr> 
 </tbody> 
</table>

## 4.常见配置 ##

MybatisPlus也支持基于yaml文件的自定义配置，详见官方文档：

大多数的配置都有默认值，因此我们都无需配置。但还有一些是没有默认值的，例如:

*  实体类的别名扫描包
 *  全局id类型

mybatis-plus:
      type-aliases-package: com.itheima.mp.domain.po
      global-config:
        db-config:
          id-type: auto # 全局id类型为自增长

需要注意的是，MyBatisPlus也支持手写SQL的，而mapper文件的读取地址可以自己配置：

mybatis-plus:
      mapper-locations: "classpath*:/mapper/**/*.xml" # Mapper.xml文件地址，当前这个是默认值。

可以看到默认值是`classpath*:/mapper/**/*.xml`，也就是说我们只要把mapper.xml文件放置这个目录下就一定会被加载。

例如，我们新建一个`UserMapper.xml`文件：

![59d4ecbf8d1b4011aafa9e776f93d4f1.png][]

然后在其中定义一个方法：

<?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
 <mapper namespace="com.itheima.mp.mapper.UserMapper">
 
 <select id="queryById" resultType="User">
 SELECT * FROM user WHERE id = #{id}
 </select>
 </mapper>

然后在测试类`UserMapperTest`中测试该方法：

@Test
    void testQuery() {
        User user = userMapper.queryById(1L);
        System.out.println("user = " + user);
    }

[4147e5c481e84d359f3a52bfe2c492ec.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/25/f8c7a7a22bbc4cb9870fd6b0d4424da2.png
[f4f7175966ee4f2e95109f53e405ebc6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/25/c0fd1f01e72a42239b6ba622c3dd70b7.png
[9488aed630ec4b869a58e2898aadadf5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/25/78505000974a4b63a6988ffd3ca1ec3b.png
[91795f57a8524865836f77604dc6985f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/25/29d9d0dcebf348a7b73f280516052eb3.png
[c2f7025096a84c06bd858771bbe009e8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/25/5a55b9632a1d4fbeb596b1936808436d.png
[6bb83ed77065413d8dfb8450215fb18d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/25/aebf9db2cc7144d4b11372d65bcb2662.png
[f9dcb7b529ac44e29e212602738e7ff3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/25/3665441203974ee6bd7b0c5355eab35a.png
[54d2ff54ccd74615a400068f1b0ffe02.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/25/a6d2a4a2c78a484ebac23918bfcc8dcd.png
[4d097d77ca334687b77a2a80ed2a0be1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/25/966eb567b52e43869f9336ec1667fdeb.png
[567df99daf9a4b3a851a03c627446e4b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/25/9935d0773fd046c4b5cacd739d3fbc8f.png
[59d4ecbf8d1b4011aafa9e776f93d4f1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/25/2e002086f8974db5ad90d2c7a7b241a6.png