看了我的 mybatis-plus 用法，全公司同事開始悄悄模仿了。。

本文主要介紹 mybatis-plus 這款插件，針對 springboot 用戶，包括引入，配置，使用，以及擴展等常用的方面做一個匯總整理，盡量包含大家常用的場景內容，

作者：我犟不過你　
原文鏈接：https://juejin.cn/post/7054726274362638350

關于 mybatis-plus 是什么，不多做介紹了，看官方檔案，咱們直接代碼擼起來，

一、快速開始

本文基于 springboot、maven、jdk1.8、mysql 開發，所以開始前我們需要準備好這套環境，

Spring Boot 基礎就不介紹了，推薦看這個免費教程：

https://github.com/javastacks/spring-boot-best-practice

新建如下資料庫：

建議大家選擇 utf8mb4 這種字符集，做過微信的同學應該會知道，微信用戶名稱的表情，是需要這種字符集才能存盤的，

我就默認其他環境已經準備好了，咱們直接從 mybatis-plus 開始，

1.1 依賴準備

想要什么依賴版本的去 maven 倉庫查看：

https://mvnrepository.com/

引入 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 關于多資料源的依賴：

<!-- mybatis-plus 多資料源 -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>dynamic-datasource-spring-boot-starter</artifactId>
    <version>3.5.0</version>
</dependency>

1.2 配置準備

Spring Boot 基礎就不介紹了，推薦看這個免費教程：

https://github.com/javastacks/spring-boot-best-practice

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 啟動服務

下面直接啟動服務：

得到如上結果表示啟動成功了，

二、使用

前面我們成功的集成進來了 mybatis-plus，配合 springboot 使用不要太方便，下面我們看看如何使用它來操作我們的資料庫，介紹一下常規的用法，

2.1 物體類注解

mybatis-plus 為使用者封裝了很多的注解，方便我們使用，我們首先看下物體類中有哪些注解，有如下的物體類：

@TableName(value = https://www.cnblogs.com/"user\")
public class UserDO {

    /**
     * 主鍵
     */
    @TableId(value = https://www.cnblogs.com/"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 很重要：

@TableFiled 表欄位標識

下面看看其主要常用屬性：

關于其他的屬性，我不太推薦使用，用得越多，越容易蒙圈，可以通過 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： 用戶服務介面
 * @author：weirx
 * @date：2022/1/17 15:02
 * @version：3.0
 */
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： 用戶介面實作
 * @author：weirx
 * @date：2022/1/17 15:03
 * @version：3.0
 */
public class UserServiceImpl extends ServiceImpl<UserMapper, UserDO> implements IUserService {

}

所以我們的

2.2.2 Mapper 層 CRUD

mybatis-plus 將常用的 CRUD 介面封裝成了BaseMapper介面,我們只需要在自己的 Mapper 中繼承它就可以了：

/**
 * @description： 用戶mapper
 * @author：weirx
 * @date：2022/1/17 14:55
 * @version：3.0
 */
@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： 性別列舉
 * @author：weirx
 * @date：2022/1/17 16:26
 * @version：3.0
 */
@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 = https://www.cnblogs.com/"user\")
public class UserDO {

    /**
     * 主鍵
     */
    @TableId(value = https://www.cnblogs.com/"id\", type = IdType.AUTO)
    private Long id;

    /**
     * 昵稱
     */
    @TableField(value = https://www.cnblogs.com/"nickname\",condition = SqlCondition.EQUAL)
    private String nickname;

    /**
     * 性別
     */
    @TableField(value = https://www.cnblogs.com/"sex\")
    private SexEnum sex;

    /**
     * 版本
     */
    @TableField(value = https://www.cnblogs.com/"version\",update = \"%s+1\")
    private Integer version;

    /**
     * 時間欄位，自動添加
     */
    @TableField(value = https://www.cnblogs.com/"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: 啟動自動填充功能

 * @return:
 * @author: weirx
 * @time: 2022/1/17 17:00
 */
@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 = https://www.cnblogs.com/"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
 * @author：weirx
 * @date：2022/1/17 17:39
 * @version：3.0
 */
@RestController
@RequestMapping(\"/user\")
public class UserController {

    @Autowired
    private IUserService userService;

    /**
     * description: 新增

     * @return: boolean
     * @author: weirx
     * @time: 2022/1/17 19:11
     */
    @RequestMapping(\"/save\")
    public boolean save() {
        UserDO userDO = new UserDO();
        userDO.setNickname(\"大漂亮\");
        userDO.setSex(SexEnum.MAN);

        return userService.save(userDO);
    }

    /**
     * description: 修改
     * @param nickname
     * @param id
     * @return: boolean
     * @author: weirx
     * @time: 2022/1/17 19:11
     */
    @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: 洗掉
     * @param id
     * @return: boolean
     * @author: weirx
     * @time: 2022/1/17 19:11
     */
    @RequestMapping(\"/delete\")
    public boolean delete(@RequestParam Long id) {
        UserDO userDO = new UserDO();
        userDO.setId(id);
        return userService.removeById(userDO);
    }

    /**
     * description: 串列
     * @return: java.util.List<com.wjbgn.user.entity.UserDO>
     * @author: weirx
     * @time: 2022/1/17 19:11
     */
    @RequestMapping(\"/list\")
    public List<UserDO> list() {
        return userService.list();
    }

    /**
     * description: 分頁串列
     * @param current
     * @param size
     * @return: com.baomidou.mybatisplus.extension.plugins.pagination.Page
     * @author: weirx
     * @time: 2022/1/17 19:11
     */
    @RequestMapping(\"/page\")
    public Page page(@RequestParam int current,@RequestParam int size) {
        return userService.page(new Page<>(current,size), new QueryWrapper(new UserDO()));
    }

}

記過上面的介面驗證，功能沒有問題，集成成功，上文基本覆寫了 mybatis-plus 常用的特性，有同學說自動代碼生成沒說？

近期熱文推薦：

1.1,000+ 道 Java面試題及答案整理(2022最新版)

2.勁爆！Java 協程要來了，，，

3.Spring Boot 2.x 教程，太全了！

4.別再寫滿屏的爆爆爆炸類了，試試裝飾器模式，這才是優雅的方式！！

5.《Java開發手冊（嵩山版）》最新發布，速速下載！

覺得不錯，別忘了隨手點贊+轉發哦！

標籤：Java

上一篇：Spring Retry 重試

下一篇：HashMap和HashSet的不同之處簡介說明