Mybatis-plus一談到底（簡介、快速入門、MyBatisPlus的CRUD 接口、MyBatisPlus條件構造器）

思維導圖原圖下載，也可以私聊給我留言，看到就會回覆

本人是一名物聯網工程專業的學生，寫博客即是爲了記錄自己的學習歷程，又希望能夠幫助到很多和自己一樣處於起步階段的萌新。
臨淵羨魚，不如退而結網。一起加油！
博客主頁:https://blog.csdn.net/qq_44895397

MyBatisPlus簡介

一、簡介

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

二、特性

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

MyBatisPlus入門

一、使用 Spring Initializr 快速初始化一個 Spring Boot 工程

二、添加依賴

mybatis-plus-boot-starter、MySQL依賴：

 <!--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>

三、配置

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

spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=yky

四、代碼編寫

1、mapper繼承BaseMapper接口

@Mapper
public interface StudentMapper extends BaseMapper<tStudent> {
}

2、實體類

注意數據庫表名和實體類名稱的關係：

3、啓動類

五、配置日誌

控制檯輸出sql語句：

核心配置文件配置

#mybatis日誌
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

六、測試

@SpringBootTest
public class Mybatisplusdemo01ApplicationTests {

    @Autowired
    private StudentMapper studentMapper;

    @Test
    void contextLoads() {
        List<tStudent> students = studentMapper.selectList(null);
        for (tStudent s : students) {
            System.out.println(s);
        }
    }
}

MyBatisPlus的CRUD 接口

一、insert

1、插入操作

直接調用BaseMapper接口中的方法即可

//插入操作
	@Test
	public  void  add(){
		tStudent student = new tStudent();
		student.setName("愛敲代碼的小遊子");
		student.setAge(19);
		studentMapper.insert(student);
	}

2、主鍵策略

（1）ID_WORKER

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

（2）自增策略

• 要想主鍵自增需要配置如下主鍵策略
  1. 需要在創建數據表的時候設置主鍵自增
  2. 實體字段中配置 @TableId(type = IdType.AUTO)

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

• 要想影響所有實體的配置，可以設置全局主鍵配置

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

• 其它主鍵策略:

二、update

1、根據Id更新操作

@Test
public void updateStudent() {
    tStudent student = new tStudent();
    student.setId(1009);
    student.setName("東方不敗");
    studentMapper.updateById(student);
}

2、自動填充

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

（2）實體上添加註解

//自動填充
@TableField(fill = FieldFill.INSERT)
private Date create_time;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date update_time;

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

注意：不要忘記添加 @Component 註解

@Component
public class MyMateObjectHandler implements MetaObjectHandler {

    @Override
    public void insertFill(MetaObject metaObject) {
        this.setFieldValByName("update_time",new Date(),metaObject);
        this.setFieldValByName("create_time",new Date(),metaObject);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        this.setFieldValByName("update_time",new Date(),metaObject);
    }
}

注意事項

• 字段必須聲明TableField註解,屬性fill選擇對應策略,該聲明告知Mybatis-Plus需要預留注入SQL字段
• 填充處理器MyMetaObjectHandler在 Spring Boot 中需要聲明@Component或@Bean注入
• 要想根據註解FieldFill.xxx和字段名以及字段類型來區分必須使用父類的strictInsertFill或者strictUpdateFill方法
• 不需要根據任何來區分可以使用父類的fillStrategy方法

3、樂觀鎖

主要解決：丟失更新，也就是說實現線程安全的數據更新

1、樂觀鎖實現方式：

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

2、配置步驟：

1. 插件配置
   

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

2. 在實體類中的version屬性添加@Version註解

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

3、特別說明

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

三、select

1、根據id查詢記錄

@Test
	void selecttStudentById() {
		tStudent students = studentMapper.selectById(1004);
		System.out.println(students);
	}

2、通過多個id批量查詢

@Test
void selecttStudentById() {
	List<tStudent> tStudents = studentMapper.selectBatchIds(Arrays.asList(1001, 1002, 1003));
	System.out.println(tStudents );
}

3、簡單的條件查詢

通過map封裝查詢條件

• 注意：map中的key對應的是數據庫中的列名。

@Test
public void testSelectByMap(){

    HashMap<String, Object> map = new HashMap<>();
    map.put("name", "愛敲代碼的小遊子");
    map.put("age", 19);
    List<User> users = userMapper.selectByMap(map);
    users.forEach(System.out::println);
}

4、分頁查詢

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

配置類中添加分頁插件

 @Bean
    public PaginationInterceptor paginationInterceptor() {
        PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
        // 設置請求的頁面大於最大頁後操作， true調回到首頁，false 繼續請求  默認false
        // paginationInterceptor.setOverflow(false);
        // 設置最大單頁限制數量，默認 500 條，-1 不受限制
        // paginationInterceptor.setLimit(500);
        // 開啓 count 的 join 優化,只針對部分 left join
        paginationInterceptor.setCountSqlParser(new JsqlParserCountOptimize(true));
        return paginationInterceptor;
    }

分頁插件的使用

1、創建page對象

//創建page對象
	//兩個參數：當前頁和每頁顯示記錄數
	Page<tStudent> studentPage = new Page<>(1,3);

2、通過調用分頁查詢的方法

@Test
public void pageHander(){
	//創建page對象
	//兩個參數：當前頁和每頁顯示記錄數
	Page<tStudent> studentPage = new Page<>(1,3);
	//調用分頁查詢方法
	//分頁查詢過程中，把分頁所有的數據封裝到page對象裏面
	studentMapper.selectPage(studentPage,null);
	studentPage.getCurrent();//當前頁
	studentPage.getRecords();//每頁數據的list集合
	studentPage.getSize();//每頁顯示記錄數
	studentPage.getTotal();//總記錄數
	studentPage.getPages();//總頁數
	System.out.println(studentPage.getPages());
	studentPage.hasNext();//判斷是否還有下一頁
	studentPage.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、邏輯刪除

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

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

（2）實體類屬性deleted 添加註解@TableLogic

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

（3）新增數據時自動填充deleted默認值

在數據庫中增加deleted字段時設置默認值後不需要再在這裏設置默認值

this.setFieldValByName("deleted",0,metaObject);

（4）application.properties 加入配置（可不配置）

##邏輯刪除配置
#mybatis-plus.global-config.db-config.logic-delete-value=1
#mybatis-plus.global-config.db-config.logic-not-delete-value=0

MyBatisPlus條件構造器

瞭解更多可以參考官方文檔：https://mp.baomidou.com/

創建QueryWrapper對象

QueryWrapper<tStudent> wrapper = new QueryWrapper<>();

1、ge、gt、le、lt、isNull、isNotNull

• ge：大於等於 >=
• gt：大於 >
• le：小於等於 <=
• lt：小於 <
• isNull：字段 IS NULL
• isNotNull：字段 IS NOT NULL
  

public void text(){
		QueryWrapper<tStudent> wrapper = new QueryWrapper<>();
		wrapper.ge("id",1004);
		wrapper.le("age",50);
		List<tStudent> tStudents = studentMapper.selectList(wrapper);
		System.out.println(tStudents);
	}

2、eq、ne

• eq：等於
• ne：不等於

eq("name", "老王")--->name = '老王'

3、between、notBetween

包含大小邊界

• BETWEEN 值1 AND 值2

between("age", 18, 30)--->age between 18 and 30

4、allEq

allEq(Map<R, V> params)
allEq(Map<R, V> params, boolean null2IsNull)
allEq(boolean condition, Map<R, V> params, boolean null2IsNull)

• 例1: allEq({id:1,name:"老王",age:null})—>id = 1 and name = '老王' and age is null
• 例2: allEq({id:1,name:"老王",age:null}, false)—> id = 1 and name = '老王'

5、last

無視優化規則直接拼接到 sql 的最後

注意事項:

• 只能調用一次,多次調用以最後一次爲準 有sql注入的風險,請謹慎使用

  //複雜條件查詢
    @Test
    public void select(){
        QueryWrapper<tStudent> wrapper = new QueryWrapper<>();

        wrapper.last("and name = ''");

        List<tStudent> tStudents = studentMapper.selectList(wrapper);

        System.out.println(tStudents);
    }