MyBatis-Plus快速入門

簡介

什麼是MyBatis-Plus?

MyBatis-Plus(以下簡稱MP),爲簡化開發而生。
MP是一個MyBatis的增強工具,在MyBatis的基礎上只做增強不做改變。
MyBatis-Plus官網首頁
MyBatis-Plus官方文檔簡介

MP的特性

  • 無侵入:只做增強不做改變,引入它不會對現有工程產生影響,如絲般順滑
  • 損耗小:啓動即會自動注入基本 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 操作智能分析阻斷,也可自定義攔截規則,預防誤操作

支持數據庫

  • mysql 、 mariadb 、 oracle 、 db2 、 h2 、 hsql 、 sqlite 、 postgresql 、 sqlserver
  • 達夢數據庫 、虛谷數據庫 、人大金倉數據庫

快速體驗

1、建立數據庫mybatis-plus,導入數據。

DROP TABLE IF EXISTS user;

CREATE TABLE user
(
	id BIGINT(20) NOT NULL COMMENT '主鍵ID',
	name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
	age INT(11) NULL DEFAULT NULL COMMENT '年齡',
	email VARCHAR(50) NULL DEFAULT NULL COMMENT '郵箱',
	PRIMARY KEY (id)
);

DELETE FROM user;

INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, '[email protected]'),
(2, 'Jack', 20, '[email protected]'),
(3, 'Tom', 28, '[email protected]'),
(4, 'Sandy', 21, '[email protected]'),
(5, 'Billie', 24, '[email protected]');

2、創建SpringBoot項目,導入對應的依賴。

<!--導入mp的依賴-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.0.5</version>
</dependency>

<!--
    Spring2.x默認配置mysql8的驅動
    <mysql.version>8.0.19></mysql.version>
    8.0以上的驅動需要配置時區
-->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>
</dependency>

3、編寫項目。

  • 配置數據庫連接。
# DataSource Config
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/mybatis-plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
    username: root
    password: 123456
  • 編寫實體類(這裏使用了lombok插件)。
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}
  • 編寫mapper接口繼承BaseMapper即可。至此所有基本的CRUD都已經完成了。
//使用了MP之後,我們就不用編寫CRUD了,只需要繼承一個接口即可
//BaseMapper<T>,泛型T就是表示你要操作的類
@Repository
public interface UserMapper extends BaseMapper<User> {

    //這裏幾乎內置了所有的查詢,除了十分特殊的查詢之外
    //MP,對於複雜的SQL依舊要自己編寫
}

4、在測試類中測試使用即可。

@SpringBootTest
class SpringbootMpApplicationTests {
    @Autowired
    private UserMapper userMapper;
    
    @Test
    void testMP(){
        //參數Wrapper是一個複雜的條件構造器
        //查詢所有的用戶
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
        //70%以上的業務都可以在這裏自動實現,拋開了底層dao層
        //這個時候你就可以專心的寫Controller了
    }
}

BaseMapper

所有的CRUD操作,BaseMapper都已經幫我們封裝好了,我們拿來即用就可以了。
BaseMapper中的所有接口方法如下:

    int insert(T var1);

    int deleteById(Serializable var1);

    int deleteByMap(@Param("cm") Map<String, Object> var1);

    int delete(@Param("ew") Wrapper<T> var1);

    int deleteBatchIds(@Param("coll") Collection<? extends Serializable> var1);

    int updateById(@Param("et") T var1);

    int update(@Param("et") T var1, @Param("ew") Wrapper<T> var2);

    T selectById(Serializable var1);

    List<T> selectBatchIds(@Param("coll") Collection<? extends Serializable> var1);

    List<T> selectByMap(@Param("cm") Map<String, Object> var1);

    T selectOne(@Param("ew") Wrapper<T> var1);

    Integer selectCount(@Param("ew") Wrapper<T> var1);

    List<T> selectList(@Param("ew") Wrapper<T> var1);

    List<Map<String, Object>> selectMaps(@Param("ew") Wrapper<T> var1);

    List<Object> selectObjs(@Param("ew") Wrapper<T> var1);

    IPage<T> selectPage(IPage<T> var1, @Param("ew") Wrapper<T> var2);

    IPage<Map<String, Object>> selectMapsPage(IPage<T> var1, @Param("ew") Wrapper<T> 

T就是我們要操作的數據對象。
另外我們還需要在配置文件中開啓日誌功能。

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

插入策略

往數據庫中插入一條記錄只需要直接調用mapper對象的insert方法進行插入即可。

@Test
void testInsert(){
    User user=new User();
    user.setName("coding");
    user.setAge(18);
    user.setEmail("[email protected]");
    //插入對象
    int insert=userMapper.insert(user);
    //id自動回填了,這個對象直接使用
    //這個id是什麼  1251036873686134785(雪花算法)
    System.out.println(user);
}

默認情況下,id會自動回填,查看控制檯會發現系統自動幫我們生成了一串隨機數字作爲id填入SQL參數中。
默認id自動回填

主鍵生成策略

MP中主鍵默認生成策略是雪花算法(snowflake)
snowflake是Twitter開源的分佈式ID生成算法,結果是一個long型的ID。其核心思想是:使用41bit作爲毫秒數,10bit作爲機器的ID(5個bit是數據中心,5個bit的機器ID),12bit作爲毫秒內的流水號(意味着每個節點在每毫秒可以產生4096個ID),最後還有一個符號位,永遠是0。
關於id生成策略的更多內容,可以參考這篇博客:https://www.cnblogs.com/haoxinyue/p/5208136.html
在MP中,主要有以下幾種主鍵生成策略,我們可以結合IdType這個枚舉類的代碼來分析:

  • 自增(需保證數據庫中的主鍵字段是自增的)
  • 手動輸入
  • uuid
  • 雪花算法
public enum IdType {
    AUTO(0),// 自增
    NONE(1),//不使用策略
    INPUT(2),// 手動輸入
    ID_WORKER(3),//唯一id生成器(默認)
    UUID(4),//uuid
    ID_WORKER_STR(5);//唯一id生成器(字符串類型)
}

更新策略

MP在更新對象時會自動幫我們匹配動態SQL。測試更新user表中的一條記錄。

 @Test
void testUpdate(){
    //MP在更新對象時自動幫我們匹配動態sql
    User user=new User();
    user.setId(1L);
    user.setAge(100);
    //更新一個用戶
    //updateById這裏面傳遞的是一個user對象
    userMapper.updateById(user);
}

自動填充策略(擴展)

在阿里巴巴代碼規範中,id、gmt_create、gmt_update是每張表中必備的三個字段。
阿里巴巴代碼規範
因此,我們給user表增加兩個字段:create_time和update_time,分別表示創建時間和修改時間,然後進行測試。這時我們發現這兩個字段默認值被填充爲NULL了。
自動更新策略分爲兩種級別:數據庫級別代碼級別。

數據庫級別(不建議使用)

1、設置create_time和update_time字段的默認值爲CURRENT_TIMESTAMP即可。
設置字段默認值
2、進行記錄更新測試,可以看到這條記錄更新後create_time和update_time的值被設置爲記錄更新的時間。
時間字段自動更新
datetime字段設置默認值會極大的降低數據庫的執行效率,因此不建議使用這種自動更新策略。

代碼級別(建議使用)

1、刪除create_time和update_time字段的默認值。
刪除字段默認值
2、編寫代碼。

  • 編寫實體類對應的註解。
//時間的操作(自動更新)
@TableField(fill = FieldFill.INSERT) //插入時更新
private Date createTime; 
@TableField(fill = FieldFill.INSERT_UPDATE) //插入或更新時更新
private Date updateTime;
  • 編寫元對象處理器。
//自定義元對象處理器
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
    //插入的策略
    @Override
    public void insertFill(MetaObject metaObject) {
        //設置當前字段的值
        //以後只要是插入操作就會自動控制createTime、updateTime使用new Date()進行自動填充
        this.setFieldValByName("createTime",new Date(),metaObject);
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }

    //更新策略
    @Override
    public void updateFill(MetaObject metaObject) {
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }
}

樂觀鎖

什麼是樂觀鎖?什麼又是悲觀鎖?

樂觀鎖:非常樂觀,無論什麼操作都不加鎖。樂觀鎖的通常實現方式是在表中增加一個樂觀鎖字段(version)即可。當要更新一條記錄時,希望這條記錄沒有被別人更新,一旦記錄搶先被別人更新,那麼當前更新就會失敗。
悲觀鎖:非常悲觀,無論什麼操作都加鎖。我們一旦加鎖,那它就一定是悲觀鎖。

樂觀鎖的實現方式

樂觀鎖的實現方式如下:

  • 取出記錄時,獲取當前version。
  • 更新時,在條件中會帶上這個version。
  • 執行更新時,set version=newVersion where version=oldVersion,其中oldVersion就是我們一開始獲取的version。
  • 如果version不對,就會更新失敗。
 //樂觀鎖失敗
 @Test
 void testOptimisticLocker2(){
     //線程一查詢原來的數據
     User user = userMapper.selectById(1L);
     //線程一修改當前數據
     user.setName("Jack2");
     //線程二搶先更新了
     User user2 = userMapper.selectById(1L);
     user2.setName("Jack3 ");
     userMapper.updateById(user2);
     //線程一執行修改
     userMapper.updateById(user);
 }

MP中如何配置樂觀鎖

1、在數據庫表中添加version字段,將@Version註解添加到字段上。

@Version
private Integer version;

2、添加樂觀鎖插件。

@Configuration
public class MPConfig {

    //樂觀鎖插件 本質是一個攔截器
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }
}

3、測試後發現更新SQL中自動帶上了版本號。

查詢策略

MP爲我們提供了單條記錄、多條記錄、指定數量、分頁等多種查詢方法,測試方法如下:

//查詢(使用的最多 ,單個,多個,指定數量,分頁查詢)
@Test
void  testSelectById(){
    User user=userMapper.selectById(1L);
    System.out.println(user);
}
@Test
void  testSelectByIds(){
    //批量查詢
    List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
    users.forEach(System.out::println);
}

@Test
void  testSelectByCount(){
    //查詢數據量
    Integer count= userMapper.selectCount(null);
    System.out.println(count);
}

@Test
void  testSelectByMap(){
    //簡單條件查詢
    Map<String,Object> map=new HashMap<>();
    map.put("name","wunian");
    map.put("age",3);
    List<User> users = userMapper.selectByMap(map);
    users.forEach(System.out::println);
}

分頁查詢

MP的分頁插件支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多種數據庫。
測試代碼如下:

//分頁查詢 limit(sql) MP內置了分頁插件,導入即可
@Test
void  testPage(){
    //1、先查詢總數
    //2、本質還是limit 0,10(默認的)
    //參數(當前頁,每個頁面的大小)
    Page<User> page=new Page<>(2,5);
    IPage<User> users = userMapper.selectPage(page, null);
    System.out.println(page.getTotal());//總數
    System.out.println(page.hasNext());//是否有下一頁
    System.out.println(page.hasPrevious());//是否有上一頁
    page.getRecords().forEach(System.out::println);//遍歷數據
    System.out.println(page.getSize());//獲取當前頁的記錄數
}

刪除策略

MP提供了刪除單條記錄和多條記錄的方法。測試代碼如下:

//刪除(單個,多個)
@Test
void testDeleteById(){
    userMapper.deleteById(1251036873686134785L);
}

@Test
void testDeleteByIds(){
    userMapper.deleteBatchIds(Arrays.asList(1251036873686134785L,1251045724569370626L));
}

//簡單的條件刪除
@Test
void testDeletMap(){
    Map<String,Object> map=new HashMap<>();
    map.put("name","wunian");
    map.put("age",3);
    userMapper.deleteByMap(map);
}

邏輯刪除

先來了解下邏輯刪除和物理刪除的概念:

  • 邏輯刪除:並不是真的從數據庫中刪除了,只是加了一個條件判斷而已。
  • 物理刪除:直接從數據庫中刪除了。

業務場景:管理員在後臺可以看到被刪除的記錄,使用邏輯刪除可以保證項目的安全性和健壯性。
使用方法:
1、在數據庫中添加邏輯刪除字段deleted
2、在實體類字段中添加邏輯刪除註解@TableLogic

@TableLogic //邏輯刪除字段
 private Integer deleted;

3、在配置類中添加處理邏輯刪除的插件。

//邏輯刪除插件
@Bean
public ISqlInjector sqlInjector() {
    return new LogicSqlInjector();
}

4、在配置文件中配置邏輯刪除。

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

5、只要配置了邏輯刪除,以後的查詢都會帶上邏輯刪除字段,這樣能夠保證程序效率和結果正常。
邏輯刪除SQL
6、查詢被刪除的數據,請單獨手寫SQL。

SELECT * FROM user WHERE deleted=1

性能分析

MP提供了性能分析插件,它能在開發中幫助我們排除慢SQL。
如果要使用性能分析插件,只需要在配置類中配置即可。

//SQL執行效率插件
@Bean
@Profile({"dev","test"})// 設置 dev test 環境開啓
public PerformanceInterceptor performanceInterceptor() {
    PerformanceInterceptor interceptor=new PerformanceInterceptor();
    //允許執行的sql的最長時間,默認的單位是毫秒
    //超過這個時間sql會報錯
    interceptor.setMaxTime(100);
    //格式化sql代碼
    interceptor.setFormat(true);
    return interceptor;
}

正常開發時可以在控制檯查看到SQL的執行效率。
查看SQL執行效率
如果SQL的執行時間,超過了我們設置的最長時間範圍,控制檯就會報錯。
慢SQL報錯
一般解決慢SQL的方法無非就是優化SQL語句,建立索引,分庫分表這些。

條件構造器

我們平時編寫SQL,一般使用的最多的就是一些查詢條件,MP爲我們提供了條件構造器來動態構造SQL語句。測試代碼如下:

@SpringBootTest
public class WrapperTest {

    @Autowired
    private UserMapper userMapper;

    //條件查詢器
    @Test
    void testWrapper(){
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        //鏈式編程,可以構造多個條件,會自動拼接SQL
        wrapper
                .isNotNull("name")
                .ge("age",28); //大於等於
                //.eq("age",100)
        userMapper.delete(wrapper);
    }

    //邊界查詢
    @Test
    void testWrapper2(){
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.between("age",20,28);
        userMapper.selectCount(wrapper);
    }

    //精準匹配
    @Test
    void testWrapper3(){
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        Map<String,Object> map=new HashMap<>();
        map.put("name","Jack");
        map.put("age",20);
        wrapper.allEq(map);
        userMapper.selectList(wrapper);
    }

    //模糊查詢
    @Test
    void testWrapper4(){
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.notLike("name","j")   //like '%j%'
                .likeRight("email","t"); // like 't%'
        userMapper.selectMaps(wrapper);
    }
    //子查詢(in)
    @Test
    void testWrapper5(){
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        //wrapper.in("id",1,2,3,4);
        //子查詢
        wrapper.inSql("id","select id from user where id<3");
        userMapper.selectObjs(wrapper);
    }

    // and or
    @Test
    void testWrapper6(){
        User user=new User();
        user.setAge(100);
        user.setName("Jack");
        UpdateWrapper<User> updateWrapper = new UpdateWrapper<>();
        //在一些新的框架中,鏈式編程,lambda表達式,函數式接口用的非常多
        updateWrapper
                .like("name","k")
                .or(i->i.eq("name","wunian").ne("age",0));
        userMapper.update(user,updateWrapper);
    }

    //排序
    @Test
    void testWrapper7(){
        QueryWrapper<User> wrapper=new QueryWrapper();
        wrapper.orderByAsc("id");
        userMapper.selectList(wrapper);
    }

    //多表查詢解決方案 last(不建議使用)
    //一般大公司會設計冗餘字段,很少用到多表查詢
    //如果要多表查詢,沒有簡便辦法,自己擴展即可
    @Test
    void testWrapper8(){
        QueryWrapper<User> wrapper=new QueryWrapper();
        wrapper.last("limit 1");
        userMapper.selectList(wrapper);
    }
}

注意:last方法只能調用一次,多次調用以最後一次爲準,並且有SQL注入的風險,請謹慎使用。

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