Springboot Mybatis Plus自動(dòng)生成工具類詳解代碼

更新時(shí)間：2021年11月24日 15:12:27 作者：、Dong

mybatis-plus 是一個(gè) Mybatis 的增強(qiáng)工具，在 Mybatis 的基礎(chǔ)上只做增強(qiáng)不做改變，為簡(jiǎn)化開發(fā)、提高效率而生，這篇文章帶你使用Springboot Mybatis Plus自動(dòng)生成工具類

前言

代碼生成器，也叫逆向工程，是根據(jù)數(shù)據(jù)庫(kù)里的表結(jié)構(gòu)，自動(dòng)生成對(duì)應(yīng)的實(shí)體類、映射文件和接口。

看到很多小伙伴在為數(shù)據(jù)庫(kù)生成實(shí)體類發(fā)愁，現(xiàn)分享給大家，提高開發(fā)效率。

一、pom依賴

<dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.4.1</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.4.1</version>
        </dependency>
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.30</version>
        </dependency>

二、工具類

package com.his.utils;

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;

/**
 * Mybatis plus代碼自動(dòng)生成
 */
public class MybatisPlusUtil {
    /** 作者 */
    public static final String AUTHOR = "dd";

    /** 類命名 */
    /**
     * Entity命名
     */
    public static final String FILE_NAME_ENTITY = "%sEntity";
    /**
     * MAPPER命名
     */
    public static final String FILE_NAME_MAPPER = "%sMapper";
    /**
     * xml命名
     */
    public static final String FILE_NAME_XML = "%sMapper";
    /**
     * Service命名
     */
    public static final String FILE_NAME_SERVICE = "%sService";
    /**
     * ServiceImpl命名
     */
    public static final String FILE_NAME_SERVICE_IMPL = "%sDO";
    /**
     * Controller命名
     */
    public static final String FILE_NAME_CONTROLLER = "%sController";

    /**
     包命名，可以根據(jù)自己的項(xiàng)目情況自定義生成后的存放路徑
     entity默認(rèn)路徑為父目錄.entity
     mapper默認(rèn)路徑為父目錄.mapper
     service默認(rèn)路徑為父目錄.service
     serviceImpl默認(rèn)路徑為父目錄.service.impl
     controller默認(rèn)路徑為父目錄.controller
     */
    /**
     * PARENT命名
     */
    public static final String PACKAGE_NAME_PARENT = "com.his";
    /**
     * Entity命名
     */
    public static final String PACKAGE_NAME_ENTITY = "repository.entity.control";
    /**
     * MAPPER命名
     */
    public static final String PACKAGE_NAME_MAPPER = "repository.mapper.control";
    /**
     * xml命名
     */
    public static final String PACKAGE_NAME_XML = "sys";
    /**
     * Service命名
     */
    public static final String PACKAGE_NAME_SERVICE = "domain.control";
    /**
     * ServiceImpl命名
     */
    public static final String PACKAGE_NAME_SERVICE_IMPL = "domain.control";
    /**
     * Controller命名
     */
    public static final String PACKAGE_NAME_CONTROLLER = "facade.controller.control";

    /**
     * 讀取控制臺(tái)內(nèi)容
     */
    private 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.isNotBlank(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("請(qǐng)輸入正確的" + tip + "！");
    }

    /**
     * 運(yùn)行這個(gè)main方法進(jìn)行代碼生成
     */
    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.setFileOverride(true);
        gc.setAuthor(AUTHOR);
        gc.setOpen(false);
        gc.setActiveRecord(false);// 不需要ActiveRecord特性的請(qǐng)改為false
        gc.setEnableCache(false);// XML 二級(jí)緩存
        gc.setSwagger2(true); // 實(shí)體屬性 Swagger2 注解
        gc.setBaseResultMap(true);
        gc.setBaseColumnList(true);

        gc.setEntityName(FILE_NAME_ENTITY);
        gc.setMapperName(FILE_NAME_MAPPER);
        gc.setXmlName(FILE_NAME_XML);
        gc.setServiceName(FILE_NAME_SERVICE);
        gc.setServiceImplName(FILE_NAME_SERVICE_IMPL);
        gc.setControllerName(FILE_NAME_CONTROLLER);
        mpg.setGlobalConfig(gc);

        // 數(shù)據(jù)源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:oracle:thin:@ip:port/test");
        dsc.setDriverName("oracle.jdbc.OracleDriver");
        dsc.setUsername("user");
        dsc.setPassword("pass");
        mpg.setDataSource(dsc);

        //包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName(null);
        pc.setParent(PACKAGE_NAME_PARENT);
        pc.setController(PACKAGE_NAME_CONTROLLER);
        pc.setService(PACKAGE_NAME_SERVICE);
        pc.setServiceImpl(PACKAGE_NAME_SERVICE_IMPL);
        pc.setMapper(PACKAGE_NAME_MAPPER);
        pc.setEntity(PACKAGE_NAME_ENTITY);
        pc.setXml(PACKAGE_NAME_XML);
        mpg.setPackageInfo(pc);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        //strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        strategy.setInclude(scanner("表名，多個(gè)英文逗號(hào)分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        // 設(shè)置表前綴
        strategy.setTablePrefix("IEMR_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());

        // 自定義配置
        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/"
                        + "/" + tableInfo.getMapperName() + StringPool.DOT_XML;
            }
        });
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();
        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);

        mpg.execute();
    }
}

結(jié)尾

感謝大家的耐心閱讀，如有建議請(qǐng)私信或評(píng)論留言。如有收獲，勞煩支持，關(guān)注、點(diǎn)贊、評(píng)論、收藏均可，博主會(huì)經(jīng)常更新，與大家共同進(jìn)步

到此這篇關(guān)于Springboot Mybatis Plus自動(dòng)生成工具類詳解代碼的文章就介紹到這了,更多相關(guān)Springboot Mybatis Plus 生成工具類內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: