mybatis-plus使用簡(jiǎn)介

一、簡(jiǎn)介

MyBatis-Plus（簡(jiǎn)稱(chēng) MP）是一個(gè) MyBatis 的增強(qiáng)工具，在 MyBatis 的基礎(chǔ)上只做增強(qiáng)不做改變孽水，為簡(jiǎn)化開(kāi)發(fā)、提高效率而生。官網(wǎng)是：https://mp.baomidou.com/

特性

• 無(wú)侵入：只做增強(qiáng)不做改變肌访，引入它不會(huì)對(duì)現(xiàn)有工程產(chǎn)生影響，如絲般順滑
• 損耗小：?jiǎn)?dòng)即會(huì)自動(dòng)注入基本 CURD艇劫，性能基本無(wú)損耗吼驶，直接面向?qū)ο蟛僮?/li>
• 強(qiáng)大的 CRUD 操作：內(nèi)置通用 Mapper、通用 Service店煞，僅僅通過(guò)少量配置即可實(shí)現(xiàn)單表大部分 CRUD 操作蟹演，更有強(qiáng)大的條件構(gòu)造器，滿(mǎn)足各類(lèi)使用需求
• 支持 Lambda 形式調(diào)用：通過(guò) Lambda 表達(dá)式顷蟀，方便的編寫(xiě)各類(lèi)查詢(xún)條件酒请，無(wú)需再擔(dān)心字段寫(xiě)錯(cuò)
• 支持主鍵自動(dòng)生成：支持多達(dá) 4 種主鍵策略（內(nèi)含分布式唯一 ID 生成器 - Sequence），可自由配置鸣个，完美解決主鍵問(wèn)題
• 支持 ActiveRecord 模式：支持 ActiveRecord 形式調(diào)用羞反，實(shí)體類(lèi)只需繼承 Model 類(lèi)即可進(jìn)行強(qiáng)大的 CRUD 操作
• 支持自定義全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）
• 內(nèi)置代碼生成器：采用代碼或者 Maven 插件可快速生成 Mapper 、 Model 囤萤、 Service 昼窗、 Controller 層代碼，支持模板引擎涛舍，更有超多自定義配置等您來(lái)使用
• 內(nèi)置分頁(yè)插件：基于 MyBatis 物理分頁(yè)澄惊，開(kāi)發(fā)者無(wú)需關(guān)心具體操作，配置好插件之后，寫(xiě)分頁(yè)等同于普通 List 查詢(xún)
• 分頁(yè)插件支持多種數(shù)據(jù)庫(kù)：支持 MySQL掸驱、MariaDB窘哈、Oracle、DB2亭敢、H2滚婉、HSQL、SQLite帅刀、Postgre让腹、SQLServer 等多種數(shù)據(jù)庫(kù)
• 內(nèi)置性能分析插件：可輸出 Sql 語(yǔ)句以及其執(zhí)行時(shí)間，建議開(kāi)發(fā)測(cè)試時(shí)啟用該功能扣溺，能快速揪出慢查詢(xún)
• 內(nèi)置全局?jǐn)r截插件：提供全表 delete 骇窍、 update 操作智能分析阻斷，也可自定義攔截規(guī)則锥余，預(yù)防誤操作

二腹纳、使用

1、添加依賴(lài)

<!-- mybatisPlus 核心庫(kù) -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.3.1</version>
</dependency>
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.3.1.tmp</version>
</dependency>
<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
</dependency>

這里列出了三個(gè)依賴(lài)驱犹，數(shù)據(jù)庫(kù)操作的依賴(lài)沒(méi)有在這里列出嘲恍，這三個(gè)依賴(lài)是接下來(lái)需要用到的，第一個(gè)依賴(lài)是mybatis-plus的核心依賴(lài)雄驹，第二個(gè)與第三個(gè)依賴(lài)是mybatis-plus的代碼生成器需要用到的依賴(lài)佃牛，因?yàn)閙ybatis-plus是基于模板引擎的模板來(lái)生成代碼和xml文件的，所以需要引入模板引擎的依賴(lài)医舆，freemarker只是其中一種俘侠。

2、application.yml

server:
  port: 8080
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    type: com.alibaba.druid.pool.DruidDataSource
    username: root
    password: root
    url: jdbc:mysql://localhost:3306/mydb?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=GMT%2b8&allowPublicKeyRetrieval=true
mybatis-plus:
  mapper-locations: classpath:mapper/*.xml

使用了druid數(shù)據(jù)庫(kù)蔬将，由于使用了mybatis-plus所以之前對(duì)mybatis的設(shè)置現(xiàn)在就變成了對(duì)mybatis-plus的設(shè)置爷速。

3、CodeGenarator

在你的包下新建一個(gè)類(lèi)CodeGenarator.java

package com.qianfeng.mybatis;

import com.baomidou.mybatisplus.annotation.IdType;
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)輸入模塊表名回車(chē)自動(dòng)生成對(duì)應(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("請(qǐng)輸入" + tip + "：");
        System.out.println(help.toString());
        if (scanner.hasNext()) {
            String ipt = scanner.next();
            if (StringUtils.isNotEmpty(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("請(qǐng)輸入正確的" + tip + "惫东！");
    }

    public static void main(String[] args) {
        // 代碼生成器
        AutoGenerator mpg = new AutoGenerator();

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        //生成的代碼所在的目錄
        gc.setOutputDir(projectPath + "/platform_entity/src/main/java");
        //文檔注釋中的作者名
        gc.setAuthor("huwenlong");
        //在xml文件中是否創(chuàng)建BaseResultMap
        gc.setBaseResultMap(true);
        gc.setOpen(false);
        gc.setBaseColumnList(false);
        gc.setIdType(IdType.AUTO);
        gc.setFileOverride(true);
        //文件命名
        gc.setControllerName("%sController");
        gc.setServiceName("%sService");
        gc.setServiceImplName("%sServiceImpl");
        gc.setXmlName("%sMapper");
        gc.setMapperName("%sMapper");
        // gc.setSwagger2(true); 實(shí)體屬性 Swagger2 注解
        mpg.setGlobalConfig(gc);

        // 數(shù)據(jù)源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/mydb?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=GMT%2b8&allowPublicKeyRetrieval=true");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("huwenlong");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName(null);
        //設(shè)置父包名
        pc.setParent("com.qianfeng");
        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 的名稱(chēng)會(huì)跟著發(fā)生變化Ｔ渌狻禁谦！
                //設(shè)置xml文件的輸出路徑
                return projectPath + "/platform_entity/src/main/resources/mapper/"
                       + 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();
        //不在mapper包下生成xml文件
        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        // strategy.setSuperEntityClass("你自己的父類(lèi)實(shí)體,沒(méi)有就不用設(shè)置!");
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        // 公共父類(lèi)
        // strategy.setSuperControllerClass("你自己的父類(lèi)控制器,沒(méi)有就不用設(shè)置!");
        // 寫(xiě)于父類(lèi)中的公共字段
        // 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();
    }

}

這些配置的詳細(xì)信息可以在這個(gè)頁(yè)面查看：https://mp.baomidou.com/config/generator-config.html州泊。

需要修改的地方有：全局配置（生成的代碼所在的目錄丧蘸、代碼注釋中的作者名）、數(shù)據(jù)源配置（url、username力喷、password刽漂、drivername）。運(yùn)行這個(gè)main方法后按照控制臺(tái)輸出的提示輸入需要生成代碼的數(shù)據(jù)庫(kù)表名回車(chē)就可以了(多個(gè)數(shù)據(jù)庫(kù)之間用英文逗號(hào)分割)弟孟。

注意：由于我使用的時(shí)候開(kāi)發(fā)的是微服務(wù)項(xiàng)目贝咙，一個(gè)項(xiàng)目中有很多個(gè)模塊，我是在一個(gè)模塊中生成的java代碼拂募，所以我的全局配置中的生成的代碼所在的目錄較長(zhǎng)庭猩，如果你開(kāi)發(fā)的是單體項(xiàng)目，就直接從/src開(kāi)始陈症，xml文件的輸出路徑也是蔼水，切記切記。

4录肯、分頁(yè)插件

新建一個(gè)類(lèi)名為MybatisPlusConfig趴腋。

package com.qianfeng.mybatis;

import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import com.baomidou.mybatisplus.extension.plugins.pagination.optimize.JsqlParserCountOptimize;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;

@EnableTransactionManagement
@Configuration
public class MybatisPlusConfig {
    /**
     * 分頁(yè)插件
     */
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
        // 設(shè)置請(qǐng)求的頁(yè)面大于最大頁(yè)后操作， true調(diào)回到首頁(yè)论咏，false 繼續(xù)請(qǐng)求  默認(rèn)false
        paginationInterceptor.setOverflow(false);
        // 設(shè)置最大單頁(yè)限制數(shù)量优炬，默認(rèn) 500 條，-1 不受限制
        paginationInterceptor.setLimit(500);
        // 開(kāi)啟 count 的 join 優(yōu)化,只針對(duì)部分 left join
        paginationInterceptor.setCountSqlParser(new JsqlParserCountOptimize(true));
        return paginationInterceptor;
    }
}

測(cè)試類(lèi)：

package com.qianfeng;

import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.qianfeng.entity.Hotel;
import com.qianfeng.mapper.HotelMapper;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;


import javax.annotation.Resource;
import java.util.List;
@SpringBootTest
public class pageTest {
    @Resource
    private HotelMapper hotelMapper;
    @Test
    public void testPage(){
        //兩個(gè)參數(shù)分別是開(kāi)始下標(biāo)和查詢(xún)的個(gè)數(shù)
        IPage<Hotel> hotelPage = new Page<>(0,5);
        IPage<Hotel> page = hotelMapper.selectPage(hotelPage, null);
        List<Hotel> records = page.getRecords();
        for (Hotel record : records) {
            System.out.println(record);
        }
    }
}