Springboot整合Mybatis-plus（比較詳細）

碼農BookSea發表於2020-10-24
Spring BootMyBatis
  • 注重版權，轉載請註明原作者和原文連結
    作者：碼農BookSea
    原文連結：https://blog.csdn.net/bookssea/article/details/109264336

先看後贊，養成習慣。
點贊收藏，人生輝煌。

在這裡插入圖片描述

Springboot整合Mybatis-plus

一、新增依賴pom.xml

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid-spring-boot-starter</artifactId>
    <version>1.1.20</version>
</dependency>
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.3.2</version>
</dependency>
<!-- mybatis plus 程式碼生成器依賴 -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.3.2</version>
</dependency>
<!-- 程式碼生成器模板 -->
<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
</dependency>

二、application.yml新增配置

spring:
  #資料庫配置
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/user_role?useUnicode=true&useSSL=false&characterEncoding=utf-8
    username: root
    password: root
    # 使用druid資料來源
    type: com.alibaba.druid.pool.DruidDataSource
    driver-class-name: com.mysql.jdbc.Driver

三、application配置@MapperScan

@SpringBootApplication
@MapperScan("cn.com.vicente.demo.mapper")
public class BdDemoApplication {

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

}

到這裡就引入了MyBatis-Plus了。

四、程式碼生成器
很多時候，都不想寫entity，mapper等檔案，這個時候就可以使用程式碼生成器來自動生成對應的檔案了。
需要修改幾個地方：

1、資料庫連線
2、檔案需要放置的資料夾地址。

具體程式碼：

package cn.com.bluemoon.demo.generator;

import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;

import java.util.ArrayList;
import java.util.List;
import java.util.Scanner;

// 演示例子，執行 main 方法控制檯輸入模組表名回車自動生成對應專案目錄中

public class CodeGenerator {

    /**
     * <p>
     * 讀取控制檯內容
     * </p>
     */
    public static String scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        StringBuilder help = new StringBuilder();
        help.append("請輸入" + tip + "：");
        System.out.println(help.toString());
        if (scanner.hasNext()) {
            String ipt = scanner.next();
            if (StringUtils.isNotEmpty(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("請輸入正確的" + tip + "！");
    }

    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("vicente");
        gc.setOpen(false);
        // service 命名方式
        gc.setServiceName("%sService");
        // service impl 命名方式
        gc.setServiceImplName("%sServiceImpl");
        // 自定義檔案命名，注意 %s 會自動填充表實體屬性！
        gc.setMapperName("%sMapper");
        gc.setXmlName("%sMapper");
        gc.setFileOverride(true);
        gc.setActiveRecord(true);
        // XML 二級快取
        gc.setEnableCache(false);
        // XML ResultMap
        gc.setBaseResultMap(true);
        // XML columList
        gc.setBaseColumnList(false);
        // gc.setSwagger2(true); 實體屬性 Swagger2 註解
        mpg.setGlobalConfig(gc);

        // 資料來源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://127.0.0.1:3306/user_role?useUnicode=true&useSSL=false&characterEncoding=utf-8");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("root");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        //pc.setModuleName(scanner("模組名"));
        pc.setParent("cn.com.vicente.demo");
        pc.setEntity("entity");
        pc.setService("service");
        pc.setServiceImpl("service.impl");
        mpg.setPackageInfo(pc);

        // 自定義配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };

        // 如果模板引擎是 freemarker
        String templatePath = "/templates/mapper.xml.ftl";
        // 如果模板引擎是 velocity
        // String templatePath = "/templates/mapper.xml.vm";

        // 自定義輸出配置
        List<FileOutConfig> focList = new ArrayList<>();
        // 自定義配置會被優先輸出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定義輸出檔名 ， 如果你 Entity 設定了前字尾、此處注意 xml 的名稱會跟著發生變化！！
                String moduleName = pc.getModuleName()==null?"":pc.getModuleName();
                return projectPath + "/src/main/resources/mapper/" + moduleName
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        /*
        cfg.setFileCreate(new IFileCreate() {
            @Override
            public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
                // 判斷自定義資料夾是否需要建立
                checkDir("呼叫預設方法建立的目錄");
                return false;
            }
        });
        */
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();

        // 配置自定義輸出模板
        //指定自定義模板路徑，注意不要帶上.ftl/.vm, 會根據使用的模板引擎自動識別
        // templateConfig.setEntity("templates/entity2.java");
        // templateConfig.setService();
        // templateConfig.setController();

        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        //strategy.setSuperEntityClass("cn.com.bluemoon.demo.entity");
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        // 公共父類
        //strategy.setSuperControllerClass("cn.com.bluemoon.demo.controller");
        // 寫於父類中的公共欄位
        //strategy.setSuperEntityColumns("id");
        strategy.setInclude(scanner("表名，多個英文逗號分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }

}

五、新增測試
這裡主要是Mybatis-Plus的CURD等方法。

@RunWith(SpringRunner.class)
@SpringBootTest
public class SampleTest {

    private static Logger log = LoggerFactory.getLogger(SampleTest.class);

    @Autowired
    private MpUserService mpUserService;

    @Test
    public void test1() {
        // 插入新記錄
        MpUser mpUser = new MpUser();
        //mpUser.setId(1L);
        mpUser.setEmail("test66@baomidou.com");
        mpUser.setAge(22);
        mpUser.setName("David Hong");
        mpUserService.save(mpUser);
        // 或者
        mpUser.insertOrUpdate();
        // 更新完成後，mpUser物件的id會被補全
        log.info("mpUser={}", mpUser.toString());

    }

    @Test
    public void test2() {
        // 通過主鍵id查詢
        MpUser mpUser = mpUserService.getById(1);
        log.info("mpUser={}", mpUser.toString());
    }

    @Test
    public void test3() {
        // 條件查詢，下面相當於xml中的 select * from mp_user where name = 'Tom' and age = '28' limit 1
        MpUser mpUser = mpUserService.getOne(new QueryWrapper<MpUser>().eq("name", "Tom").eq("age", "28").last("limit 1"));
        log.info("mpUser={}", mpUser.toString());
        // 批量查詢
        List<MpUser> mpUserList = mpUserService.list();
        System.out.println("------------------------------all");
        mpUserList.forEach(System.out::println);
        // 分頁查詢 
        int pageNum = 1;
        int pageSize = 10;
        IPage<MpUser> mpUserIPage = mpUserService.page(new Page<>(pageNum, pageSize), new QueryWrapper<MpUser>().gt("age", "20"));
        // IPage to List
        List<MpUser> mpUserList1 = mpUserIPage.getRecords();
        System.out.println("------------------------------page");
        mpUserList1.forEach(System.out::println);
        // 總頁數
        long allPageNum = mpUserIPage.getPages();
        System.out.println("------------------------------allPageNum");
        System.out.println(allPageNum);
    }

     @Test
    public void test4() {
        MpUser mpUser = mpUserService.getById(2);
        // 修改更新
        mpUser.setName("廣東廣州");
        //mpUserService.updateById(mpUser);
        // 或者
        mpUser.insertOrUpdate();
        // 通過主鍵id刪除
        mpUserService.removeById(1);
        // 或者
        //mpUser.deleteById();
    }


}

六、資料分頁
1、簡單分頁方法

int pageNum = 1;
int pageSize = 10;
IPage<MpUser> mpUserIPage = mpUserService.page(new Page<>(pageNum, pageSize), new QueryWrapper<MpUser>().gt("age", "20"));

上面的分頁其實是呼叫BaseMapper的selectPage方法，這樣的分頁返回的資料確實是分頁後的資料，但在控制檯列印的SQL語句上看到其實並沒有真正的物理分頁，而是通過快取來獲得全部資料中再進行的分頁，這樣對於大資料量操作時是不可取的，那麼接下來就敘述一下，真正實現物理分頁的方法。

2、 物理分頁方法
新建一個MybatisPlusConfig配置類檔案

//Spring boot方式
@EnableTransactionManagement
@Configuration
@MapperScan("com.baomidou.cloud.service.*.mapper*")
public class MybatisPlusConfig {

    @Bean
    public PaginationInterceptor paginationInterceptor() {
        PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
        // 設定請求的頁面大於最大頁後操作， true調回到首頁，false 繼續請求  預設false
        // paginationInterceptor.setOverflow(false);
        // 設定最大單頁限制數量，預設 500 條，-1 不受限制
        // paginationInterceptor.setLimit(500);
        return paginationInterceptor;
    }
}

重新呼叫mpUserService.page可以看到資料有物理分頁

3、XML自定義分頁

UserMapper.java 方法內容
public interface UserMapper{//可以繼承或者不繼承BaseMapper
    /**
     * <p>
     * 查詢 : 根據state狀態查詢使用者列表，分頁顯示
     * 注意!!: 如果入參是有多個,需要加註解指定引數名才能在xml中取值
     * </p>
     *
     * @param page 分頁物件,xml中可以從裡面進行取值,傳遞引數 Page 即自動分頁,必須放在第一位(你可以繼承Page實現自己的分頁物件)
     * @param state 狀態
     * @return 分頁物件
     */
    IPage<User> selectPageVo(Page page, @Param("age") Integer age);
}
UserMapper.xml 等同於編寫一個普通 list 查詢，mybatis-plus 自動替你分頁
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="cn.com.bluemoon.demo.mapper.MpUserMapper">
    <select id="selectPageVo" resultType="cn.com.bluemoon.demo.entity.MpUser">
      SELECT * FROM mp_user WHERE age=#{age}
    </select>
</mapper>

UserServiceImpl.java 呼叫分頁方法

public IPage<User> selectUserPage(Page<User> page, Integer state) {
    // 不進行 count sql 優化，解決 MP 無法自動優化 SQL 問題，這時候你需要自己查詢 count 部分
    // page.setOptimizeCountSql(false);
    // 當 total 為小於 0 或者設定 setSearchCount(false) 分頁外掛不會進行 count 查詢
    // 要點!! 分頁返回的物件與傳入的物件是同一個
    return baseMapper.selectPageVo(page, state);
}

4、測試自定義方法

 @Test
    public void test5() {
        Page<MpUser> mpUserPage = new Page<>(1,2);
        IPage<MpUser> iPage = mpUserService.selectUserPage(mpUserPage,22);
        System.out.println("總頁數："+iPage.getPages());
        System.out.println("總記錄數："+iPage.getTotal());
        List<MpUser> mpUserList1 = iPage.getRecords();
        mpUserList1.forEach(System.out::println);
    }

七、列印sql日誌
為了方便排查錯誤，很多時候需要列印mybatis生成的sql語句，這時候就需要列印日誌了。
在application.yml中新增：

 Logger Config
logging:
  level:
    cn.com.vicente.demo: debug

或者

mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

八、邏輯刪除
很多時候需要表的資料雖然刪除了，但是還是希望不是真正刪除資料，資料還是留在資料庫中，只需要使用一個欄位來做標誌為即可，這時候就需要邏輯刪除功能。

SpringBoot 配置方式：

application.yml 加入配置(如果你的預設值和mp預設的一樣,該配置可無):

mybatis-plus:
  global-config:
    db-config:
      logic-delete-value: 1 # 邏輯已刪除值(預設為 1)
      logic-not-delete-value: 0 # 邏輯未刪除值(預設為 0)

註冊 Bean(3.1.1開始不再需要這一步)：

import com.baomidou.mybatisplus.core.injector.ISqlInjector;
import com.baomidou.mybatisplus.extension.injector.LogicSqlInjector;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MyBatisPlusConfiguration {

    @Bean
    public ISqlInjector sqlInjector() {
        return new LogicSqlInjector();
    }
}

實體類欄位上加上@TableLogic註解

@TableField(select = false)註解，可以不查詢出deleted欄位

@TableLogic
//@TableField(select = false)
private Integer deleted;
效果: 使用mp自帶方法刪除和查詢都會附帶邏輯刪除功能 (自己寫的xml不會)

example
刪除時 update user set deleted=1 where id =1 and deleted=0
查詢時 select * from user where deleted=0
附件說明

邏輯刪除是為了方便資料恢復和保護資料本身價值等等的一種方案，但實際就是刪除。
如果你需要再查出來就不應使用邏輯刪除，而是以一個狀態去表示。
九、主鍵策略
mybatis-plus 的主鍵生成的型別 預設型別 是 IdType.ID_WORKER全域性唯一ID，內容為空自動填充（預設配置），雪花演算法

1，區域性主鍵策略實現

在實體類中 ID屬性加註解

@TableId(type = IdType.AUTO) 主鍵自增 資料庫中需要設定主鍵自增
private Long id;

@TableId(type = IdType.NONE) 預設跟隨全域性策略走
private Long id;

@TableId(type = IdType.UUID) UUID型別主鍵
private Long id;

@TableId(type = IdType.ID_WORKER) 數值型別資料庫中也必須是數值型別 否則會報錯
private Long id;

@TableId(type = IdType.ID_WORKER_STR) 字串型別   資料庫也要保證一樣字元型別
private Long id;

@TableId(type = IdType.INPUT) 使用者自定義了  資料型別和資料庫保持一致就行
private Long id;

2，全域性主鍵策略實現

需要在application.yml檔案中新增

mybatis-plus:
  global-config:
    db-config:
      id-type: uuid/none/input/id_worker/id_worker_str/auto

表示全域性主鍵都採用該策略（如果全域性策略和區域性策略都有設定，區域性策略優先順序高）
十、自動填充
很多時候表中都需要新增建立時間，建立人，修改時間，修改人來跟蹤資料的來源和變動，但每次插入資料和修改資料的時候都要set這幾個欄位又感覺很麻煩，這個時候就係統系統能自動填充這幾個欄位了。

欄位必須宣告TableField註解，屬性fill選擇對應策略，該申明告知 Mybatis-Plus 需要預留注入 SQL 欄位

@TableField(fill = FieldFill.INSERT)
private LocalDateTime createTime;

@TableField(fill = FieldFill.INSERT_UPDATE)
private LocalDateTime updateTime;

屬性fill有四種對應策略，分別為：

public enum FieldFill {
    /**
     * 預設不處理
     */
    DEFAULT,
    /**
     * 插入填充欄位
     */
    INSERT,
    /**
     * 更新填充欄位
     */
    UPDATE,
    /**
     * 插入和更新填充欄位
     */
    INSERT_UPDATE
}

自定義實現類 MyMetaObjectHandler:

@Component
public class MyMetaObjectHandler implements MetaObjectHandler {

    private static final Logger LOGGER = LoggerFactory.getLogger(MyMetaObjectHandler.class);

    @Override
    public void insertFill(MetaObject metaObject) {
        LOGGER.info("start insert fill ....");
        //this.setFieldValByName("createTime", LocalDateTime.now(), metaObject);
        this.setInsertFieldValByName("createTime", LocalDateTime.now(), metaObject);
        this.setInsertFieldValByName("updateTime", LocalDateTime.now(), metaObject);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        LOGGER.info("start update fill ....");
        this.setUpdateFieldValByName("updateTime", LocalDateTime.now(), metaObject);
    }
}

測試使用

 @Test
    public void testInsert() {
        // 插入新記錄
        MpUser mpUser = new MpUser();
        mpUser.setEmail("wm@baomidou.com");
        mpUser.setAge(28);
        mpUser.setName("王蒙");
        mpUserService.save(mpUser);
        log.info("mpUser={}", mpUser.toString());
    }

 @Test
    public void testUpdate() {
        // 更新記錄
        MpUser mpUser = new MpUser();
        mpUser.setId(1182478087497998337L);
        MpUser newUser = mpUser.selectById();
        System.out.println(mpUser == newUser);
        mpUser.setName("王天");
        mpUser.updateById();
        log.info("mpUser={}", mpUser.toString());
        log.info("newUser={}", newUser.toString());
    }

自動填充優化

insertFill方法每次插入的時候都會呼叫，如果不存在createTime屬性的話，每次插入都會白白呼叫了，浪費資源，所以可以判斷是否存在該屬性

boolean hasCreateTime = metaObject.hasSetter(“createTime”);
if (hasCreateTime){
this.setInsertFieldValByName(“createTime”, LocalDateTime.now(), metaObject);
}
希望，當更新時有設定時間，就用更新時設定的時間，當沒有設定時就自動填充更新時間，可以這樣設定

Object fieldValue = getFieldValByName(“updateTime”, metaObject);
if (fieldValue == null){
this.setUpdateFieldValByName(“updateTime”, LocalDateTime.now(), metaObject);/
}

相關文章