MybatisPlus

本文轉載自查看原文 2021-12-18 18:44 229 MybatisPlus

為什么要學習MybatisPlus？
可以節省編寫大量CRUD時間

簡介

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

特性

無侵入：只做增強不做改變，引入它不會對現有工程產生影響，如絲般順滑
損耗小：啟動即會自動注入基本 CURD，性能基本無損耗，直接面向對象操作
強大的 CRUD 操作：內置通用 Mapper、通用 Service，僅僅通過少量配置即可實現單表大部分 CRUD 操作，更有強大的條件構造器，滿足各類使用需求，以后簡單的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 操作智能分析阻斷，也可自定義攔截規則，預防誤操作

快速開始

https://baomidou.com/pages/226c21/#%E5%88%9D%E5%A7%8B%E5%8C%96%E5%B7%A5%E7%A8%8B
步驟：

創建數據庫 mybatis_plus

真實開發中：version（樂觀鎖），deleted（邏輯刪除），gmt_create（創建時間），gmt_modified（修改時間）
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)
);
INSERT INTO USER (id, NAME, age, email) VALUES
(1, 'Jone', 18, 'test1@baomidou.com'),
(2, 'Jack', 20, 'test2@baomidou.com'),
(3, 'Tom', 28, 'test3@baomidou.com'),
(4, 'Sandy', 21, 'test4@baomidou.com'),
(5, 'Billie', 24, 'test5@baomidou.com');

新建初始化SpringBoot項目
導入依賴

<!--數據庫驅動-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <!--mybatis-plus是自己開發的-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.0.5</version>
        </dependency>

使用mybatis-plus可以節省我們大量的代碼，盡量不要同時導入mybatis與mybatis-plus，會有版本沖突問題

連接數據庫
配置文件

#mysql 5
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=UTF-8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

傳統mybatis與mybaits-plus比較

pojo-mapper-使用
pojo-dao（連接mybatis，配置mapper.xml）-service-controller

pojo

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private int id;
    private String name;
    private int age;
    private String email;
}

mapper

import com.baomidou.mybatisplus.core.conditions.Wrapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.ji.pojo.User;
import org.springframework.stereotype.Repository;

import java.io.Serializable;
import java.util.Collection;
import java.util.List;
import java.util.Map;

//在對應的Mapper上面繼承基本的類baseMapper即可
@Repository
public interface UserMapper extends BaseMapper<User> {
   //所有的CRUD操作已經編寫完成
    //不需要像以前一樣配置一大堆文件了
}

主啟動類

需要在主啟動類上掃描我們mapper包下的所有接口

@SpringBootApplication
@MapperScan("com.ji.mapper")//掃面mapper文件夾，類似於mybatis.mapper-locations=classpath:mybatis/mapper/*.xml
public class MybatisPlusApplication {

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

}

測試類使用

@SpringBootTest
class MybatisPlusApplicationTests {

    //繼承了BaseMapper，所有的方法都來自父類
    //我們也可以編寫自己的擴展方法
    @Autowired
    private UserMapper userMapper;
    @Test
    void contextLoads() {
        List<User> users = userMapper.selectList(null);
        for (User user : users) {
            System.out.println(user);
        }
    }

}

測試結果

思考問題？

Sql是誰幫我們寫的？ mybatis-plus
方法從哪里來的？ mybatis-plus

配置日志

我們現在所有的sql是不可見的，如果想要知道是如何運行的以便於開發時的調試，就需要配置日志（上線時去掉即可）

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

配置后就可以看到這個自動生成的SQL

CRUD擴展

insert

 @Test
    void contextInsert() {
        User user = new User();
        user.setName("xxx");
        user.setAge(7);
        user.setEmail("351as6541d65as1d3");

        int x = userMapper.insert(user);  //自動生成id
        System.out.println(x);  //受影響的行數
        System.out.println(user);  //發現，id會自動回填
    }

數據庫插入的id默認值為全局唯一id

private Long id; //對應數據庫中的主鍵（uuid，自增id，雪花算法，zookeeper生成，redis生成）

主鍵生成策略

數據庫自增長序列或字段
UUID
UUID的變種
Redis生成ID
Twitter的snowflake算法
利用zookeeper生成唯一ID
TiDB的主鍵

Twitter的snowflake算法：snowflake是Twitter開源的分布式ID生成算法，結果是一個long型的ID。其核心思想是：使用41bit作為毫秒數，10bit作為機器的ID（5個bit是數據中心，5個bit的機器ID），12bit作為毫秒內的流水號（意味着每個節點在每毫秒可以產生 4096 個 ID），最后還有一個符號位，永遠是0。具體實現的代碼可以參看https://github.com/twitter/snowflake。雪花算法支持的TPS可以達到419萬左右（2^22*1000）。雪花算法在工程實現上有單機版本和分布式版本。
分布式版本可以參看美團leaf算法：https://github.com/Meituan-Dianping/Leaf
snowflake算法可以根據自身項目的需要進行一定的修改。比如估算未來的數據中心個數，每個數據中心的機器數以及統一毫秒可以能的並發數來調整在算法中所需要的bit數。
優點：
1）不依賴於數據庫，靈活方便，且性能優於數據庫。
2）ID按照時間在單機上是遞增的。
缺點：
1）在單機上是遞增的，但是由於涉及到分布式環境，每台機器上的時鍾不可能完全同步，在算法上要解決時間回撥的問題。

@TableId來配置主鍵生成策略

默認ID_WORKER 全局唯一id

主鍵自增（數據庫id也必須是自增的）
@TableId(type = IdType.AUTO)

    /**
     * 數據庫ID自增
     */
    AUTO(0),
    /**
     * 該類型為未設置主鍵類型
     */
    NONE(1),
    /**
     * 用戶輸入ID（如果不輸入就會為null）
     * 該類型可以通過自己注冊自動填充插件進行填充
     */
    INPUT(2),

    /* 以下3種類型、只有當插入對象ID 為空，才自動填充。 */
    /**
     * 全局唯一ID (idWorker)
     */
    ID_WORKER(3),
    /**
     * 全局唯一ID (UUID)
     */
    UUID(4),
    /**
     * 字符串全局唯一ID (idWorker 的字符串表示)
     */
    ID_WORKER_STR(5);

update

 @Test
    public void contextUpdate() {
        User user = new User();
        //根據條件自動拼接動態sql
        user.setId((long) 7);
        user.setName("mupdate");
        user.setAge(77);
        user.setEmail("351111");

        int x = userMapper.updateById(user);
        System.out.println(x);

    }

自動填充

創建時間，修改時間這些操作一般都是自動化完成的，不需要手動更新
gmt_create,gmt_modified幾乎所有的表都要配置，而且需要自動化

方式一：數據庫級別(不建議使用)

在表中新增字段create_time,update_time
實體類中增加相應字段
再次更新時查看即可

方式二：代碼級別

刪除數據庫的默認值，更新操作
實體類字段屬性上增加注解
編寫處理器處理注解即可

@Slf4j
@Component   //一定要把處理器加到ioc容器中
public class MyMetaObjectHandler implements MetaObjectHandler {

    //插入時填充策略
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("start insert fill ....");
        this.setFieldValByName("createTime",new Date(),metaObject);
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }
    //更新時填充策略
    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("start update fill ....");
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }
}

樂觀鎖

樂觀鎖：十分樂觀，總是認為不會出現問題，無論干什么都不會加鎖，如果出現問題，就再次更新值測試（version）
悲觀鎖：十分悲觀，總是認為總是會出現問題，無論干什么都會上鎖，再去操作，影響性能

OptimisticLockerInnerInterceptor：當要更新一條記錄的時候，希望這條記錄沒有被別人更新
樂觀鎖實現方式：

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

1.先查詢獲得版本號
2.更新時增加版本號
3.如果版本號不對就更新失敗
update user set name='Liuyunsan',version = version +1
where id=2 and version =1

數據庫中增加version字段
實體類增加對應字段以及注解
注冊組件

@Configuration
@EnableTransactionManagement  //開啟事務
@MapperScan("com.ji.mapper")//掃面mapper文件夾，類似於mybatis.mapper-locations=classpath:mybatis/mapper/*.xml
public class MybatisPlusConfig {
    //配置樂觀鎖插件
    @Bean
    public OptimisticLockerInterceptor mybatisPlusInterceptor() {
        return new OptimisticLockerInterceptor();
    }

}

測試

 //樂觀鎖成功
    @Test
    public void contextSuccess() {
        //查詢用戶信息
        User user1 = userMapper.selectById(1);
        //修改用戶信息
        user1.setName("jsp");
        user1.setEmail("777");
        //執行更新操作
        int i = userMapper.updateById(user1);

    }
//樂觀鎖失敗
    @Test
    public void contextFail() {
        User user1 = userMapper.selectById(1);
        user1.setName("jsp777");
        user1.setEmail("777777");

        User user2 = userMapper.selectById(1);
        user2.setName("jsp888");
        user2.setEmail("888888");

        userMapper.updateById(user2);
        //自旋鎖多次提交
        userMapper.updateById(user1);  //如果沒有樂觀鎖就會覆蓋插隊線程的值
    }

查詢操作

//查詢單個用戶
    @Test
    public void testSelect(){
        User user = userMapper.selectById(1);
        System.out.println(user);
    }
    //查詢多個用戶
    @Test
    public void testSelectServel(){
        List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
        for (User user : users) {
            System.out.println(user);
        }
    }
    //條件查詢
    @Test
    public void testCondition(){
        HashMap<String, Object> map = new HashMap<>();
        //自定義查詢
        map.put("name","流雲散");
        map.put("age",18);
        List<User> users = userMapper.selectByMap(map);
        for (User user : users) {
            System.out.println(user);
        }
    }

分頁查詢

原始 limit 進行分頁
pageHelper第三方插件
mybatis-plus內置插件
配置攔截器組件

@Configuration
@EnableTransactionManagement  //開啟事務
@MapperScan("com.ji.mapper")//掃面mapper文件夾，類似於mybatis.mapper-locations=classpath:mybatis/mapper/*.xml
public class MybatisPlusConfig {
    //配置樂觀鎖插件
    @Bean
    public OptimisticLockerInterceptor mybatisPlusInterceptor() {
        return new OptimisticLockerInterceptor();
    }
    //分頁插件
    @Bean
    public PaginationInterceptor paginationInterceptor(){
       return new PaginationInterceptor();
    }

}

測試

    @Test
    public void testPage(){
        //參數一當前頁
        //參數二頁面大小
        Page<User> objectPage = new Page<>(1,5);
        userMapper.selectPage(objectPage, null);
        List<User> records = objectPage.getRecords();
        for (User record : records) {
            System.out.println(record);
        }
    }

刪除操作

基本刪除操作（物理刪除：數據庫中直接移除）

@Test
   //刪除
   public void testDeleteById(){
       //通過id
       long x=1;
       userMapper.deleteById(x);
      //批量刪除
       userMapper.deleteBatchIds(Arrays.asList(1,3,5,7,9));
       HashMap<String, Object> map = new HashMap<>();
       //自定義查詢
       map.put("name","流雲散");
       map.put("age",18);
       userMapper.deleteByMap(map);
   }

邏輯刪除（數據庫中沒有被移除，通過變量使他生效）
管理員可以查看被刪除的記錄，防止數據丟失，類似於回收站
數據庫增加delete字段
實體類中增加屬性
配置

測試

//邏輯刪除
   //字段必須時deleted
   @Test
   public void testDeleteLogic(){
       //通過id
       long x=2;
       userMapper.deleteById(x);

   }

性能分析插件

在平時開發中，如果遇到一些慢sql，可以通過mybatis-plus中的性能分析插件，如果超過這個時間就停止運行並拋出異常
作用：性能分析攔截器，用於輸出每條SQL語句及其執行時間

導入插件

 //性能分析插件
    @Bean
    @Profile({"dev","test"})
    public PerformanceInterceptor performanceInterceptor(){
        PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
        performanceInterceptor.setMaxTime(100);//設置sql執行最大時間，如果超過了就不執行
        performanceInterceptor.setFormat(true);//開啟格式化支持
        return new PerformanceInterceptor();
    }

spring.profiles.active=dev

測試使用

//查詢單個用戶

    @Test
    public void testSelect(){
        User user = userMapper.selectById(3);
        System.out.println(user);
    }

條件構造器wrapper

復雜sql可以使用wrapper來替代

測試：

 @Test
    void contextLoads() {
        //查詢name不為空並且郵箱不為空的用戶，年齡大於等於12
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper
                .isNotNull("name")
                .isNotNull("email")
                .ge("age",12);
        List<User> users = userMapper.selectList(wrapper);
        for (User user : users) {
            System.out.println(user);
        }
    }
@Test
    void contextLoads1() {
        //查詢name等於"流雲散"
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.eq("name","流雲散");
        User user = userMapper.selectOne(wrapper);  //查詢一個數據，多個使用list或者map
        System.out.println(user);
    }
  @Test
    void contextLoads2() {
        //查詢age在20-30歲之間的用戶數量
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.between("age",20,30);
        Integer integer = userMapper.selectCount(wrapper);
        System.out.println(integer);
    }
//模糊查詢
    @Test
    void contextLoads3() {
        //名字不包含
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper
                .notLike("name","e")  //%e%
                .likeRight("email","t"); //t%
        List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
        for (Map<String, Object> map : maps) {
            System.out.println(map);
        }
    }

    @Test
    void contextLoads4() {
        //名字不包含
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        //id 在子查詢中查出來
        //SELECT id,name,age,email,create_time,update_time,version,deleted 
        // FROM user 
        // WHERE deleted=0 AND id IN (select id from `user` where id < 3) 
        wrapper.inSql("id","select id from `user` where id <  3" );
        List<Object> objects = userMapper.selectObjs(wrapper);
        objects.forEach(System.out::println);
    }

   //排序
    @Test
    void contextLoads5() {
        //通過id進行排序
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.orderByDesc("id");
        List<User> users = userMapper.selectList(wrapper);
        users.forEach(System.out::println);
    }

代碼生成器

AutoGenerator 是 MyBatis-Plus 的代碼生成器，通過 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各個模塊的代碼，極大的提升了開發效率。

dao,pojo,service,controller自動生成代碼

導入依賴

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.5.1</version>
</dependency>

FastAutoGenerator.create("url", "username", "password")
	.globalConfig(builder -> {
		builder.author("baomidou") // 設置作者
            .enableSwagger() // 開啟 swagger 模式
			.fileOverride() // 覆蓋已生成文件
			.outputDir("D://"); // 指定輸出目錄
	})
	.packageConfig(builder -> {
		builder.parent("com.baomidou.mybatisplus.samples.generator") // 設置父包名
			.moduleName("system") // 設置父包模塊名
            .pathInfo(Collections.singletonMap(OutputFile.mapperXml, "D://")); // 設置mapperXml生成路徑
	})
	.strategyConfig(builder -> {
		builder.addInclude("t_simple") // 設置需要生成的表名
			.addTablePrefix("t_", "c_"); // 設置過濾表前綴
	})
	.templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板，默認的是Velocity引擎模板
	.execute();

// 處理 all 情況
protected static List<String> getTables(String tables) {
    return "all".equals(tables) ? Collections.emptyList() : Arrays.asList(tables.split(","));
}

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。

猜您在找 MybatisPlus MyBatisPlus MyBatisPlus詳解 MybatisPlus的FieldStrategy MybatisPlus的EntityWrapper MyBatisPlus 配置 Mybatisplus源碼 MyBatisPlus之AbstractWrapper MyBatisPlus查詢 MybatisPlus入門