Spring Boot 實戰（11）整合MyBatis-Plus

寫在前面： 我是「揚帆向海」，這個暱稱來源於我的名字以及女朋友的名字。我熱愛技術、熱愛開源、熱愛編程。技術是開源的、知識是共享的。

這博客是對自己學習的一點點總結及記錄，如果您對 Java、算法 感興趣，可以關注我的動態，我們一起學習。

用知識改變命運，讓我們的家人過上更好的生活。

相關文章：

Springboot 系列文章

---

一、Mybatis-Plus 介紹

1. 什麼是 Mybatis-Plus

MyBatis-Plus（簡稱 MP）是一個 MyBatis 的增強工具，在 MyBatis
的基礎上只做增強不做改變，爲簡化開發、提高效率而生。

2. 特性

• 無侵入：只做增強不做改變，引入它不會對現有工程產生影響，如絲般順滑
• 損耗小：啓動即會自動注入基本 CURD，性能基本無損耗，直接面向對象操作
• 強大的 CRUD 操作：內置通用 Mapper、通用 Service，僅僅通過少量配置即可實現單表大部分 CRUD 操作，更有強大的條件構造器，滿足各類使用需求
• 支持 Lambda 形式調用：通過 Lambda 表達式，方便的編寫各類查詢條件，無需再擔心字段寫錯
• 支持主鍵自動生成：支持多達 4 種主鍵策略（內含分佈式唯一 ID 生成器 - Sequence），可自由配置，完美解決主鍵問題
• 支持 ActiveRecord 模式：支持 ActiveRecord 形式調用，實體類只需繼承 Model 類即可進行強大的 CRUD 操作
• 支持自定義全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）
  內置代碼生成器：採用代碼或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 層代碼，支持模板引擎，更有超多自定義配置等您來使用
• 內置分頁插件：基於 MyBatis 物理分頁，開發者無需關心具體操作，配置好插件之後，寫分頁等同於普通 List 查詢
  分頁插件支持多種數據庫：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多種數據庫
• 內置性能分析插件：可輸出 Sql 語句以及其執行時間，建議開發測試時啓用該功能，能快速揪出慢查詢
• 內置全局攔截插件：提供全表 delete 、 update 操作智能分析阻斷，也可自定義攔截規則，預防誤操作

二、設計建表結構

現有一張 user 表，其表結構如下：

CREATE TABLE `user` (
  `id` bigint(20) NOT NULL COMMENT '主鍵ID',
  `NAME` varchar(30) DEFAULT NULL COMMENT '姓名',
  `age` int(11) DEFAULT NULL COMMENT '年齡',
  `email` varchar(50) DEFAULT NULL COMMENT '郵箱',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

三、搭建工程

工程目錄結構

1. 使用 Spring Initializer 初始化一個 Spring Boot 工程

需要引入項目所需要的依賴

pom.xml

	<properties>
        <java.version>1.8</java.version>
    </properties>

    <!-- 引入 Spring Boot Starter 父工程 -->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.2.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <dependencies>

        <!-- 引入 spring-boot-starter -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <!-- spring-boot-starter-test -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <!-- 引入mybatis-plus -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.0.5</version>
        </dependency>

        <!-- 引入mysql驅動 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

        <!-- 引入lombok用來簡化實體類 -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

2. 在 application.properties配置文件中添加 數據庫的相關配置

# 數據庫配置
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/數據庫名?serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=root

# mybatis日誌（控制檯顯示sql語句）
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

3. 配置 MapperScan 註解

在 Spring Boot 啓動類中添加 @MapperScan 註解

註解的作用是：掃描 Mapper 文件夾

@SpringBootApplication
@MapperScan("com.zxy.mpdemo.mapper")
public class MainApplication {

    public static void main(String[] args) {
        SpringApplication.run(MainApplication.class, args);
    }

}

四、Mybatis-Plus入門

1. 編寫實體類

注意： 在此處使用了 Lombok 簡化代碼，不需要寫Getter和Setter 方法。需要在Class 上面加 @Data這個註解

User.java

@Data
public class User {

    private Long id;       // 用戶id
    private String name;   // 用戶名
    private Integer age;   // 用戶年齡
    private String email;  // 用戶郵箱
}

2. 編寫Mapper類

UserMapper.java

@Repository
public interface UserMapper extends BaseMapper<User> {

}

注意：

Mapper 需要繼承 BaseMapper 接口，繼承該接口後，無需編寫 mapper.xml 文件，即可獲得CRUD功能。

說明:

通用 CRUD 封裝BaseMapper接口，爲 Mybatis-Plus 啓動時自動解析實體表關係映射轉換爲 Mybatis 內部對象注入容器

泛型 T 爲任意實體對象

3. 添加測試類，進行功能測試

@SpringBootTest
public class DemoTest {

    @Autowired
    private UserMapper userMapper;

    /**
     * 查詢所有的用戶
     */
    @Test
    public void testGetAllUser() {

        List<User> users = userMapper.selectList(null);
        for (int i = 0; i < users.size(); i++) {
            System.out.println(users.get(i));
        }
    }
}

控制檯輸出結果：

User(id=1, name=parker, age=18, email=[e-mail])
User(id=2, name=manu, age=16, email=[e-mail])
User(id=3, name=揚帆向海, age=19, email=[e-mail])

五、分頁

MyBatis Plus自帶分頁插件，只要簡單的配置即可實現分頁功能

1. 創建配置類

@EnableTransactionManagement
@Configuration
@MapperScan("com.baomidou.cloud.service.*.mapper*")
public class MybatisPlusConfig {

    @Bean
    public PaginationInterceptor paginationInterceptor() {
        PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
        // 設置請求的頁面大於最大頁後操作， true調回到首頁，false 繼續請求  默認false
        // paginationInterceptor.setOverflow(false);
        // 設置最大單頁限制數量，默認 500 條，-1 不受限制
        // paginationInterceptor.setLimit(500);
        return paginationInterceptor;
    }
}

2. 測試分頁功能

	/**
     * mp實現分頁
     */
    @Test
    public void testPage() {

        // 創建page對象，傳遞兩個參數：當前頁和每頁記錄數
        Page<User> page = new Page<>(1, 3);
        // 分頁查詢
        userMapper.selectPage(page, null);
        // 通過page對象獲取分頁數據
        List<User> records = page.getRecords(); // 每頁數據
        long current = page.getCurrent(); // 當前頁
        long pages = page.getPages();// 總頁數
        long total = page.getTotal();// 總記錄數
        long size = page.getSize();// 每頁記錄數
        boolean previous = page.hasPrevious();// 是否有上一頁
        boolean next = page.hasNext();// 是否有下一頁

        System.out.println(records);
        System.out.println(current);
        System.out.println(pages);
        System.out.println(total);
        System.out.println(size);
        System.out.println(previous);
        System.out.println(next);
    }

六、自動填充功能

項目中經常會遇到一些數據，每次都使用相同的方式填充，例如記錄的創建時間，更新時間等。

我們可以使用MyBatis Plus的自動填充功能，完成這些字段的賦值工作：

1. 數據庫表中添加自動填充字段

在User表中添加datetime類型的新的字段 create_time、update_time

2. 實體上添加註解

@Data
public class User {

	// 爲了節約篇幅，在此刪除了其他屬性字段
	
    @TableField(fill = FieldFill.INSERT)
    private Date createTime; // 創建時間
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime; // 修改時間
}

3. 實現元對象處理器接口

@Component
public class MyMetaObjectHandler implements MetaObjectHandler {

    /**
     * 在mp執行添加操作的時候運行(會將createTime和updateTime加入到數據庫中）
     *
     * @param metaObject
     */
    @Override
    public void insertFill(MetaObject metaObject) {

        this.setFieldValByName("createTime", new Date(), metaObject);
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }

    /**
     * 在mp執行修改操作的時候運行
     *
     * @param metaObject
     */
    @Override
    public void updateFill(MetaObject metaObject) {

        this.setFieldValByName("updateTime", new Date(), metaObject);
    }
}

七、邏輯刪除

• 物理刪除：真實刪除，將對應數據從數據庫中刪除，之後查詢不到此條被刪除數據

• 邏輯刪除：假刪除，將對應數據中代表是否被刪除字段狀態修改爲“被刪除狀態”，之後在數據庫中仍舊能看到此條數據記錄

1.數據庫中添加 deleted字段

ALTER TABLE `user` ADD COLUMN `deleted` boolean

2. 實體類添加deleted 字段

注意：需要加上 @TableLogic 註解 和 @TableField(fill = FieldFill.INSERT) 註解

@TableField(fill = FieldFill.INSERT)
@TableLogic // 用於邏輯刪除的註解
private Integer deleted; // 邏輯刪除標記

3. 元對象處理器接口添加deleted的insert默認值

@Component
public class MyMetaObjectHandler implements MetaObjectHandler {

    @Override
    public void insertFill(MetaObject metaObject) {
        // 添加邏輯刪除的默認值
        this.setFieldValByName("deleted", 0, metaObject);
    }

4. application.properties 加入配置

此爲默認值，如果你的默認值和mp默認的一樣,該配置可無

# 0表示沒刪除，1表示刪除
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0

5. 在 MybatisPlusConfig 中註冊 Bean

@EnableTransactionManagement // 事務
@Configuration // 標明是一個配置類
@MapperScan("com.zxy.mpdemo.mapper")
public class MybatisPlusConfig {
    /**
     * 邏輯刪除
     *
     * @return
     */
    @Bean
    public ISqlInjector sqlInjector() {
        return new LogicSqlInjector();
    }
}

八、樂觀鎖

意圖：

當要更新一條記錄的時候，希望這條記錄沒有被別人更新

樂觀鎖實現方式：

取出記錄時，獲取當前version
更新時，帶上這個version
執行更新時， set version = newVersion where version = oldVersion
如果version不對，就更新失敗

1. 數據庫中添加version字段

ALTER TABLE `user` ADD COLUMN `version` INT

2. 實體類添加version字段

添加 @Version 註解

@TableField(fill = FieldFill.INSERT) 
@Version
private Integer version; // 樂觀鎖版本號

3. 元對象處理器接口添加version的insert默認值

@Override
    public void insertFill(MetaObject metaObject) {

        // 添加樂觀鎖的默認版本是1
        this.setFieldValByName("version", 1, metaObject);
    }

注意：

• 支持的數據類型只有 int,Integer,long,Long,Date,Timestamp,LocalDateTime
• 整數類型下 newVersion = oldVersion + 1
• newVersion 會回寫到 entity 中
• 僅支持 updateById(id) 與 update(entity, wrapper) 方法
• 在 update(entity, wrapper) 方法下, wrapper 不能複用!!!

4. 在 MybatisPlusConfig 中註冊 Bean

	/**
     * 樂觀鎖插件
     *
     * @return
     */
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }

---

由於水平有限，本博客難免有不足，懇請各位大佬不吝賜教！