Mybatis-Plus的使用！

Mybatis-Plus

感謝B站up主【狂神說Java】原文，有學習的夥伴能夠看這位up主！

1、特性

無侵入：只作加強不作改變，引入它不會對現有工程產生影響，如絲般順滑
損耗小：啓動即會自動注入基本 CURD，性能基本無損耗，直接面向對象操做， BaseMapper
強大的 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、DB二、H二、HSQL、SQLite、
Postgre、SQLServer 等多種數據庫
內置性能分析插件：可輸出 Sql 語句以及其執行時間，建議開發測試時啓用該功能，能快速揪出慢查詢
內置全局攔截插件：提供全表 delete 、 update 操做智能分析阻斷，也可自定義攔截規則，預防誤操做

2、使用步驟

一、建立數據庫 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)
);
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');
-- 真實開發中，version（樂觀鎖）、deleted（邏輯刪除）、gmt_create、gmt_modified

二、建立SpringBoot項目！

三、導入依賴

<!-- 數據庫驅動 -->
<dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>
</dependency>
<!-- lombok -->
<dependency>
  <groupId>org.projectlombok</groupId>
  <artifactId>lombok</artifactId>
</dependency>
<!-- mybatis-plus -->
<!-- mybatis-plus 是本身開發，並不是官方的！ -->
<dependency>
  <groupId>com.baomidou</groupId>
  <artifactId>mybatis-plus-boot-starter</artifactId>
  <version>3.0.5</version>
</dependency>

四、配置

# mysql 5 驅動不一樣 com.mysql.jdbc.Driver
# mysql 8 驅動不一樣com.mysql.cj.jdbc.Driver、須要增長時區的配置
serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?
useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

五、建實體類

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

六、mapper接口

// 在對應的Mapper上面繼承基本的類 BaseMapper
@Repository // 表明持久層
public interface UserMapper extends BaseMapper<User> { 
  // 全部的CRUD操做都已經編寫完成了
  // 你不須要像之前的配置一大堆文件了！
}

七、入口類掃描dao

在主啓動類上去掃描咱們的mapper包下的全部接口java

@MapperScan("com.yn.mapper")

3、配置日誌

咱們全部的sql如今是不可見的，咱們但願知道它是怎麼執行的，因此咱們必需要看日誌！mysql

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

配置完畢日誌以後，後面的學習就須要注意這個自動生成的SQL，大家就會喜歡上 MyBatis-Plus！
spring

4、CRUD擴展

一、插入操做

@Autowired
    private UserMapper userMapper;

    @Test
    public void testInsert() { 
        User user = new User();
        user.setName("張三");
        user.setAge(23);
        user.setEmail("163.com");

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

二、主鍵生成策略

在實體類字段上 @TableId(type = IdType.xxx)，一共有六種主鍵生成策略sql

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User { 
/* @TableId(type = IdType.AUTO) // 1.數據庫id自增 注意：在數據庫裏字段必定要設置自增！ @TableId(type = IdType.NONE) // 2.未設置主鍵 @TableId(type = IdType.INPUT) // 3.手動輸入 @TableId(type = IdType.ID_WORKER) // 4.默認的全局惟一id @TableId(type = IdType.UUID) // 5.全局惟一id uuid @TableId(type = IdType.ID_WORKER_STR) // 6.ID_WORKER 字符串表示法 */
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

三、更新操做

@Test
    public void testUpdate() { 
        User user = new User();
        user.setId(6L);
        user.setName("李四");
        user.setAge(29);
        user.setEmail("qq.com");

        int result = userMapper.updateById(user);
    }

四、自動填充

建立時間、修改時間！這些個操做一遍都是自動化完成的，咱們不但願手動更新！
阿里巴巴開發手冊：全部的數據庫表：gmt_create、gmt_modified幾乎全部的表都要配置上！並且須要自動化！
數據庫

1. 方式一：數據庫級別（工做中不容許你修改數據庫）

在表中新增字段 create_time, update_time，
實體類同步
apache

private Date createTime;
private Date updateTime;

如下爲操做後的變化

mybatis

2. 方式二：代碼級別

一、刪除數據庫的默認值、更新操做！

多線程

二、實體類字段屬性上須要增長註解app

// 字段添加填充內容
@TableField(fill = FieldFill.INSERT)//插入的時候操做
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)//插入和更新的時候都操做
private Date updateTime

三、編寫處理器來處理這個註解便可！分佈式

@Slf4j
@Component//加入spring容器
public class MuMetaObjecHandler implements MetaObjectHandler { 
    // 插入時的填充策略
    @Override
    public void insertFill(MetaObject metaObject) { 
    log.info("start insert fill.....");
    // setFieldValByName(String 字段名, Object 要插入的值, MetaObject meateObject);
    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
悲觀鎖：故名思意十分悲觀，它老是認爲老是出現問題，不管幹什麼都會上鎖！再去操做！

樂觀鎖實現方式：

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

樂觀鎖：1、先查詢，得到版本號 version = 1
-- A  線程
update user set name = "kuangshen", version = version + 1
where id = 2 and version = 1

-- B 線程搶先完成，這個時候 version = 2，會致使 A 修改失敗！
update user set name = "kuangshen", version = version + 1
where id = 2 and version = 1

測試一下MP的樂觀鎖插件

一、給數據庫中增長version字段！

二、實體類加對應的字段

@Version //樂觀鎖Version註解
private Integer version;

三、註冊組件

// 掃描的 mapper 文件夾
@MapperScan("com.yn.mapper")
@EnableTransactionManagement
@Configuration // 配置類
public class MyBatisPlusConfig { 
    // 註冊樂觀鎖插件
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() { 
        return new OptimisticLockerInterceptor();
    }
}

三、測試

// 測試樂觀鎖成功！
    @Test
    public void testOptimisticLocker() { 
        // 一、查詢用戶信息
        User user = userMapper.selectById(1L);
        // 二、修改用戶信息
        user.setName("kuangshen");
        user.setEmail("24736743@qq.com");
        // 三、執行更新操做
        userMapper.updateById(user);
    }

    // 測試樂觀鎖失敗！多線程下
    @Test
    public void testOptimisticLocker2() { 
        // 線程 1
        User user = userMapper.selectById(1L);
        user.setName("kuangshen111");
        user.setEmail("24736743@qq.com");
        // 模擬另一個線程執行了插隊操做
        User user2 = userMapper.selectById(1L);
        user2.setName("kuangshen222");
        user2.setEmail("24736743@qq.com");
        userMapper.updateById(user2);

        // 自旋鎖來屢次嘗試提交！
        userMapper.updateById(user); // 若是沒有樂觀鎖就會覆蓋插隊線程的值！
    }

六、查詢操做

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

    // 測試批量查詢！
    @Test
    public void testSelectByBatchId() { 
        List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
        users.forEach(System.out::println);
    }

    // 按條件查詢之一使用map操做
    @Test
    public void testSelectByBatchIds() { 
        HashMap<String, Object> map = new HashMap<>();
        // 自定義要查詢
        map.put("name", "狂神說Java");
        map.put("age", 3);
        List<User> users = userMapper.selectByMap(map);
        users.forEach(System.out::println);
    }

七、分頁查詢

1.配置攔截器組件

// 掃描的 mapper 文件夾
@MapperScan("com.yn.mapper")
@EnableTransactionManagement
@Configuration // 配置類
public class MyBatisPlusConfig { 
    // 註冊樂觀鎖插件
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() { 
        return new OptimisticLockerInterceptor();
    }

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

2.直接使用Page對象便可

// 測試分頁查詢
    @Test
    public void testPage() { 
        // 參數一：當前頁
        // 參數二：頁面大小
        // 使用了分頁插件以後，全部的分頁操做也變得簡單的！
        Page<User> page = new Page<>(2, 3);
        userMapper.selectPage(page, null);
        page.getRecords().forEach(System.out::println);
        System.out.println(page.getTotal());
    }

八、刪除操做

// 測試刪除
    @Test
    public void testDeleteById() { 
        userMapper.deleteById(1240620674645544965L);
    }

    // 經過id批量刪除
    @Test
    public void testDeleteBatchId() { 
        userMapper.deleteBatchIds(Arrays.asList(1240620674645544961L, 1240620674645544962L));
    }

    // 經過map刪除
    @Test
    public void testDeleteMap() { 
        HashMap<String, Object> map = new HashMap<>();
        map.put("name", "狂神說Java");
        userMapper.deleteByMap(map);
    }

九、邏輯刪除

物理刪除：從數據庫中直接移除

邏輯刪除：再數據庫中沒有被移除，而是經過一個變量來讓他失效！ deleted = 0 => deleted = 1

管理員能夠查看被刪除的記錄！防止數據的丟失，相似於回收站！

邏輯刪除步驟：
一、在數據表中增長一個 deleted 字段

二、實體類中增長屬性

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

三、配置！

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

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

三、查看！

十、性能分析插件

咱們在平時的開發中，會遇到一些慢sql。
做用：性能分析攔截器，用於輸出每條 SQL 語句及其執行時間
MP也提供性能分析插件，若是超過這個時間就中止運行！

一、導入插件

/** * * SQL執行效率插件 * */
    @Bean
    @Profile({ "dev", "test"})// 設置 dev test 環境開啓，保證咱們的效率
    public PerformanceInterceptor performanceInterceptor() { 
        PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
        performanceInterceptor.setMaxTime(100); // ms設置sql執行的最大時間，若是超過了則不執行
        performanceInterceptor.setFormat(true); // 是否格式化代碼
        return performanceInterceptor;
    }

記住，要在SpringBoot中配置環境爲dev或者 test 環境！

#設置開發環境
spring.profiles.active=dev

二、測試使用！

@Test
    void contextLoads() { 
        // 參數是一個 Wrapper ，條件構造器，這裏咱們先不用 null
        // 查詢所有用戶
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }

十一、條件構造器

咱們寫一些複雜的sql就可使用它來替代！

@SpringBootTest
public class WrapperTest { 

    @Autowired
    private UserMapper userMapper;

    //一、測試一，記住查看輸出的SQL進行分析
    @Test
    void test1() { 
        // 查詢name不爲空的用戶，而且郵箱不爲空的用戶，年齡大於等於12
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper
                .isNotNull("name")
                .isNotNull("email")
                .ge("age", 12);
        userMapper.selectList(wrapper).forEach(System.out::println); // 和咱們剛纔學習的map對比一下
    }

    //二、測試二
    @Test
    void test2() { 
        // 查詢名字狂神說
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.eq("name", "狂神說");
        User user = userMapper.selectOne(wrapper); // 查詢一個數據，出現多個結果使用List或者 Map
        System.out.println(user);
    }

    //三、區間查詢
    @Test
    void test3() { 
        // 查詢年齡在 20 ~ 30 歲之間的用戶
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.between("age", 20, 30); // 區間
        Integer count = userMapper.selectCount(wrapper);// 查詢結果數
        System.out.println(count);
    }

    //四、模糊查詢
    @Test
    void test4() { 
        // 查詢年齡在 20 ~ 30 歲之間的用戶
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        // 名字中不包含e的 和 郵箱t%
        wrapper
                .notLike("name", "e")
                .likeRight("email", "t");
        List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
        maps.forEach(System.out::println);
    }

    //五、模糊查詢
    @Test
    void test5() { 
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        // id 在子查詢中查出來
        wrapper.inSql("id", "select id from user where id<3");

        List<Object> objects = userMapper.selectObjs(wrapper);
        objects.forEach(System.out::println);
    }

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

}

十二、代碼自動生成器

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

測試：

package com.yn;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.po.TableFill;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.ArrayList;


public class Code { 

    public static void main(String[] args) { 
        // 須要構建一個 代碼自動生成器 對象
        AutoGenerator mpg = new AutoGenerator();
        // 配置策略
        // 一、全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");//獲取當前的項目路徑
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("王六六");//做者
        gc.setOpen(false);//是否打開資源管理器
        gc.setFileOverride(false); // 是否覆蓋原來生成的
        gc.setServiceName("%sService"); // 去Service的I前綴，生成的server就沒有前綴了
        gc.setIdType(IdType.ID_WORKER); //id生成策略
        gc.setDateType(DateType.ONLY_DATE);//日期的類型
        gc.setSwagger2(true);//自動配置Swagger文檔
        mpg.setGlobalConfig(gc);
        //二、設置數據源
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("root");
        dsc.setDbType(DbType.MYSQL);
        mpg.setDataSource(dsc);
        //三、包的配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("blog");//模塊的名字
        pc.setParent("com.yn");//放在哪一個包下
        pc.setEntity("entity");//實體類的包名字
        pc.setMapper("mapper");//dao的包字
        pc.setService("service");//server的包名
        pc.setController("controller");//controller的包名
        mpg.setPackageInfo(pc);
        //四、策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setInclude("user"); // 設置要映射的表名
        strategy.setNaming(NamingStrategy.underline_to_camel);//數據庫表名 下劃線轉駝峯命名
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);//數據庫列的名字 下劃線轉駝峯命名
        strategy.setEntityLombokModel(true); // 自動生成 lombok；
        strategy.setLogicDeleteFieldName("deleted");//邏輯刪除
        // 自動填充配置
        TableFill gmtCreate = new TableFill("gmt_create", FieldFill.INSERT);
        TableFill gmtModified = new TableFill("gmt_modified", FieldFill.INSERT_UPDATE);
        ArrayList<TableFill> tableFills = new ArrayList<>();
        tableFills.add(gmtCreate);
        tableFills.add(gmtModified);
        strategy.setTableFillList(tableFills);
        // 樂觀鎖
        strategy.setVersionFieldName("version");
        strategy.setRestControllerStyle(true);//開啓駝峯命名
        strategy.setControllerMappingHyphenStyle(true); //controller中連接請求：localhost:8080/hello_id_2
        mpg.setStrategy(strategy);

        mpg.execute(); //執行
    }
}

報錯的能夠導一下這個包

<dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.0</version>
        </dependency>