Springboot集成Mybatis-plus入門

Mybatis-plus 對 MyBatis 做了封裝,使得我們可以更加方便的進行操作,本文主要講述了 Spring boot 中 如何快速使用 MyBatis-plus 實現簡單crud、id生成策略配置、邏輯刪除、自動填充數據、數據庫樂觀鎖等常用功能。

一、項目搭建

  • 創建 Springboot 項目,此處使用 Springboot 2.0.4;
  • 導入 maven 依賴
	<dependency>
       <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</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>
    <!-- mybatis-plus -->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.0.5</version>
    </dependency>
  • 配置 yml
server:
  port: 15536
  
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/spring-tx-learning?useSSL=false
    driver-class-name: com.mysql.jdbc.Driver
    username: xxxxx
    password: xxxxx

# mybatis-plus 打印sql的日誌秩序配置這句就可以了,
# 在 mybatis-plus 中配置mybatis的debug日誌(logging.level.******:debug)已經不生效了
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

二、創建表

DROP TABLE IF EXISTS `mp_test`;
CREATE TABLE `mp_test` (
  `id` bigint(20) NOT NULL,
  `name` varchar(255) COLLATE utf8mb4_general_ci NOT NULL,
  `create_time` datetime ,
  `update_time` datetime,
  `deleted` tinyint ,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci;

三、創建實體類

@Data
public class MpTest {

    private Long id;

    private String name;

    private Date createTime;

    private Date updateTime;

    private Integer deleted;

}

四、創建mapper

  • Mybatis-plus 對MyBatis 做了封裝,通過集成 BaseMapp<?> 來進行基本的 CRUD 操作。
public interface MpTestMapper extends BaseMapper<MpTest> {
}

  • 添加 mapperSacn, 指定需要掃描的 mapper 所在包
@MapperScan("com.fly.mp.mapper")

二、常用使用

  • ID生成策略配置
    Mybatis-plus 可以通過註解驅動的方式來進行配置主鍵的生成策略,通過在實體類的相應字段添加 @TableId() 的方式自動生成ID。
@TableId(type = IdType.ID_WORKER) // 雪花算法,數字類型,默認
private Long id;

其中,IdType 共有如下幾種枚舉類型:

	AUTO(0), // 自動
    NONE(1),// 無
    INPUT(2),// 自己設置的值
    ID_WORKER(3), // 雪花算法,數字類型
    UUID(4), // uuid字符串
    ID_WORKER_STR(5); // 雪花算法,字符串類型

編寫測試:

	@Autowired
    private MpTestMapper mpTestMapper;

    @Test
    public void testInsert() {
        MpTest mpTest = new MpTest();
        mpTest.setName("lisa");
        int rows = mpTestMapper.insert(mpTest);
        System.out.println("影響行數: " + rows);
    }

運行測試得到如下結果:
運行結果
可以看到打印出了執行的sql語句,插入了一行記錄。我們在數據庫中看下結果如下:
在這裏插入圖片描述

  • 自動填充字段配置
    我們通常在業務中,總需要創建時間和更新時間,每次總是在setting方法中去填這個值,比較麻煩,Mybatis-plus 中通過配置攔截器很方便地爲我們實現了這個功能,使得我們不需要在業務代碼中每次手動書寫。

實體類中配置:

	@TableField(fill = FieldFill.INSERT) // 創建記錄的時候需要填充
    private Date createTime; 

    @TableField(fill = FieldFill.INSERT_UPDATE) // 創建和修改的時候都需要填充
    private Date updateTime;

配置攔截器

@Component
public class MPMetaObjectHandler implements MetaObjectHandler {
    
    // 插入的時候自動填充
    @Override
    public void insertFill(MetaObject metaObject) {
        Date date = new Date();
        setFieldValByName("createTime", date, metaObject);
        setFieldValByName("updateTime", date, metaObject);
    }

    // 更新的時候自動填充
    @Override
    public void updateFill(MetaObject metaObject) {
        Date date = new Date();
        setFieldValByName("updateTime", date, metaObject);
    }
}

運行測試得到如下結果:
在這裏插入圖片描述
數據庫中的結果:
在這裏插入圖片描述
可以看到,相比前面的測試,這次爲我們自動填充了 create_time 和 update_time 字段。

我們做一次更新測試,測試代碼如下:

	@Test
    public void testUpdate() {
        MpTest mpTest = new MpTest();
        mpTest.setId(1246358037395869697L);
        mpTest.setName("linda222");
        int rows = mpTestMapper.updateById(mpTest);
        System.out.println("影響行數: " + rows);
    }

更新結果如下:
在這裏插入圖片描述
可以看到在更新是自動爲我們更新了update_time 字段爲當前時間。

  • 邏輯刪除
    很多場景下,我們數據庫中的數據不允許直接物理刪除,而是通過某個標記來表示其已經爲刪除狀態,在正常業務流程中這些被標記爲刪除狀態的數據對用戶是不可見的,這種情況稱爲邏輯刪除。MyBatis-plus 也爲我們提供了這種功能,我們不必每次在代碼中去手動設置,而是通過設置就可以。

實體類中加入註解:

	@TableLogic // 標記這個字段是邏輯刪除字段
    @TableField(fill = FieldFill.INSERT) // 插入記錄的時候便初始化該字段
    private Integer deleted;

攔截器中初始化邏輯刪除字段的值:

@Component
public class MPMetaObjectHandler implements MetaObjectHandler {

    // 插入的時候自動填充
    @Override
    public void insertFill(MetaObject metaObject) {
        Date date = new Date();
        setFieldValByName("createTime", date, metaObject);
        setFieldValByName("updateTime", date, metaObject);

        // 初始化邏輯刪除字段爲0
        setFieldValByName("deleted", 0, metaObject);
    }
}

配置邏輯刪除的bean:

	@Bean
    public ISqlInjector sqlInjector() {
        return new LogicSqlInjector();
    }

插入數據結果,我們可以看到,deleted字段已經被初始化爲0,
在這裏插入圖片描述
我們調用 delete 方法:

	@Test
    public void testUpdate() {
        int rows = mpTestMapper.deleteById(1246362537481412610L);
        System.out.println("影響行數: " + rows);
    }

運行結果:
在這裏插入圖片描述
我們看到其實執行的是update 操作,將邏輯刪除字段deleted 修改成了1:
在這裏插入圖片描述
我們再執行查詢操作:

	@Test
    public void testSelect() {
        List<MpTest> mpTest1 = mpTestMapper.selectList(null);
    }

執行結果:
在這裏插入圖片描述
可以發現,在where條件中已經自動加上了deleted=0, 被邏輯刪除的記錄已經無法查到了。

  • 樂觀鎖配置

實體類配置:

	@Version // 標記這個字段爲樂觀鎖
    @TableField(fill = FieldFill.INSERT) // 插入記錄是初始化樂觀鎖的值
    private Integer version;

表中加入 version 字段.

初始化樂觀鎖的值:

@Component
public class MPMetaObjectHandler implements MetaObjectHandler {

    // 插入的時候自動填充
    @Override
    public void insertFill(MetaObject metaObject) {
        Date date = new Date();
        setFieldValByName("createTime", date, metaObject);
        setFieldValByName("updateTime", date, metaObject);

        // 初始化邏輯刪除字段爲0
        setFieldValByName("deleted", 0, metaObject);
        
        // 初始化樂觀鎖字段值爲1
        setFieldValByName("version", 1, metaObject);
    }
}

配置邏輯刪除插件:

    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }

執行插入邏輯結果如下:
在這裏插入圖片描述
在這裏插入圖片描述
可以看到自動初始化 version 字段爲1, 再執行更新邏輯:

	@Test
    public void testOptimisticLock() {
        // 樂觀鎖的更新一般是需要將原來的數據查出來,再去更新
        MpTest mpTest = mpTestMapper.selectById(1246368556806774786L);
        mpTest.setName("lalalalasdfafssadf");
        int update = mpTestMapper.update(mpTest, null);
        System.out.println("影響行數:" + update);
    }

執行結果:
在這裏插入圖片描述
在這裏插入圖片描述
我們發現,version 字段已經被加 1,通過這樣的方式我們即實現了樂觀鎖。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章