Mybatis plus簡單使用-有解無憂

一、快速入門

匯入依賴，具體版本根據自己需要可以選擇：

        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>Latest Version</version>
        </dependency>

匯入mybatis-plus就不用匯入mybatis，

資料源配置，這里直接使用spring boot 自帶的資料源，

spring.datasource.username=root
spring.datasource.password=root
spring.datasource.url=jdbc:mysql://localhost:3306/db_test/useSSL=false&useUnicode=true&characterEncoding=utf-8
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

mybatis-plus中，提供了一個BaseMapper，這個mapper整合了單表的CRUD操作，只要使用Mapper集成，就可以直接使用，同時集成了分頁的插件，不過要配置攔截器才能使用，主要掃描介面，@MapperScan("com.mg.mapper")：

/*
 * Copyright (c) 2011-2020, hubin (jobob@qq.com).
 * <p>
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.baomidou.mybatisplus.core.mapper;

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

import org.apache.ibatis.annotations.Param;

import com.baomidou.mybatisplus.core.conditions.Wrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.core.toolkit.Constants;

/*

               :`
                    .:,
                     :::,,.
             ::      `::::::
             ::`    `,:,` .:`
             `:: `::::::::.:`      `:';,`
              ::::,     .:::`   `@++++++++:
               ``        :::`  @+++++++++++#
                         :::, #++++++++++++++`
                 ,:      `::::::;'##++++++++++
                 .@#@;`   ::::::::::::::::::::;
                  #@####@, :::::::::::::::+#;::.
                  @@######+@:::::::::::::.  #@:;
           ,      @@########':::::::::::: .#''':`
           ;##@@@+:##########@::::::::::: @#;.,:.
            #@@@######++++#####'::::::::: .##+,:#`
            @@@@@#####+++++'#####+::::::::` ,`::@#:`
            `@@@@#####++++++'#####+#':::::::::::@.
             @@@@######+++++''#######+##';::::;':,`
              @@@@#####+++++'''#######++++++++++`
               #@@#####++++++''########++++++++'
               `#@######+++++''+########+++++++;
                `@@#####+++++''##########++++++,
                 @@######+++++'##########+++++#`
                @@@@#####+++++############++++;
              ;#@@@@@####++++##############+++,
             @@@@@@@@@@@###@###############++'
           @#@@@@@@@@@@@@###################+:
        `@#@@@@@@@@@@@@@@###################'`
      :@#@@@@@@@@@@@@@@@@@##################,
      ,@@@@@@@@@@@@@@@@@@@@################;
       ,#@@@@@@@@@@@@@@@@@@@##############+`
        .#@@@@@@@@@@@@@@@@@@#############@,
          @@@@@@@@@@@@@@@@@@@###########@,
           :#@@@@@@@@@@@@@@@@##########@,
            `##@@@@@@@@@@@@@@@########+,
              `+@@@@@@@@@@@@@@@#####@:`
                `:@@@@@@@@@@@@@@##@;.
                   `,'@@@@##@@@+;,`
                        ``...``

 _ _     /_ _ _/_. ____  /    _
/ / //_//_//_|/ /_\  /_///_/_\      Talk is cheap. Show me the code.
     _/             /
 */

/**
 * <p>
 * Mapper 繼承該介面后，無需撰寫 mapper.xml 檔案，即可獲得CRUD功能
 * </p>
 * <p>
 * 這個 Mapper 支持 id 泛型
 * </p>
 *
 * @author hubin
 * @since 2016-01-23
 */
public interface BaseMapper<T> {

    /**
     * <p>
     * 插入一條記錄
     * </p>
     *
     * @param entity 物體物件
     */
    int insert(T entity);

    /**
     * <p>
     * 根據 ID 洗掉
     * </p>
     *
     * @param id 主鍵ID
     */
    int deleteById(Serializable id);

    /**
     * <p>
     * 根據 columnMap 條件，洗掉記錄
     * </p>
     *
     * @param columnMap 表欄位 map 物件
     */
    int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);

    /**
     * <p>
     * 根據 entity 條件，洗掉記錄
     * </p>
     *
     * @param queryWrapper 物體物件封裝操作類（可以為 null）
     */
    int delete(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * <p>
     * 洗掉（根據ID 批量洗掉）
     * </p>
     *
     * @param idList 主鍵ID串列(不能為 null 以及 empty)
     */
    int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);

    /**
     * <p>
     * 根據 ID 修改
     * </p>
     *
     * @param entity 物體物件
     */
    int updateById(@Param(Constants.ENTITY) T entity);

    /**
     * <p>
     * 根據 whereEntity 條件，更新記錄
     * </p>
     *
     * @param entity        物體物件 (set 條件值,不能為 null)
     * @param updateWrapper 物體物件封裝操作類（可以為 null,里面的 entity 用于生成 where 陳述句）
     */
    int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper<T> updateWrapper);

    /**
     * <p>
     * 根據 ID 查詢
     * </p>
     *
     * @param id 主鍵ID
     */
    T selectById(Serializable id);

    /**
     * <p>
     * 查詢（根據ID 批量查詢）
     * </p>
     *
     * @param idList 主鍵ID串列(不能為 null 以及 empty)
     */
    List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);

    /**
     * <p>
     * 查詢（根據 columnMap 條件）
     * </p>
     *
     * @param columnMap 表欄位 map 物件
     */
    List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);

    /**
     * <p>
     * 根據 entity 條件，查詢一條記錄
     * </p>
     *
     * @param queryWrapper 物體物件
     */
    T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * <p>
     * 根據 Wrapper 條件，查詢總記錄數
     * </p>
     *
     * @param queryWrapper 物體物件
     */
    Integer selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * <p>
     * 根據 entity 條件，查詢全部記錄
     * </p>
     *
     * @param queryWrapper 物體物件封裝操作類（可以為 null）
     */
    List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * <p>
     * 根據 Wrapper 條件，查詢全部記錄
     * </p>
     *
     * @param queryWrapper 物體物件封裝操作類（可以為 null）
     */
    List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * <p>
     * 根據 Wrapper 條件，查詢全部記錄
     * 注意： 只回傳第一個欄位的值
     * </p>
     *
     * @param queryWrapper 物體物件封裝操作類（可以為 null）
     */
    List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * <p>
     * 根據 entity 條件，查詢全部記錄（并翻頁）
     * </p>
     *
     * @param page         分頁查詢條件（可以為 RowBounds.DEFAULT）
     * @param queryWrapper 物體物件封裝操作類（可以為 null）
     */
    IPage<T> selectPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * <p>
     * 根據 Wrapper 條件，查詢全部記錄（并翻頁）
     * </p>
     *
     * @param page         分頁查詢條件
     * @param queryWrapper 物體物件封裝操作類
     */
    IPage<Map<String, Object>> selectMapsPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
}

在Mapper中直接集成即可：

package com.mg.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.mg.pojo.User;

/**
 * 實作基本的介面，就可以使用CRUD
 */
public interface UserMapper extends BaseMapper<User> {
}

簡單一波測驗：

mybatis-plus，已經幫忙寫好了單表的CRUD和方法，

二、日志配置

所有的SQL都是不可見的，需要查看SQL執行順序等等，

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

可以根據日期，去分析相關問題，

三、CRUD擴展

1、插入，ID會自動添加

@Test
    public void test01(){
        User user = new User();
        user.setName("LMR");
        user.setAge(4);
        user.setEmail("Lmr@123.com");
        int insert = userMapper.insert(user);
        System.out.println(insert);
        System.out.println(user.toString());
    }

主鍵生成策略：

UUID
自增ID
雪花演算法（分布式）
中間件生成（redis、zookeeper）

雪花演算法：

是Twitter開源的分布式ID生成演算法，結果是一個Long的ID，核心思想是：使用41bit作為毫秒數，10bit作為機器的ID（5bit是資料中心，5bit是機器ID），12bit作為毫秒內的流水號（意味著每個節點在每秒可以產生4096個ID），最后一個符號位永遠是0，

可以配置ID生成策略：

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

列舉：

/*
 * Copyright (c) 2011-2020, hubin (jobob@qq.com).
 * <p>
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.baomidou.mybatisplus.annotation;

import lombok.Getter;

/**
 * <p>
 * 生成ID型別列舉類
 * </p>
 *
 * @author hubin
 * @since 2015-11-10
 */
@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;
    }
}

2、更新操作

    @Test
    public void test02(){
        User user = new User();
        user.setId(5L);
        user.setName("MG BASE GOGO!");
        userMapper.updateById(user);
    }

自動填充：

例如修改時間、添加時間都需要自動填充進去，不能手動更新，

資料庫級別的修改：在表中新增欄位，不太建議使用（測驗中發現，就算更顯操作了，但是值沒有改變，則不會填充時間）

代碼級別的修改，撰寫處理器進行處理，

    @TableField(fill = FieldFill.INSERT)
    private Date createTime;
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;

package com.mg.handler;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;

import javax.annotation.security.DenyAll;
import java.util.Date;

@Component
@Slf4j
public class MyMeteObjectHandler implements MetaObjectHandler {

    /**
     * 插入時候的填充策略
     * @param metaObject
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("start insert fill，，，");
        //欄位、值、元資料
        this.setFieldValByName("createTime", new Date(), metaObject);
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }

    /**
     * 更新時候的填充策略
     * @param metaObject
     */
    @Override
    public void updateFill(MetaObject metaObject) {
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }
}

樂觀鎖/悲觀鎖：

樂觀鎖：總是認為不會出現問題，所以不會去上鎖，如果出現了問題，就在再次更新值 version欄位
悲觀鎖：認為總是會出現問題，不論干什么都會先上鎖在操作

mybatis-plus樂觀鎖插件：

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

下面看看怎么配置：

1、資料庫增加欄位，version，默認值是1

2、物體類增加version欄位和@Version注解

    @Version
    private Integer version;

3、注冊組件（新版本MybatisPlus 為了統一管理插件，使用了一個統一的插件管理類，只需要注冊一個Bean就行了 MybatisPlusInterceptor）

package com.mg.config;

import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;

@EnableTransactionManagement
@MapperScan("com.mg.mapper")
@Configuration
public class MybatisPlusConfig {

    @Bean
    public OptimisticLockerInterceptor optimisticLockerInnerInterceptor(){
        return new OptimisticLockerInterceptor();
    }

}

4、測驗，這里user更新就不會成功，因為版本已經被覆寫了

 @Test
    public void test04(){
        //執行緒1
        User user = userMapper.selectById(1L);
        user.setName("123");
        user.setEmail("2292@123.com");
        //執行緒2
        User user2 = userMapper.selectById(1L);
        user2.setName("123_2");
        user2.setEmail("2292@123.com_2");
        userMapper.updateById(user2);
        userMapper.updateById(user);
    }

3、查詢操作

簡單查詢：

 @Test
    public void test05(){
        //單個查詢
        User user = userMapper.selectById(1L);
        System.out.println("單個查詢：" + user.toString());
        //批量查詢
        List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
        users.forEach(u ->{
            System.out.println("批量：" + u.toString());
        });
        //條件查詢 使用map
        Map<String, Object> paramMap = new HashMap<>();
        paramMap.put("name", "123_2");
        paramMap.put("age", 18);
        List<User> users1 = userMapper.selectByMap(paramMap);
        users1.forEach(u->{
            System.out.println("批量：" + u.toString());
        });
    }

分頁查詢：

mybatis-plus 內置分頁插件：（如果是線上的話，一般情況下回自己手動寫 count()查詢的sql）

1、配置攔截器組件即可

    // 舊版
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
        return paginationInterceptor;
    }

    @Test
    public void test06(){
        //當前頁、頁面大小
        Page<User> page = new Page<>(1, 5);
        IPage<User> userIPage = userMapper.selectPage(page, null);
        userIPage.getRecords().forEach(u->{
            System.out.println("批量：" + u.toString());
        });
    }

4、洗掉

物理洗掉：

邏輯洗掉：

1、增加一個deleted欄位

2、增加屬性

    @TableLogic
    private Integer deleted;

3、配置組件

    //邏輯洗掉
    @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

4、測驗，生成的sql不會查詢出來

    @Test
    public void test07(){
        userMapper.deleteById(1L);
    }

四、性能分析插件

主要在平時使用的時候，遇到一些慢sql，mybatis-plus也提供了這樣的插件，如果超過設定時間，則停止運行，發現新版本已經沒有這個功能了，可能是因為提供這樣功能的組件太多了，就給去掉了，

1、匯入插件

    @Profile({"dev","test"})
    @Bean
    public PerformanceInterceptor performanceInterceptor(){
        PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
        //最大執行時間，超過則不執行
        performanceInterceptor.setMaxTime(1);
        //sql格式化
        performanceInterceptor.setFormat(true);
        return performanceInterceptor;
    }

2、測驗使用，超出設定時間，就會拋出例外

五、條件構造器

Wapper 條件構造器，十分重要，一些復雜的條件，可以使用這個替代，

1、測驗1

    @Test
    public void test01(){
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        queryWrapper.isNotNull("name").isNotNull("email").ge("age", 12);
        List<User> users = userMapper.selectList(queryWrapper);
        users.forEach(u->{
            System.out.println(u);
        });
    }

2、測驗2，查詢一個 selectOne

    @Test
    public void test02(){
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        queryWrapper.eq("name", "Tom");
        User user = userMapper.selectOne(queryWrapper);
        System.out.println(user);
    }

3、測驗3，查詢數量selectCount

    @Test
    public void test03(){
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        queryWrapper.between("age", "1", "30");
        int n = userMapper.selectCount(queryWrapper);
        System.out.println(n);
    }

4、測驗4，模糊查詢

    @Test
    public void test04(){
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        queryWrapper.notLike("name", "e")
                .likeLeft("name", "e")
                .likeRight("email", "1");
        List<Map<String, Object>> maps = userMapper.selectMaps(queryWrapper);
        maps.forEach(System.out::println);
    }

5、測驗5，嵌入sql

    @Test
    public void test05(){
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        queryWrapper.inSql("id", "select id from user where id<3");
        List<Object> objects = userMapper.selectObjs(queryWrapper);
        objects.forEach(System.out::println);
    }

6、測驗6，排序

    @Test
    public void test06(){
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        queryWrapper.orderByAsc("id");
        List<Object> objects = userMapper.selectObjs(queryWrapper);
        objects.forEach(System.out::println);
    }

六、代碼自動生成器

引入依賴：

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-freemarker</artifactId>
        </dependency>

生成代碼：

package com.mg;
import java.util.Arrays;
import java.util.HashMap;

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.annotation.DbType;


import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
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 com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;


/**
 * 代碼生成器
 */
public class MGCode {
    public static void main(String[] args) {
        //構建代碼生成器物件
        AutoGenerator mpg = new AutoGenerator();
        //配置策略
        //1、全域配置
        GlobalConfig gc = new GlobalConfig();
        //設定生成地址
        String projectPath = System.getProperty("user.dir");
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("mg");
        //是否打開資源管理器
        gc.setOpen(false);
        //是否覆寫
        gc.setFileOverride(true);
        //設定介面名字
        gc.setServiceName("%sService");
        //主鍵策略
        gc.setIdType(IdType.ID_WORKER);
        //日期型別
        gc.setDateType(DateType.ONLY_DATE);
        //是否開啟檔案
        gc.setSwagger2(true);
        mpg.setGlobalConfig(gc);

        //2、資料源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/db_test?useSSL=false&useUnicode=true&characterEncoding=utf-8");
        dsc.setDriverName("com.mysql.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("root");
        dsc.setDbType(DbType.MYSQL);
        mpg.setDataSource(dsc);


        //3、配置一些包
        PackageConfig pc = new PackageConfig();
        //模塊名稱
        pc.setModuleName("wjf");
        //包名
        pc.setParent("com.mg");
        pc.setEntity("pojo");
        pc.setMapper("mapper");
        pc.setService("service");
        pc.setServiceImpl("service.impl");
        pc.setController("controller");
        mpg.setPackageInfo(pc);

        //4、策略配置
        StrategyConfig strategy = new StrategyConfig();
        //設定需要映射的表明  tb_user
        strategy.setInclude("user", "tb_user");
        //規則 駝峰
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        //Lombok
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        //邏輯洗掉欄位
        strategy.setLogicDeleteFieldName("deleted");
        //自動填充配置
        TableFill createTime = new TableFill("create_time", FieldFill.INSERT);
        TableFill updateTime = new TableFill("update_time", FieldFill.INSERT_UPDATE);
        strategy.setTableFillList(Arrays.asList(createTime, updateTime));
        //樂觀鎖
        strategy.setVersionFieldName("version");
        //controller 相關
        strategy.setRestControllerStyle(true);
        strategy.setControllerMappingHyphenStyle(true);//localhost:8080/hello_id_2
        mpg.setStrategy(strategy);

        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        //執行生成
        mpg.execute();
    }
}

生成的代碼結構：

本文章是基于B站博主，狂神說的，所以mybatis-plus版本比較老，學習新版本的，可以看官網，里面的東西寫的很清楚，MyBatis-Plus，

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/344229.html

標籤：java

上一篇：去哪兒網北京Java開發一、二、HR面全部通過

下一篇：“阿里爸爸”又爆新作，Github新開源303頁Spring全家桶高級筆記