spingboot + mybatis-plus 代码生成器学习

写在前面的话：

本文仅用于学习交流，适合有一定基础的同学参考
若想马上动手跑起来，提供了一个demo，开箱即用

一、环境

开发环境

- jdk 1.8.0_251
- mysql mysql-5.6.10
- apache-maven 3.6.3
- springboot 2.5.4
- mybatis-plus 3.4.0

上述依赖不再一一介绍安装方式
使用springboot

二、新建工程、新建测试数据库略

新建一个springboot工程
新建一个测试数据库并新建一个表用来测试

上述步骤忘了截图，略过

(作者比较懒就省略了)

三、导入依赖

maven依赖

	<dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>${mysqlVersion}</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>${mybatisPlusVersion}</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>${mybatisPlusVersion}</version>
        </dependency>

我自己的完整依赖作为参考


	<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.31</version>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>${mysqlVersion}</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>${mybatisPlusVersion}</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>${mybatisPlusVersion}</version>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.20</version>
            <scope>provided</scope>
        </dependency>

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.2.6</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.78</version>
        </dependency>

        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-collections4</artifactId>
            <version>4.4</version>
        </dependency>

       <!-- swagger2  -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${swagger3Version}</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${swagger3Version}</version>
        </dependency>

        <!-- 检验工具类-->
        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>5.7.12</version>
        </dependency>

四、配置代码生成器

1、获取mybatis-plus官方配置文档

2、工程新建一个CodeGenerator（自定义名字）java文件,将刚刚文档实列代码复制粘贴，修改实例代码

修改后代码，配置看注释理解意思

/**
 * <b>项目名称：</b>synthesize<br>
 * <b>类所处包：</b>com.synthesize.utils<br>
 * <b>创建人：</b>DadaYu<br>
 * <b>类描述：</b><br>
 * <b>创建时间：</b>2021/9/11 12:01<br>
 */
// 演示例子，执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
@Slf4j
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 (Validator.isNotEmpty(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("请输入正确的" + tip + "！");
    }
    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();

        String projectPath = System.getProperty("user.dir");
        // 全局配置
        GlobalConfig gc = new GlobalConfig()
                // 打开文件
                .setOpen(false)
                // 文件覆盖
                .setFileOverride(true)
                // 开启activeRecord模式
                .setActiveRecord(true)
                // XML ResultMap: mapper.xml生成查询映射结果
                .setBaseResultMap(true)
                // XML ColumnList: mapper.xml生成查询结果列
                .setBaseColumnList(true)
                // swagger注解; 须添加swagger依赖
                .setSwagger2(false)
                // 作者
                .setAuthor("dadayu")
                //设置实体类名称
                .setEntityName("%sEntity")
                // 设置路径
                .setOutputDir(projectPath + "/src/main/java");

        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/synthesize?useUnicode=true&useSSL=false&characterEncoding=utf8");
        // 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.synthesize");
        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/"
                        + "/" + 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("ftl/mybatis-plus/genEntity");
        // templateConfig.setService();
        // templateConfig.setController();

        // 需要关闭自动生成的文件类型
        templateConfig.setXml(null);
        templateConfig.setController(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"); //未注释将不能识别生成'id'字段
        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }

}

需重点注意数据库地址配置

五、配置生成模板 genEntity.ftl

这里只做了实体类生成模板


package ${package.Entity};

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
<#if swagger2>
import io.swagger.annotations.ApiModelProperty;
</#if>
<#if entityLombokModel>
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.experimental.Accessors;
</#if>

import java.util.Date;

/**
* <p>
* ${table.comment!}
* </p>
*
* @author ${author}
* @since ${date}
*/
<#if entityLombokModel>
@Data
<#if superEntityClass??>
@EqualsAndHashCode(callSuper = true)
<#else>
@EqualsAndHashCode(callSuper = false)
</#if>
@Accessors(chain = true)
</#if>
@TableName(value="${table.name}")
public class ${entity} {
<#if entitySerialVersionUID>
        private static final long serialVersionUID = 1L;
</#if>
<#-- ----------  BEGIN 字段循环遍历  ---------->
<#list table.fields as field>

        <#if field.comment!?length gt 0>
                <#if swagger2>
        @ApiModelProperty(value = "${field.comment}")
                <#else>
        /**  ${field.comment}  */
                </#if>
        </#if>
        <#if field.keyFlag>
        <#-- 主键 -->
        @TableId(value = "${field.name}", type = IdType.ASSIGN_UUID)
        <#-- 普通字段 -->
        <#else>
        <#if field.name == "create_dt">
        @TableField(value = "create_dt", fill = FieldFill.INSERT)
        </#if>
        <#if field.name == "update_dt">
        @TableField(value = "update_dt", fill = FieldFill.INSERT_UPDATE)
        </#if>
        </#if>
<#-- 乐观锁注解 -->
        <#if (versionFieldName!"") == field.name>
        @Version
        </#if>
<#-- 逻辑删除注解 -->
        <#if (logicDeleteFieldName!"") == field.name>
        @TableLogic
        </#if>
        private <#if field.propertyType == "LocalDateTime">Date<#else>${field.propertyType}</#if> ${field.propertyName};
</#list>
<#------------  END 字段循环遍历  ---------->
<#if !entityLombokModel>
        <#list table.fields as field>
                <#if field.propertyType == "boolean">
                        <#assign getprefix="is"/>
                <#else>
                        <#assign getprefix="get"/>
                </#if>
                public ${field.propertyType} ${getprefix}${field.capitalName}() {
                return ${field.propertyName};
                }

                <#if entityBuilderModel>
                        public ${entity} set${field.capitalName}(${field.propertyType} ${field.propertyName}) {
                <#else>
                        public void set${field.capitalName}(${field.propertyType} ${field.propertyName}) {
                </#if>
                this.${field.propertyName} = ${field.propertyName};
                <#if entityBuilderModel>
                        return this;
                </#if>
                }
        </#list>
</#if>

<#if !entityLombokModel>
        @Override
        public String toString() {
        return "${entity}{" +
        <#list table.fields as field>
                <#if field_index==0>
                        "${field.propertyName}=" + ${field.propertyName} +
                <#else>
                        ", ${field.propertyName}=" + ${field.propertyName} +
                </#if>
        </#list>
        "}";
        }
</#if>
}

目录CONTENT

spingboot + mybatis-plus 代码生成器学习

一、环境

开发环境

二、新建工程、新建测试数据库略

上述步骤忘了截图，略过

(作者比较懒就省略了)

三、导入依赖

maven依赖

我自己的完整依赖作为参考

四、配置代码生成器

1、获取mybatis-plus官方配置文档

2、工程新建一个CodeGenerator（自定义名字）java文件,将刚刚文档实列代码复制粘贴，修改实例代码

修改后代码，配置看注释理解意思

需重点注意数据库地址配置

五、配置生成模板 genEntity.ftl

这里只做了实体类生成模板

这里需要注意你的文件路径，我是放在resources/ftl/mybatis-plus,需要和上面的CodeGenerator配置实体类模板路径一直

六、完成后运行CodeGenerator文件，输入需要生成的表名

运行结果

生成文件

参考文档

评论区

spingboot + mybatis-plus 代码生成器学习

一、环境

开发环境

二、新建工程、新建测试数据库 略

上述步骤忘了截图，略过

(作者比较懒就省略了)

三、导入依赖

maven依赖

我自己的完整依赖作为参考

四、配置代码生成器

1、获取mybatis-plus官方配置文档

2、工程新建一个CodeGenerator（自定义名字）java文件,将刚刚文档实列代码复制粘贴，修改实例代码

修改后代码，配置看注释理解意思

需重点注意数据库地址配置

五、配置生成模板 genEntity.ftl

这里只做了实体类生成模板

这里需要注意你的文件路径，我是放在resources/ftl/mybatis-plus,需要和上面的CodeGenerator配置实体类模板路径一直

六、完成后运行CodeGenerator文件，输入需要生成的表名

运行结果

生成文件

参考文档

评论区

二、新建工程、新建测试数据库略