如何一鍵生成mybatisplus

Mybatis代碼生成器相信大家用過，本篇博客我們來介紹如何一鍵生成mybatisplus 的相關Entity、Mapper、Mapper XML、Service、Controller 等各個模塊的代碼?？赡軇e人花兩天時間完成的代碼，你一個小時就搞定了。

1、官方教程

參考文檔如下：https://mybatis.plus/guide/generator.html

其實官方教程寫的很詳細了，這里我在詳細的講解一下官方的文檔。

2、添加依賴

MyBatis-Plus 從 3.0.3 之后移除了代碼生成器與模板引擎的默認依賴，需要手動添加相關依賴。

①、添加代碼生成器依賴

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

②、添加 模板引擎 依賴

mybatis plus 提供了三種模板引擎，另外也可以通過繼承類 com.baomidou.mybatisplus.generator.engine.AbstractTemplateEngine，來自定義模板引擎。

通常我們使用導入默認的依賴就好。

< dependency >
    < groupId >org.apache.velocity< /groupId >
    < artifactId >velocity-engine-core< /artifactId >
    < version >2.2< /version >
< /dependency >

3、編寫配置

主要包括全局配置GlobalConfig（生成文件的目錄，作者名等），數據源配置 DataSourceConfig，模板配置 TemplateConfig。

下面我貼上完整代碼，具體可以查看代碼解釋。

GitHub地址如下：https://github.com/YSOcean/mybatisplusstudy.git

另外，代碼中的相關配置可以參考官網：https://mybatis.plus/config/generator-config.html

package com.ys.mybatisplusstudy.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("IT可樂");
        //是否打開輸出目錄
        gc.setOpen(false);
        //是否開啟 BaseResultMap
        gc.setBaseResultMap(true);
        //是否開啟baseColumnList
        gc.setBaseColumnList(true);
        //實體屬性 Swagger2 注解
        gc.setSwagger2(true);
        mpg.setGlobalConfig(gc);
 
        // 數據源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/mybatisplus?useUnicode=true&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("com.ys.mybatisplusstudy.generator");
        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 的名稱會跟著發生變化??！
                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) {
                // 判斷自定義文件夾是否需要創建
                checkDir("調用默認方法創建的目錄，自定義目錄用");
                if (fileType == FileType.MAPPER) {
                    // 已經生成 mapper 文件判斷存在，不想重新生成返回 false
                    return !new File(filePath).exists();
                }
                // 允許生成模板文件
                return true;
            }
        });
        */
        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("你自己的父類實體,沒有就不用設置!");
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        // 公共父類
        //strategy.setSuperControllerClass("你自己的父類控制器,沒有就不用設置!");
        // 寫于父類中的公共字段
        strategy.setSuperEntityColumns("id");
        strategy.setInclude(scanner("表名，多個英文逗號分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        //mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }
}

演示如下：