MyBatisPlus 的 CRUD 接口使用

一、引言

這篇文章來學習一下MybatisPlus的CRUD接口具體使用，其中還是有幾個比較重要的點，當然你也可以查看官網進行學習。

如何搭建一個MybatisPlus項目，可以參考前一篇文章：

MybatisPlus初使用：

https://blog.csdn.net/zxd1435513775/article/details/106432694

MybatisPlus官網：

http://mp.baomidou.com/guide/quick-start.html

MybatisPlus官方示列:

https://github.com/baomidou/mybatis-plus-samples/tree/master/mybatis-plus-sample-quickstart

二、插入主鍵生成策略

1、insert插入操作

向user表中添加一條數據。

@RunWith(SpringRunner.class)
@SpringBootTest
public class CRUDTests {
    @Autowired
    private UserMapper userMapper;
    @Test
    public void testInsert(){
        User user = new User();
        user.setName("kobe");
        user.setAge(42);
        user.setEmail("[email protected]");
        int result = userMapper.insert(user);
        System.out.println(result); // 影響的行數
        System.out.println(user); // id自動回填
    }
}

注意：數據庫插入id值默認爲：全局唯一id

2、主鍵策略

上面向數據庫中插入一條記錄時，並沒有指定主鍵id的值，但數據庫中該字段有值，這是由於MybatisPlus提供了主鍵生成策略，當我們在類的屬性上添加@TableId註解時，表明該字段爲主鍵，下面來看一下主鍵生成策略有哪些？
此處MybatisPlus版本爲3.0.5，在3.3.0版本中，主鍵生成策略已改變，可以參考官方文檔。

#註解@tableId
https://mp.baomidou.com/guide/annotation.html#tableid

@TableId(value = "id", type = IdType.ID_WORKER_STR)
private Long id;

（1）、ID_WORKER

MyBatis-Plus默認的主鍵策略是：ID_WORKER 全局唯一ID

（2）、自增策略
要想主鍵自增，需要在創建實體字段中配置 @TableId(type = IdType.AUTO)

@TableId(type = IdType.AUTO)
private Long id;

要想影響所有實體的配置，可以在application.properties中設置全局主鍵配置

#全局設置主鍵生成策略
mybatis-plus.global-config.db-config.id-type=auto

其它主鍵策略：分析 IdType 源碼可知：

@Getter
public enum IdType {
	//數據庫ID自增
    AUTO(0),
    //該類型爲未設置主鍵類型
    NONE(1),
    //用戶輸入ID
    //該類型可以通過自己註冊自動填充插件進行填充
    INPUT(2),
​
    /* 以下3種類型、只有當插入對象ID 爲空，才自動填充。 */
    // 全局唯一ID (idWorker)
    ID_WORKER(3),
    //全局唯一ID (UUID)
    UUID(4),
    // 字符串全局唯一ID (idWorker 的字符串表示)
    ID_WORKER_STR(5);
​
    private int key;
​
    IdType(int key) {
        this.key = key;
    }
}

三、update屬性自動填充

此部分，對應官方文檔如下：

https://mp.baomidou.com/guide/auto-fill-metainfo.html

1、自動填充

項目中經常會遇到一些數據，每次都使用相同的方式填充，例如記錄的創建時間，更新時間等。我們可以使用MyBatis Plus的自動填充功能，完成這些字段的自動賦值工作：

（1）、數據庫表中添加自動填充字段

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

（2）、實體上添加註解

@Data
public class User {
    ......
    // 插入時，自動填充
    @TableField(fill = FieldFill.INSERT)
    private Date createTime;
    
​	// 更新時，自動填充
    //@TableField(fill = FieldFill.UPDATE)
	
	// 插入和更新時，自動填充
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;
}

（3）、實現元對象處理器接口

使用屬性自動填充時，要自定義實現類 MyMetaObjectHandler
注意：不要忘記添加 @Component 註解

@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
​
    private static final Logger LOGGER = 
    	LoggerFactory.getLogger(MyMetaObjectHandler.class);
​
	// 屬性字段插入時，會執行此方法
    @Override
    public void insertFill(MetaObject metaObject) {
        LOGGER.info("start insert fill ....");
        this.setFieldValByName("createTime", new Date(), metaObject);
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }
​
	// 屬性字段更新時，會執行此方法
    @Override
    public void updateFill(MetaObject metaObject) {
        LOGGER.info("start update fill ....");
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }
}

四、select查詢及分頁

1、根據id查詢記錄

@Test
public void testSelectById(){
    User user = userMapper.selectById(1L);
    System.out.println(user);
}

2、通過多個id批量查詢

完成了動態sql的foreach的功能

@Test
public void testSelectBatchIds(){
    List<User> users = 
    	userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
    users.forEach(System.out::println);
}

3、簡單的條件查詢

通過map封裝查詢條件

@Test
public void testSelectByMap(){
​
    HashMap<String, Object> map = new HashMap<>();
    map.put("name", "Helen");
    map.put("age", 18);
    List<User> users = userMapper.selectByMap(map);
    users.forEach(System.out::println);
}

注意：map中的key對應的是數據庫中的列名。例如數據庫user_id，實體類是userId，這時map的key需要填寫user_id

4、分頁

#官方介紹
https://mp.baomidou.com/guide/page.html

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

（1）、創建配置類

// 分頁插件
@Bean
public PaginationInterceptor paginationInterceptor() {
    return new PaginationInterceptor();
}

（2）、測試selectPage分頁

測試：最終通過page對象獲取相關數據

@Test
public void testSelectPage() {
​
    Page<User> page = new Page<>(1,5);
    userMapper.selectPage(page, null);
​
    page.getRecords().forEach(System.out::println);
    System.out.println(page.getCurrent());
    System.out.println(page.getPages());
    System.out.println(page.getSize());
    System.out.println(page.getTotal());
    System.out.println(page.hasNext());
    System.out.println(page.hasPrevious());
}

控制檯sql語句打印：

SELECT id,name,age,email,create_time,update_time FROM user LIMIT 0,5

（3）、測試selectMapsPage分頁：結果集是Map

@Test
public void testSelectMapsPage() {
​
    Page<User> page = new Page<>(1, 5);
​
    IPage<Map<String, Object>> mapIPage = 
    		userMapper.selectMapsPage(page, null);
​
    //注意：此行必須使用 mapIPage 獲取記錄列表，否則會有數據類型轉換錯誤
    mapIPage.getRecords().forEach(System.out::println);
    System.out.println(page.getCurrent());
    System.out.println(page.getPages());
    System.out.println(page.getSize());
    System.out.println(page.getTotal());
    System.out.println(page.hasNext());
    System.out.println(page.hasPrevious());
}

五、delete

1、根據id刪除記錄

@Test
public void testDeleteById(){
    int result = userMapper.deleteById(8L);
    System.out.println(result);
}

2、批量刪除

@Test
public void testDeleteBatchIds() {
    int result =
    	 userMapper.deleteBatchIds(Arrays.asList(8, 9, 10));
    System.out.println(result);
}

3、簡單的條件查詢刪除

@Test
public void testDeleteByMap() {
​
    HashMap<String, Object> map = new HashMap<>();
    map.put("name", "Helen");
    map.put("age", 18);
​
    int result = userMapper.deleteByMap(map);
    System.out.println(result);
}

4、邏輯刪除

#官方文檔介紹
https://mp.baomidou.com/guide/annotation.html#tablelogic

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

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

（1）、數據庫中添加 deleted字段

ALTER TABLE `user` ADD COLUMN `deleted` boolean

（2）、實體類添加 deleted 字段

並加上 @TableLogic 註解 和 @TableField(fill = FieldFill.INSERT) 註解

@TableLogic
@TableField(fill = FieldFill.INSERT)
private Integer deleted;

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

@Override
public void insertFill(MetaObject metaObject) {
    ......
    this.setFieldValByName("deleted", 0, metaObject);
}

（4）application.properties 加入配置

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

mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0

（5）在 MybatisPlusConfig 中註冊 Bean

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

注意：被刪除數據的deleted 字段的值必須是 0，才能被選取出來執行邏輯刪除的操作，MyBatis Plus中查詢操作也會自動添加邏輯刪除字段的判斷

六、性能分析

#官方文檔介紹
https://mp.baomidou.com/guide/performance-analysis-plugin.html

性能分析攔截器，用於輸出每條 SQL 語句及其執行時間，SQL 性能執行分析，在開發環境使用，超過指定時間，停止運行，有助於發現問題。

1、配置插件

（1）、參數說明
參數：maxTime： SQL 執行最大時長，超過自動停止運行，有助於發現問題。
參數：format： SQL是否格式化，默認false。
（2）、在 MybatisPlusConfig 中配置

@Bean
@Profile({"dev","test"})// 設置 dev test 環境開啓
public PerformanceInterceptor performanceInterceptor() {
    PerformanceInterceptor performanceInterceptor = 
    	new PerformanceInterceptor();
    // ms，超過此處設置的ms則sql不執行
    performanceInterceptor.setMaxTime(100);
    performanceInterceptor.setFormat(true);
    return performanceInterceptor;
}

（3）、Spring Boot 中設置dev環境

#環境設置：dev、test、prod
spring.profiles.active=dev

可以針對各環境新建不同的配置文件
application-dev.properties、
application-test.properties、
application-prod.properties

七、小結

如果想進行復雜條件查詢，那麼需要使用條件構造器 Wapper，涉及到如下方法

delete、selectOne、selectCount、
selectList、selectMaps、selectObjs、update

參考下一篇吧。