Mybatis-plus 代碼生成器 AutoGenerator 的簡介和（最詳細）使用

　　原文地址：https://blog.csdn.net/xzys430/article/details/109089884

一、添加依賴

        MyBatis-Plus 從 3.0.3 之后移除了代碼生成器與模板引擎的默認依賴，需要手動添加相關依賴。以下是AutoGenerator代碼生成器和freemarker模板引擎依賴（模板引擎選一種，也可以自定義模板引擎）：

<!--mybatis-plus（springboot版）-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.0</version>
</dependency>
<!--mybatis-plus代碼生成器-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.4.0</version>
</dependency>
<!--Velocity（默認）模板引擎-->
<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.2</version>
</dependency>
<!--freemarker模板引擎（博主用的）-->
<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.30</version>
</dependency>
<!--beetl模板引擎-->
<dependency>
    <groupId>com.ibeetl</groupId>
    <artifactId>beetl</artifactId>
    <version>3.2.1.RELEASE</version>
</dependency>

二、自定義參數

1、配置 GlobalConfig（全局配置）

// 全局配置
GlobalConfig gc = new GlobalConfig();
//項目根目錄
String projectPath = System.getProperty("user.dir");
//用於多個模塊下生成到精確的目錄下（我設置在桌面）
//String projectPath = "C:/Users/xie/Desktop";
//代碼生成目錄
gc.setOutputDir(projectPath + "/src/main/java");
//開發人員
gc.setAuthor("先謝郭嘉");
// 是否打開輸出目錄(默認值：null)
gc.setOpen(false);
//實體屬性 Swagger2 注解
gc.setSwagger2(true);
//去掉接口上的I
//gc.setServiceName("%Service");
// 配置時間類型策略（date類型），如果不配置會生成LocalDate類型
gc.setDateType(DateType.ONLY_DATE);
// 是否覆蓋已有文件(默認值：false)
gc.setFileOverride(true);
//把全局配置添加到代碼生成器主類
mpg.setGlobalConfig(gc);

2、 配置 DataSourceConfig（數據源配置）

// 數據源配置
DataSourceConfig dsc = new DataSourceConfig();
//數據庫連接
dsc.setUrl("jdbc:mysql://localhost:3306/blog?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=GMT%2B8");
// 數據庫 schema name
//dsc.setSchemaName("public");
// 數據庫類型
dsc.setDbType(DbType.MYSQL);
// 驅動名稱
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
//用戶名
dsc.setUsername("root");
//密碼
dsc.setPassword("430423");
//把數據源配置添加到代碼生成器主類
mpg.setDataSource(dsc);

3、 配置PackageConfig（包名配置）

// 包配置
PackageConfig pc = new PackageConfig();
// 添加這個后 會以一個實體為一個模塊 比如user實體會生成user模塊 每個模塊下都會生成三層
// pc.setModuleName(scanner("模塊名"));
// 父包名。如果為空，將下面子包名必須寫全部， 否則就只需寫子包名
pc.setParent("com.xxgg.blog");
// Service包名
pc.setService("service");
// Entity包名
pc.setEntity("entity");
// ServiceImpl包名
pc.setServiceImpl("service.impl");
// Mapper包名
pc.setMapper("mapper");
// Controller包名
pc.setController("controller");
// Mapper.xml包名
pc.setXml("mapper");
// 把包配置添加到代碼生成器主類
mpg.setPackageInfo(pc);

4、 配置InjectionConfig（自定義配置）

// 自定義配置
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);

5、 配置TemplateConfig（模板配置）

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

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

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

6、配置StrategyConfig（策略配置）

// 策略配置，我喜歡叫數據庫表配置
StrategyConfig strategy = new StrategyConfig();
// 數據庫表映射到實體的命名策略:下划線轉駝峰
strategy.setNaming(NamingStrategy.underline_to_camel);
// 數據庫表字段映射到實體的命名策略, 未指定按照 naming 執行
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
// 實體是否為lombok模型（默認 false）
strategy.setEntityLombokModel(true);
// 生成 @RestController 控制器
strategy.setRestControllerStyle(true);
// 實體類主鍵名稱設置
strategy.setSuperEntityColumns("id");
// 需要包含的表名，允許正則表達式
//這里我做了輸入設置
strategy.setInclude(scanner("表名，多個英文逗號分割").split(","));
// 需要排除的表名，允許正則表達式
//strategy.setExclude("***");
// 是否生成實體時，生成字段注解 默認false;
strategy.setEntityTableFieldAnnotationEnable(true);
// 駝峰轉連字符
strategy.setControllerMappingHyphenStyle(true);
// 表前綴
strategy.setTablePrefix(pc.getModuleName() + "_");
// 把數據庫配置添加到代碼生成器主類
mpg.setStrategy(strategy);

7、生成

// 在代碼生成器主類上配置模板引擎
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
//生成
mpg.execute();

三、演示

1、代碼

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;

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("yxl");
        //打開輸出目錄
        gc.setOpen(false);
        //xml開啟 BaseResultMap
        gc.setBaseResultMap(true);
        //xml 開啟BaseColumnList
        gc.setBaseColumnList(true);
        // 實體屬性 Swagger2 注解
        gc.setSwagger2(true);
        mpg.setGlobalConfig(gc);
        // 數據源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3310/his-base-center?"+
                "useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia" +
                "/Shanghai");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("root");
        mpg.setDataSource(dsc);
        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setParent("com.his.base.org")
                .setEntity("pojo")
                .setMapper("mapper")
                .setService("service")
                .setServiceImpl("service.impl")
                .setController("controller");
        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 + "/hx-com.his.base.api/src/main/resources/mapper/"
                        + tableInfo.getEntityName() + "Mapper"
                        + StringPool.DOT_XML;
            }
        });
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);
        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();
        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);
        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        //數據庫表映射到實體的命名策略
        strategy.setNaming(NamingStrategy.underline_to_camel);
        //數據庫表字段映射到實體的命名策略
        strategy.setColumnNaming(NamingStrategy.no_change);
        //lombok模型
        strategy.setEntityLombokModel(true);
        //生成 @RestController 控制器
        strategy.setRestControllerStyle(true);
        strategy.setInclude(scanner("表名，多個英文逗號分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        //表前綴
        strategy.setTablePrefix(pc.getModuleName()+"_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }
}

2、pom.xml文件

<!--web 依賴-->



<dependency>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-web</artifactId>

</dependency>

<!--mybatis-plus 依賴-->



<dependency>

<groupId>com.baomidou</groupId>

<artifactId>mybatis-plus-boot-starter</artifactId>

<version>3.3.1.tmp</version>

</dependency>

<!--mybatis-plus 代碼生成器依賴-->



<dependency>

<groupId>com.baomidou</groupId>

<artifactId>mybatis-plus-generator</artifactId>

<version>3.3.1.tmp</version>

</dependency>

<!--freemarker 依賴-->



<dependency>

<groupId>org.freemarker</groupId>

<artifactId>freemarker</artifactId>

</dependency>

<!--mysql 依賴-->



<dependency>

<groupId>mysql</groupId>

<artifactId>mysql-connector-java</artifactId>

<scope>runtime</scope>

</dependency>