【MybatisPlus】入門，這篇就夠了

簡介

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

簡介也就一句話的事，具體的大家還是去看掛=官網吧。總的說， MP 是對 MyBatis的升級，保留了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 注入攻擊

開始入門

入門其實很簡單。我們首先準備數據源，準備好依賴。一步一步來: 數據庫創建:

<code>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)
);
/<code>

數據的話，大家自己插入幾條數據，我這就不插入數據了:

我們現在需要添加我們的 mybatis-plus 的依賴:

<code> 

    com.baomidou
    mybatis-plus-boot-starter
    3.0.5

/<code>

我們在 entity/model 層去寫我們的實體類:

<code>@Data
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}
/<code>

這裡我用到了 lombok , 這個就不向大家介紹了。

現在開始寫我們的 dao 層 ，有的地方叫 mapper 層，我這裡就不寫 mapper 層了，我就不寫什麼 .xml 的 mapper 配置文件了，我這裡就用註解的形式來做一個簡單的入門。

<code>@Mapper
public interface UserDAO {
    @Select("select * from user")
    List findAll();
}
/<code>

我們在 service 裡面去實現一下這個方法就好了，再在我們的 controller 裡面去調用 service 。這裡呢，我們可以在控制檯去看到我們的sql語句，用這個:

<code>## mybatis日誌
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
/<code>

這就是一個簡單的入門。

CRUB 的使用

Insert 的插入操作

<code>@RunWith(SpringRunner.class)
@SpringBootTest
public class CRUDTests {
    @Autowired
    private UserService userService;

    @Test
    public void testInsert(){

        User user = new User();
        user.setName("Helen");
        user.setAge(18);
        user.setEmail("[email protected]");

        int result = userService.insert(user);
        // 影響的行數
        System.out.println(result);
        // id自動回填
        System.out.println(user);
    }
}
/<code>

主鍵策略

Plus默認的主鍵策略是：ID_WORKER

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

主鍵自增

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

<code>@TableId(type = IdType.AUTO)
private Long id;
/<code>

但是這個呢，似乎不加這個也可以實現主鍵的自增。我在用MyBatis的時候就沒加這個：

<code>@Insert({"insert into user (`name` , `age` ,`email` VALUES (#{name},#{age},#{email})"})
@Options(useGeneratedKeys = true, keyColumn = "id" , keyProperty = "id")
public void insert(TaskNodeRecord taskNodeRecord);
/<code>

這樣寫也可以。

我們要是想影響到所有的主鍵配置，就需要在配置中加入這個:

<code># 全局設置主鍵生成策略
mybatis-plus:
  global-config:
    db-config:
      id-type: auto
/<code>

我們可以看下這個裡面其他的主鍵的策略，看源碼就知道了:

<code>@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;
    }
}
/<code>

Update

我們在 UserDAO 裡面直接寫一個，這裡根據 id 來進行更新:

<code>@Update("update user set `name` = #{name} where `id` = #{id}")
void update(User user);
/<code>

那要是我們遇到了時間的字段呢？比如說 created_at / uodate_at , 這個時間字段其實在數據庫是可以設置自動更新的，這個就不需要我們去操心了，所以我們的使用的時候，在 model 裡面也不需要增加這個 created_at / update_at 兩個字段信息了。

樂觀鎖

主要適用場景：當要更新一條記錄的時候，希望這條記錄沒有被別人更新，也就是說實現線程安全的數據更新

這個樂觀鎖的實現方式是什麼呢?

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

現在我們需要添加這個 version 字段:

<code>ALTER TABLE `user` ADD COLUMN `version` INT
/<code>

再在實體類中添加 version 字段

<code>@Version
@TableField(fill = FieldFill.INSERT)
private Integer version;
/<code>

在藉口裡面添加這個默認值

<code>@Override
public void insertFill(MetaObject metaObject) {
    ......
    this.setFieldValByName("version", 1, metaObject);
}
/<code>

說明

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

我們需要在配置文件裡賣弄無配置一下這個樂觀鎖:

<code>@EnableTransactionManagement
@Configuration
@MapperScan("com.venus.edu.mapper")
public class MybatisPlusConfig {
    /**
     * 樂觀鎖插件
     */
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }
}
/<code>

Select

註解的形式如下:

<code>@Select("select * from user")
/<code>

mapper 就需要自己到 xxxMapper.xml 裡面去寫那個語句了。

分頁

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

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

對分頁的測試:

<code>@Test
public void testSelectPage() {

    Page 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());
}
/<code>

我們也可以實時這個 selectMapPage 方法。

Delete

這個和 select 一樣，就不多說。

性能分析

性能分析攔截器，用於輸出每條 SQL 語句及其執行時間

SQL 性能執行分析,開發環境使用，超過指定時間，停止運行。有助於發現問題

配置插件

參數說明

• maxTime： SQL 執行最大時長，超過自動停止運行，有助於發現問題。
• format： SQL是否格式化，默認false。

Config配置

我們在MybatisConfig 裡面配置如下:

<code>/**
 * SQL 執行性能分析插件
 * 開發環境使用，線上不推薦。 maxTime 指的是 sql 最大執行時長
 * 設置 dev test 環境開啟
 */
@Bean
@Profile({"dev","test"})
public PerformanceInterceptor performanceInterceptor() {
    PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
    performanceInterceptor.setMaxTime(100);//ms，超過此處設置的ms則sql不執行
    performanceInterceptor.setFormat(true);
    return performanceInterceptor;
}
/<code>

SpringBoot 設置 dev 環境

<code># 環境設置：dev、test、prod
spring:
  profiles:
    active: dev
/<code>

測試

<code>/**
 * 測試 性能分析插件
 */
@Test
public void testPerformance() {
    User user = new User();
    user.setName("我是Helen");
    user.setEmail("[email protected]");
    user.setAge(18);
    userService.insert(user);
}
/<code>

條件構造器

• Wrapper ： 條件構造抽象類，最頂端父類
• AbstractWrapper ： 用於查詢條件封裝，生成 sql 的 where 條件
• QueryWrapper ： Entity 對象封裝操作類，不是用 lambda 語法
• UpdateWrapper ： Update 條件封裝，用於 Entity 對象更新操作
• AbstractLambdaWrapper ： Lambda 語法使用 Wrapper 統一處理解析 lambda 獲取 column。
• LambdaQueryWrapper ：看名稱也能明白就是用於 Lambda語法使用的查詢 Wrapper
• LambdaUpdateWrapper ： Lambda 更新封裝 Wrapper

<code>@RunWith(SpringRunner.class)
@SpringBootTest
public class QueryWrapperTests {
    @Autowired
    private UserMapper userMapper;
}
/<code>

AbstractWrapper

ge、gt、le、lt、isNull、isNotNull

<code>@Test
public void testDelete() {

    QueryWrapper queryWrapper = new QueryWrapper<>();
    queryWrapper
        .isNull("name")
        .ge("age", 12)
        .isNotNull("email");
    int result = userMapper.delete(queryWrapper);
    System.out.println("delete return count = " + result);
}
/<code>

相當於：

<code>UPDATE user SET deleted=1 WHERE deleted=0 AND name IS NULL AND age >= ? AND email IS NOT NULL
/<code>

eq、ne

<code>@Test
public void testSelectOne() {

    QueryWrapper queryWrapper = new QueryWrapper<>();
    queryWrapper.eq("name", "Tom");

    User user = userMapper.selectOne(queryWrapper);
    System.out.println(user);
}
/<code>

相當於:

<code>SELECT id,name,age,email,create_time,update_time,deleted,version FROM user WHERE deleted=0 AND name = ?
/<code>

between、notBetween

包含大小邊界

<code>@Test
public void testSelectCount() {

    QueryWrapper queryWrapper = new QueryWrapper<>();
    queryWrapper.between("age", 20, 30);

    Integer count = userMapper.selectCount(queryWrapper);
    System.out.println(count);
}
/<code>

相當於:

<code>SELECT COUNT(1) FROM user WHERE deleted=0 AND age BETWEEN ? AND ?
/<code>

allEq

<code>@Test
public void testSelectList() {

    QueryWrapper queryWrapper = new QueryWrapper<>();
    Map map = new HashMap<>();
    map.put("id", 2);
    map.put("name", "Jack");
    map.put("age", 20);

    queryWrapper.allEq(map);
    List users = userMapper.selectList(queryWrapper);

    users.forEach(System.out::println);
}
/<code>

相當於:

<code>SELECT id,name,age,email,create_time,update_time,deleted,version
FROM user WHERE deleted=0 AND name = ? AND id = ? AND age = ?
/<code>

like、notLike、likeLeft、likeRight

<code>@Test
public void testSelectMaps() {

    QueryWrapper queryWrapper = new QueryWrapper<>();
    queryWrapper
        .notLike("name", "e")
        .likeRight("email", "t");

    List> maps = userMapper.selectMaps(queryWrapper);//返回值是Map列表
    maps.forEach(System.out::println);
}
/<code>

相當於:

<code>SELECT id,name,age,email,create_time,update_time,deleted,version
FROM user WHERE deleted=0 AND name NOT LIKE ? AND email LIKE ?
/<code>

in、notIn、inSql、notinSql、exists、notExists

in、notIn：

• notIn("age",{1,2,3})--->age not in (1,2,3)
• notIn("age", 1, 2, 3)--->age not in (1,2,3)

inSql、notinSql：可以實現子查詢

• 例: inSql("age", "1,2,3,4,5,6")--->age in (1,2,3,4,5,6)
• 例: inSql("id", "select id from table where id < 3")--->id in (select id from table where id < 3)@Test public void testSelectObjs() { QueryWrapper queryWrapper = new QueryWrapper<>(); //queryWrapper.in("id", 1, 2, 3); queryWrapper.inSql("id", "select id from user where id < 3"); List objects = userMapper.selectObjs(queryWrapper);//返回值是Object列表 objects.forEach(System.out::println); } 相當於:SELECT id,name,age,email,create_time,update_time,deleted,version FROM user WHERE deleted=0 AND id IN (select id from user where id < 3) or、and注意：這裡使用的是 UpdateWrapper

不調用or則默認為使用 and 連

<code>@Test
public void testUpdate1() {

    //修改值
    User user = new User();
    user.setAge(99);
    user.setName("Andy");

    //修改條件
    UpdateWrapper userUpdateWrapper = new UpdateWrapper<>();
    userUpdateWrapper
        .like("name", "h")
        .or()
        .between("age", 20, 30);

    int result = userMapper.update(user, userUpdateWrapper);

    System.out.println(result);
}
/<code>

相當於:

<code>UPDATE user SET name=?, age=?, update_time=? WHERE deleted=0 AND name LIKE ? OR age BETWEEN ? AND ?
/<code>

嵌套or、嵌套and

<code>@Test
public void testUpdate2() {
    //修改值
    User user = new User();
    user.setAge(99);
    user.setName("Andy");
    //修改條件
    UpdateWrapper userUpdateWrapper = new UpdateWrapper<>();
    userUpdateWrapper
        .like("name", "h")
        .or(i -> i.eq("name", "李白").ne("age", 20));

    int result = userMapper.update(user, userUpdateWrapper);
    System.out.println(result);
}
/<code>

相當於:

<code>UPDATE user SET name=?, age=?, update_time=?
WHERE deleted=0 AND name LIKE ?
OR ( name = ? AND age <> ? )
/<code>

orderBy、orderByDesc、orderByAsc

<code>@Test
public void testSelectListOrderBy() {

    QueryWrapper queryWrapper = new QueryWrapper<>();
    queryWrapper.orderByDesc("id");

    List users = userMapper.selectList(queryWrapper);
    users.forEach(System.out::println);
}
/<code>

相當於:

<code>SELECT id,name,age,email,create_time,update_time,deleted,version
FROM user WHERE deleted=0 ORDER BY id DESC
/<code>

last

直接拼接到 sql 的最後

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

<code>@Test
public void testSelectListLast() {

    QueryWrapper queryWrapper = new QueryWrapper<>();
    queryWrapper.last("limit 1");

    List users = userMapper.selectList(queryWrapper);
    users.forEach(System.out::println);
}
/<code>

相當於:

<code>SELECT id,name,age,email,create_time,update_time,deleted,version
FROM user WHERE deleted=0 limit 1
/<code>

指定要查詢的列

<code>@Test
public void testSelectListColumn() {

    QueryWrapper queryWrapper = new QueryWrapper<>();
    queryWrapper.select("id", "name", "age");

    List users = userMapper.selectList(queryWrapper);
    users.forEach(System.out::println);
}
/<code>

相當於:

<code>SELECT id,name,age FROM user WHERE deleted=0
/<code>

set、setSql

最終的sql會合並 user.setAge()，以及 userUpdateWrapper.set() 和 setSql() 中 的字段

<code>@Test
public void testUpdateSet() {

    //修改值
    User user = new User();
    user.setAge(99);

    //修改條件
    UpdateWrapper userUpdateWrapper = new UpdateWrapper<>();
    userUpdateWrapper
        .like("name", "h")
        .set("name", "老李頭")//除了可以查詢還可以使用set設置修改的字段
        .setSql(" email = '[email protected]'");//可以有子查詢

    int result = userMapper.update(user, userUpdateWrapper);
}
/<code>

相當於:

<code>UPDATE user SET age=?, update_time=?, name=?, email = '[email protected]' WHERE deleted=0 AND name LIKE ?/<code>