【Spring Boot架構(gòu)】集成Mybatis-Plus的實(shí)例詳解

一、簡介

MyBatis-Plus（簡稱 MP）是一個(gè) MyBatis 的增強(qiáng)工具躲叼，在 MyBatis 的基礎(chǔ)上只做增強(qiáng)不做改變芦缰，為簡化開發(fā)、提高效率而生枫慷。

特性

無侵入：只做增強(qiáng)不做改變让蕾，引入它不會(huì)對現(xiàn)有工程產(chǎn)生影響，如絲般順滑或听；
損耗刑叫ⅰ：啟動(dòng)即會(huì)自動(dòng)注入基本 CURD，性能基本無損耗誉裆，直接面向?qū)ο蟛僮鳎?/li>
強(qiáng)大的 CRUD 操作：內(nèi)置通用 Mapper顿颅、通用 Service，僅僅通過少量配置即可實(shí)現(xiàn)單表大部分 CRUD 操作找御，更有強(qiáng)大的條件構(gòu)造器元镀，滿足各類使用需求；
支持 Lambda 形式調(diào)用：通過 Lambda 表達(dá)式霎桅，方便的編寫各類查詢條件栖疑，無需再擔(dān)心字段寫錯(cuò)；
支持主鍵自動(dòng)生成：支持多達(dá) 4 種主鍵策略（內(nèi)含分布式唯一 ID 生成器 - Sequence）滔驶，可自由配置遇革，完美解決主鍵問題；
支持 ActiveRecord 模式：支持 ActiveRecord 形式調(diào)用揭糕，實(shí)體類只需繼承 Model 類即可進(jìn)行強(qiáng)大的 CRUD 操作萝快；
支持自定義全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）；
內(nèi)置代碼生成器：采用代碼或者 Maven 插件可快速生成 Mapper 著角、 Model 揪漩、 Service 、 Controller 層代碼吏口，支持模板引擎奄容，更有超多自定義配置等您來使用冰更；
內(nèi)置分頁插件：基于 MyBatis 物理分頁，開發(fā)者無需關(guān)心具體操作昂勒，配置好插件之后蜀细，寫分頁等同于普通 List 查詢；
分頁插件支持多種數(shù)據(jù)庫：支持 MySQL戈盈、MariaDB奠衔、Oracle、DB2塘娶、H2归斤、HSQL、SQLite刁岸、Postgre官册、SQLServer 等多種數(shù)據(jù)庫；
內(nèi)置性能分析插件：可輸出 Sql 語句以及其執(zhí)行時(shí)間难捌，建議開發(fā)測試時(shí)啟用該功能膝宁，能快速揪出慢查詢；
內(nèi)置全局?jǐn)r截插件：提供全表 delete 根吁、 update 操作智能分析阻斷员淫，也可自定義攔截規(guī)則，預(yù)防誤操作击敌。

二介返、如何使用

1、項(xiàng)目pom.xml引入依賴

<!--mybatis-plus依賴-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.2.0</version>
</dependency> 復(fù)制代碼

2沃斤、User類

@Data
public class User {
    private Long id;
    private String name;
    private Date CreateDate;
} 復(fù)制代碼

3圣蝎、UserMapper類

public interface UserMapper extends BaseMapper<User> {
} 復(fù)制代碼

4、application.yml

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/testdb?characterEncoding=utf8
    username: root
    password: root
    driver-class-name: com.mysql.cj.jdbc.Driver 復(fù)制代碼

5衡瓶、app啟動(dòng)類徘公，增加配置MapperScan自動(dòng)掃描。

@SpringBootApplication
@MapperScan("com.example.mybatisplus.mapper")
public class MybatisPlusApplication {

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

} 復(fù)制代碼

6哮针、寫單元測試類关面，進(jìn)行測試。

@RunWith(SpringRunner.class)
@SpringBootTest
class MybatisPlusApplicationTests {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelect() {
        System.out.println(("----- selectAll method test ------"));
        List<User> userList = userMapper.selectList(null);
        //數(shù)據(jù)庫目前兩條數(shù)據(jù)十厢，這塊驗(yàn)證一下等太，如果數(shù)量一致則通過，就輸出數(shù)據(jù)信息
        Assert.assertEquals(2, userList.size());
        userList.forEach(System.out::println);
    }
} 復(fù)制代碼

image.png

三蛮放、代碼生成器的使用

1缩抡、項(xiàng)目pom.xml增加依賴

<!--代碼生成器-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.2.0</version>
</dependency>

<!--模板引擎-->
<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.29</version>
</dependency> 
復(fù)制代碼

2、生成代碼的工具類

package com.example.mybatisplus.service;

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;

// 演示例子包颁，執(zhí)行 main 方法控制臺(tái)輸入模塊表名回車自動(dòng)生成對應(yīng)項(xiàng)目目錄中
public class CodeGenerator {
    /**
     * <p>
     * 讀取控制臺(tái)內(nèi)容
     * </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("jobob");
        gc.setOpen(false);
        // gc.setSwagger2(true); 實(shí)體屬性 Swagger2 注解
        mpg.setGlobalConfig(gc);

        // 數(shù)據(jù)源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/testdb?useUnicode=true&useSSL=false&characterEncoding=utf8");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("root");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName(scanner("模塊名"));
        pc.setParent("com.example.mybatisplus.mybatis");
        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<>();
        // 自定義配置會(huì)被優(yōu)先輸出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定義輸出文件名 挎塌， 如果你 Entity 設(shè)置了前后綴、此處注意 xml 的名稱會(huì)跟著發(fā)生變化Ｄ诒摺！
                return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        /*
        cfg.setFileCreate(new IFileCreate() {
            @Override
            public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
                // 判斷自定義文件夾是否需要?jiǎng)?chuàng)建
                checkDir("調(diào)用默認(rèn)方法創(chuàng)建的目錄");
                return false;
            }
        });
        */
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

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

        // 配置自定義輸出模板
        //指定自定義模板路徑待锈，注意不要帶上.ftl/.vm, 會(huì)根據(jù)使用的模板引擎自動(dòng)識(shí)別
        // 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("com.baomidou.ant.common.BaseEntity");
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        // 公共父類
        strategy.setSuperControllerClass("com.baomidou.ant.common.BaseController");
        // 寫于父類中的公共字段
        strategy.setSuperEntityColumns("id");
        strategy.setInclude(scanner("表名漠其，多個(gè)英文逗號(hào)分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }
} 復(fù)制代碼

3、運(yùn)行工具類竿音，如下：