还不会用mybatis-plus，手把手教你

深藏阁楼爱情的钟 2023-10-13 22:31 55阅读 0赞

## 还不会用mybatis-plus，手把手教你 ##

本文主要介绍mybatis-plus这款插件，针对springboot用户。包括引入，配置，使用，以及扩展等常用的方面做一个汇总整理，尽量包含大家常用的场景内容。

关于mybatis-plus是什么，不多做介绍了，看官方文档：https://baomidou.com/，咱们直接代码撸起来。

## 一、快速开始 ##

本文基于springboot、maven、jdk1.8、mysql开发，所以开始前我们需要准备好这套环境。我的环境使用了nacos作为注册中心，不了解或需要搭建的参考：[nacos2.0搭建与配置][nacos2.0]

新建如下数据库：

![image.png][]

建议大家选择utf8mb4这种字符集，做过微信的同学应该会知道，微信用户名称的表情，是需要这种字符集才能存储的。

我就默认其他环境已经准备好了，咱们直接从mybatis-plus开始。

### 1.1 依赖准备 ###

想要什么依赖版本的去maven仓库查看：[maven仓库地址][maven]

引入mybatis-plus依赖：

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

引入mysql依赖：

<dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.27</version>
    </dependency>

目前，多数项目会有多数据源的要求，或者是主从部署的要求，所以我们还需要引入mybatis-plus关于多数据源的依赖：

<dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>dynamic-datasource-spring-boot-starter</artifactId>
        <version>3.5.0</version>
    </dependency>

### 1.2 配置准备 ###

springboot启动类。配置@MapperScan注解，用于扫描Mapper文件位置:

import org.mybatis.spring.annotation.MapperScan;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
    
    @EnableDiscoveryClient
    @MapperScan("com.wjbgn.user.mapper")
    @SpringBootApplication
    public class RobNecessitiesUserApplication {
        
    
        public static void main(String[] args) {
        
            SpringApplication.run(RobNecessitiesUserApplication.class, args);
        }
    
    }

数据源配置，此处配置一主一从的环境，当前我只有一台，所以此处配置一样的：

spring:
      datasource:
        dynamic:
          primary: master #设置默认的数据源或者数据源组,默认值即为master
          strict: false #严格匹配数据源,默认false. true未匹配到指定数据源时抛异常,false使用默认数据源
          datasource:
            master:
              url: jdbc:mysql://127.0.0.1:3306/rob_necessities?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone =Asia/Shanghai
              username: root
              password: 123456
            slave_1:
              url: jdbc:mysql://127.0.0.1:3306/rob_necessities?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone =Asia/Shanghai
              username: root
              password: 123456

**补充**：这里面因为默认使用的是`HikariCP`数据源,目前也推荐使用这个，相比于`druid`有更高的性能，但是不能忽略下面的配置，否则服务会不断抛出异常，原因是数据库的连接时常和连接池的配置没有做好。

spring:
      datasource:
        dynamic:
          hikari:
            max-lifetime: 1800000
            connection-timeout: 5000
            idle-timeout: 3600000
            max-pool-size: 12
            min-idle: 4
            connection-test-query: /**ping*/

### 1.3 启动服务 ###

下面直接启动服务：

![image.png][image.png 1]

得到如上结果表示启动成功了。

## 二、使用 ##

前面我们成功的集成进来了mybatis-plus，配合springboot使用不要太方便。下面我们看看如何使用它来操作我们的数据库。介绍一下常规的用法。

### 2.1 实体类注解 ###

mybatis-plus为使用者封装了很多的注解，方便我们使用，我们首先看下实体类中有哪些注解。有如下的实体类：

@TableName(value = "user")
    public class UserDO {
        
    
        /**
         * 主键
         */
        @TableId(value = "id", type = IdType.AUTO)
        private Long id;
    
        /**
         * 昵称
         */
        @TableField("nickname")
        private String nickname;
    
        /**
         * 真实姓名
         */
        private String realName;
    }

*  @TableName 表名注解，用于标识实体类对应的表。
    
    其说明如下，关于这些书写，常规情况基本很少用到，不做多余解释了：

@Documented
      @Retention(RetentionPolicy.RUNTIME)
      @Target({
        ElementType.TYPE, ElementType.ANNOTATION_TYPE})
      public @interface TableName {
        
      
          /**
           * 实体对应的表名
           */
          String value() default "";
      
          /**
           * schema
           *
           * @since 3.1.1
           */
          String schema() default "";
      
          /**
           * 是否保持使用全局的 tablePrefix 的值
           * <p> 只生效于 既设置了全局的 tablePrefix 也设置了上面 {@link #value()} 的值 </p>
           * <li> 如果是 false , 全局的 tablePrefix 不生效 </li>
           *
           * @since 3.1.1
           */
          boolean keepGlobalPrefix() default false;
      
          /**
           * 实体映射结果集,
           * 只生效与 mp 自动注入的 method
           */
          String resultMap() default "";
      
          /**
           * 是否自动构建 resultMap 并使用,
           * 只生效与 mp 自动注入的 method,
           * 如果设置 resultMap 则不会进行 resultMap 的自动构建并注入,
           * 只适合个别字段 设置了 typeHandler 或 jdbcType 的情况
           *
           * @since 3.1.2
           */
          boolean autoResultMap() default false;
      
          /**
           * 需要排除的属性名
           *
           * @since 3.3.1
           */
          String[] excludeProperty() default {
        };
      }

*  @TableId 主键注解
    
    看看其源码：
    
        @Documented
        @Retention(RetentionPolicy.RUNTIME)
        @Target({
              ElementType.FIELD, ElementType.ANNOTATION_TYPE})
        public @interface TableId {
              
        
            /**
             * 字段值（驼峰命名方式，该值可无）
             */
            String value() default "";
        
            /**
             * 主键ID
             * {@link IdType}
             */
            IdType type() default IdType.NONE;
        }
    
    其中IdType很重要：
    
    <table> 
     <thead> 
      <tr> 
       <th>名称</th> 
       <th>描述</th> 
      </tr> 
     </thead> 
     <tbody> 
      <tr> 
       <td>AUTO</td> 
       <td>数据库自增ID</td> 
      </tr> 
      <tr> 
       <td>NONE</td> 
       <td>该类型为未设置主键类型(注解里等于跟随全局,全局里约等于 INPUT)</td> 
      </tr> 
      <tr> 
       <td>INPUT</td> 
       <td>用户自己设置的ID</td> 
      </tr> 
      <tr> 
       <td>ASSIGN_ID</td> 
       <td>当用户传入为空时，自动分配类型为Number或String的主键（雪花算法）</td> 
      </tr> 
      <tr> 
       <td>ASSIGN_UUID</td> 
       <td>当用户传入为空时，自动分配类型为String的主键</td> 
      </tr> 
     </tbody> 
    </table>
 *  @TableFiled 表字段标识
    
    下面看看其主要常用属性：
    
    <table> 
     <thead> 
      <tr> 
       <th>名称</th> 
       <th>描述</th> 
      </tr> 
     </thead> 
     <tbody> 
      <tr> 
       <td>value</td> 
       <td>数据库字段名</td> 
      </tr> 
      <tr> 
       <td>condition</td> 
       <td>字段 <code>where</code> 实体查询比较条件，通过<code>SqlCondition</code>设置 如果未设置条件，则按照正常相等来查询 若设置则按照以下规则： 等于：EQUAL = “%s=#{%s}”; 不等于：NOT_EQUAL = “%s&lt;&gt;#{%s}”; 左右模糊：LIKE = “%s LIKE CONCAT(‘%%’,#{%s},‘%%’)”; oracle左右模糊ORACLE_LIKE = “%s LIKE CONCAT(CONCAT(‘%%’,#{%s}),‘%%’)”; 左模糊：LIKE_LEFT = “%s LIKE CONCAT(‘%%’,#{%s})”; 右模糊：LIKE_RIGHT = “%s LIKE CONCAT(#{%s},‘%%’)”;</td> 
      </tr> 
      <tr> 
       <td>fill</td> 
       <td>自动填充策略，通过<code>FieldFill</code>设置 不处理：FieldFill.DEFAULT 插入时填充字段：FieldFill.INSERT 更新时填充字段：FieldFill.UPDATE 插入或新增时填充字段：FieldFill.INSERT_UPDATE</td> 
      </tr> 
     </tbody> 
    </table>
    
    关于其他的属性，我不太推荐使用，用得越多，越容易蒙圈。可以通过wapper查询去设置。

### 2.2 CRUD ###

mybatis-plus封装好了一条接口供我们直接调用。关于内部的具体方法，在使用时候自己体会吧，此处不列举了。

#### 2.2.1 Service层CRUD ####

我们使用的时候，需要在自己定义的service接口当中继承`IService`接口：

import com.baomidou.mybatisplus.extension.service.IService;
    import com.wjbgn.user.entity.UserDO;
    
    /**
     * @description： 用户服务接口
     */
    public interface IUserService extends IService<UserDO> {
        
    }

同时要在我们的接口实现impl当中继承`ServiceImpl`，实现自己的接口：

import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
    import com.wjbgn.user.entity.UserDO;
    import com.wjbgn.user.mapper.UserMapper;
    import com.wjbgn.user.service.IUserService;
    
    /**
     * @description： 用户接口实现
     */
    public class UserServiceImpl extends ServiceImpl<UserMapper, UserDO> implements IUserService {
        
    
    }

所以我们的

#### 2.2.2 Mapper层CRUD ####

mybatis-plus将常用的CRUD接口封装成了`BaseMapper`接口,我们只需要在自己的Mapper中继承它就可以了：

/**
     * @description： 用户mapper
     */
    @Mapper
    public interface UserMapper extends BaseMapper<UserDO> {
        
    }

### 2.3 分页 ###

使用分页话需要增加分页插件的配置：

import com.baomidou.mybatisplus.annotation.DbType;
    import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
    import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
    import org.mybatis.spring.annotation.MapperScan;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    
    @Configuration
    @MapperScan("com.wjbgn.*.mapper*")
    public class MybatisPlusConfig {
        
    
        @Bean
        public MybatisPlusInterceptor mybatisPlusInterceptor() {
        
            MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
            interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
            return interceptor;
        }
    
    }

如上配置后，我们直接使用分页方法就行。

### 2.4 逻辑删除配置 ###

很多情况下我们的系统都需要逻辑删除，方便恢复查找误删除的数据。

通过mybatis-plus可以通过全局配置的方式，而不需要再去手动处理。针对更新和查询操作有效，新增不做限制。

通常以我的习惯逻辑删除字段通常定义为`is_delete`,在实体类当中就是`isDelete`。那么在配置文件中就可以有如下的配置：

mybatis-plus:
      global-config:
        db-config:
          logic-delete-field: isDelete # 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置步骤2)
          logic-delete-value: 1 # 逻辑已删除值(默认为 1)
          logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)

或者通过注解`@TableLogic`

@TableLogic
    private Integer isDelete;

### 2.5 通用枚举配置 ###

相信后端的同学都经历过一个情况，比如`性别`这个字段，分别值和名称对应`1男`、`2女`,这个字段在数据库时是数值类型，而前端展示则是展示字符串的名称。有几种常见实现方案呢？

*  数据库查询sql通过case判断，返回名称，以前oracle经常这么做
 *  数据库返回的值，重新遍历赋值进去，这时候还需要判断这个值到底是男是女。
 *  前端写死，返回1就是男，返回2就是女。

相信无论哪种方法都有其缺点，所以我们可以使用mybatis-plus提供的方式。我们在返回给前端时：

*  只需要在遍历时get这个枚举，直接赋值其名称，不需要再次判断。
 *  直接返回给前端，让前端去去枚举的name

这样大家都不需要写死这个值。

下面看看如何实现这个功能：

*  兴义枚举，实现IEnum接口：
    
        import com.baomidou.mybatisplus.annotation.IEnum;
        import com.fasterxml.jackson.annotation.JsonFormat;
        
        /**
         * @description： 性别枚举
         */
        @JsonFormat(shape = JsonFormat.Shape.OBJECT)
        public enum SexEnum implements IEnum<Integer> {
              
            MAN(1, "男"),
            WOMAN(2, "女");
            private Integer code;
            private String name;
        
            SexEnum(Integer code, String name) {
              
                this.code = code;
                this.name = name;
            }
        
            @Override
            public Integer getValue() {
              
                return code;
            }
        
            public String getName() {
              
                return name;
            }
        
        }
    
    @JsonFormat注解为了解决枚举类返回前端只展示构造器名称的问题。
 *  实体类性别字段
    
        @TableName(value = "user")
        public class UserDO {
              
        
            /**
             * 主键
             */
            @TableId(value = "id", type = IdType.AUTO)
            private Long id;
        
            /**
             * 昵称
             */
            @TableField(value = "nickname",condition = SqlCondition.EQUAL)
            private String nickname;
        
            /**
             * 性别
             */
            @TableField(value = "sex")
            private SexEnum sex;
        
            /**
             * 版本
             */
            @TableField(value = "version",update = "%s+1")
            private Integer version;
        
            /**
             * 时间字段，自动添加
             */
            @TableField(value = "create_time",fill = FieldFill.INSERT)
            private LocalDateTime createTime;
        }
 *  配置文件扫描枚举
    
        mybatis-plus:
          # 支持统配符 * 或者 ; 分割
          typeEnumsPackage: com.wjbgn.*.enums
 *  定义配置文件
    
        @Bean
        public MybatisPlusPropertiesCustomizer mybatisPlusPropertiesCustomizer() {
              
            return properties -> {
              
                GlobalConfig globalConfig = properties.getGlobalConfig();
                globalConfig.setBanner(false);
                MybatisConfiguration configuration = new MybatisConfiguration();
                configuration.setDefaultEnumTypeHandler(MybatisEnumTypeHandler.class);
                properties.setConfiguration(configuration);
            };
        }
 *  序列化枚举值为数据库值
    
    以下我是使用的fastjson：
    
     *  全局（添加在前面的配置文件中）：
    
        @Bean
         public MybatisPlusPropertiesCustomizer mybatisPlusPropertiesCustomizer() {
              
             // 序列化枚举值为数据库存储值
             FastJsonConfig config = new FastJsonConfig();
             config.setSerializerFeatures(SerializerFeature.WriteEnumUsingToString);
        
             return properties -> {
              
                 GlobalConfig globalConfig = properties.getGlobalConfig();
                 globalConfig.setBanner(false);
                 MybatisConfiguration configuration = new MybatisConfiguration();
                 configuration.setDefaultEnumTypeHandler(MybatisEnumTypeHandler.class);
                 properties.setConfiguration(configuration);
             };
         }
    
     *  局部
    
        @JSONField(serialzeFeatures= SerializerFeature.WriteEnumUsingToString)
         private SexEnum sex;

### 2.6 自动填充 ###

还记得前面提到的实体类当中的注解`@TableFeild`吗？当中有个属性叫做fill，通过`FieldFill`设置属性，这个就是做自动填充用的。

public enum FieldFill {
        
        /**
         * 默认不处理
         */
        DEFAULT,
        /**
         * 插入填充字段
         */
        INSERT,
        /**
         * 更新填充字段
         */
        UPDATE,
        /**
         * 插入和更新填充字段
         */
        INSERT_UPDATE
    }

但是这个直接是不能使用的，需要通过实现mybatis-plus提供的接口，增加如下配置：

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
    import org.apache.ibatis.reflection.MetaObject;
    import org.springframework.stereotype.Component;
    
    import java.time.LocalDateTime;
    
    /**
     * description: 启动自动填充功能
     */
    @Component
    public class MyMetaObjectHandler implements MetaObjectHandler {
        
    
        @Override
        public void insertFill(MetaObject metaObject) {
        
            // 起始版本 3.3.0(推荐使用)
            this.strictInsertFill(metaObject, "createTime", LocalDateTime.class, LocalDateTime.now());
        }
    
        @Override
        public void updateFill(MetaObject metaObject) {
        
            // 起始版本 3.3.0(推荐)
            this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now());
        }
    }

字段如下：

/**
     * 时间字段，自动添加
     */
    @TableField(value = "create_time",fill = FieldFill.INSERT)
    private LocalDateTime createTime;

### 2.7 多数据源 ###

前面提到过，配置文件当中配置了主从的方式，其实mybatis-plus还支持更多的方式：

*  多主多从

spring:
      datasource:
        dynamic:
          primary: master #设置默认的数据源或者数据源组,默认值即为master
          strict: false #严格匹配数据源,默认false. true未匹配到指定数据源时抛异常,false使用默认数据源
          datasource:
            master_1:
            master_2:
            slave_1:
            slave_2:
            slave_3:

*  多种数据库

spring:
      datasource:
        dynamic:
          primary: mysql #设置默认的数据源或者数据源组,默认值即为master
          strict: false #严格匹配数据源,默认false. true未匹配到指定数据源时抛异常,false使用默认数据源
          datasource:
            mysql:
            oracle:
            postgresql:
            h2:
            sqlserver:

*  混合配置

spring:
      datasource:
        dynamic:
          primary: master #设置默认的数据源或者数据源组,默认值即为master
          strict: false #严格匹配数据源,默认false. true未匹配到指定数据源时抛异常,false使用默认数据源
          datasource:
            master_1:
            slave_1:
            slave_2:
            oracle_1:
            oracle_2:

上面的三种方式，除了混合配置，我觉得都有肯能出现的吧。

*  @DS注解

可以注解在方法上或类上，**同时存在就近原则 【方法上注解】 优先于 【类上注解】**：

@DS("slave_1")
    public class UserServiceImpl extends ServiceImpl<UserMapper, UserDO> implements IUserService {
        
    
    
        @DS("salve_1")
        @Override
        public List<UserDO> getList() {
        
            return this.getList();
        }
    
        @DS("master")
        @Override
        public int saveUser(UserDO userDO) {
        
            boolean save = this.save(userDO);
            if (save){
        
                return 1;
            }else{
        
                return 0;
            }
        }
    }

## 三、测试 ##

经过上面的配置，下面开始进入测试验证阶段。

建立一张表：

CREATE TABLE `user` (
      `id` int(11) NOT NULL AUTO_INCREMENT,
      `nickname` varchar(255) NOT NULL COMMENT '昵称',
      `sex` tinyint(1) NOT NULL COMMENT '性别，1男2女',
      `create_time` datetime NOT NULL COMMENT '创建时间',
      `is_delete` tinyint(1) NOT NULL DEFAULT '0' COMMENT '是否删除 1是，0否',
      PRIMARY KEY (`id`)
    ) ENGINE=InnoDB AUTO_INCREMENT=50 DEFAULT CHARSET=utf8mb4;

controller：

/**
     * @description： 用户controller
     */
    @RestController
    @RequestMapping("/user")
    public class UserController {
        
    
        @Autowired
        private IUserService userService;
    
        /**
         * description: 新增
         */
        @RequestMapping("/save")
        public boolean save() {
        
            UserDO userDO = new UserDO();
            userDO.setNickname("大漂亮");
            userDO.setSex(SexEnum.MAN);
    
            return userService.save(userDO);
        }
    
        /**
         * description: 修改
         */
        @RequestMapping("/update")
        public boolean update(@RequestParam String nickname,@RequestParam Long id) {
        
            UserDO userDO = new UserDO();
            userDO.setNickname(nickname);
            userDO.setId(id);
            return userService.updateById(userDO);
        }
    
        /**
         * description: 删除
         */
        @RequestMapping("/delete")
        public boolean delete(@RequestParam Long id) {
        
            UserDO userDO = new UserDO();
            userDO.setId(id);
            return userService.removeById(userDO);
        }
    
        /**
         * description: 列表
         */
        @RequestMapping("/list")
        public List<UserDO> list() {
        
            return userService.list();
        }
    
        /**
         * description: 分页列表
         * @param current
         * @param size
         * @return: com.baomidou.mybatisplus.extension.plugins.pagination.Page
         */
        @RequestMapping("/page")
        public Page page(@RequestParam int current,@RequestParam int size) {
        
            return userService.page(new Page<>(current,size), new QueryWrapper(new UserDO()));
        }
    
    }

记过上面的接口验证，功能没有问题，集成成功。

> 上文基本覆盖了mybatis-plus常用的特性，有同学说自动代码生成没说？后面会有专门的章节去讲解`mybatis-plus-generator` \+ `velocity`整合的文章，从后台代码，到前端代码全部一键生成。

![image.png][image.png 2]

[nacos2.0]: https://juejin.cn/post/7053977860612030477
[image.png]: https://img-blog.csdnimg.cn/img_convert/235a220bb7ee65995247e771163eaad5.webp?x-oss-process=image/format,png
[maven]: https://link.juejin.cn?target=https%3A%2F%2Fmvnrepository.com%2F
[image.png 1]: https://img-blog.csdnimg.cn/img_convert/31fe9406c4eccebca5ffd236aa536e34.webp?x-oss-process=image/format,png
[image.png 2]: https://img-blog.csdnimg.cn/img_convert/e61f88fd42849c84e3785d1964ade209.webp?x-oss-process=image/format,png