MyBatis-Plus自动生成代码

本文介绍自动生成SpringBoot代码的办法，自动生成内容包括Controller、Service、Entity、Mapper

MyBatis-Plus自动生成代码的github仓库为 https://github.com/baomidou/generator

一、maven依赖

<dependencies>
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.5.1</version>
    </dependency>
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-generator</artifactId>
        <version>3.5.2</version>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.28</version>
    </dependency>
    <dependency>
        <groupId>org.freemarker</groupId>
        <artifactId>freemarker</artifactId>
        <version>2.3.31</version>
    </dependency>
</dependencies>

二、测试代码

/**
 * @TableField(exist = false)：表示该属性不是数据库表字段，但又是必须使用的, 这样的属性需要自己加
 * Controller的RequestMapping需要检查一下
 * 文档参考 https://baomidou.com/pages/779a6e/
 * @param args
 */
public static void main(String[] args) {
    String url = "jdbc:mysql://localhost:3306/test";
    String user = "root";
    String password = "123456";
    String author = "盛桃云";
    String outputDir = "D:/mp-test/src/main/java";
    String xmlOutputDir = "D:/mp-test/src/main/resources/mapper/sys";
    String basePackage = "com.bowei.test";
    String moduleName = "sys";
    String baseEntity = "com.bowei.test.common.BaseEntity";
    String tables = "sys_user,sys_role,sys_menu,sys_user_role,sys_role_menu";
    String[] tablePrefix = {"au_", "sys_"};
    String[] superEntityColumns = {"create_by", "create_time", "update_by", "update_time"};
    FastAutoGenerator.create(url, user, password)
            .globalConfig(builder -> {
                builder.author(author) // 设置作者
                        .outputDir(outputDir); // 指定输出目录
            })
            .packageConfig(builder -> {
                builder.parent(basePackage) // 设置父包名
                        .moduleName(moduleName) // 设置父包模块名
                        .pathInfo(Collections.singletonMap(OutputFile.xml, xmlOutputDir)); // 设置mapperXml生成路径
            })
            .strategyConfig(builder -> {
                builder.addInclude(tables) // 设置需要生成的表名
                        .addTablePrefix(tablePrefix) // 设置过滤表前缀
                        .controllerBuilder().fileOverride().enableRestStyle()
                        .serviceBuilder().fileOverride()
                        .mapperBuilder().fileOverride()
                        .entityBuilder().fileOverride().enableTableFieldAnnotation()
                        .enableLombok().superClass(baseEntity)
                        .addSuperEntityColumns(superEntityColumns);
            })
            .templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板，默认的是Velocity引擎模板
            .execute();
}

运行该代码，然后到代码中的路径去检查文件是否正确生成了。

三、LocalDateTime字段自动生成@JsonFormat

对于DateTime类型的字段，默认的实体类中并没有自动加上@JsonFormat，还需要人工处理比较麻烦。可以修改模板文件实现：

1、将源代码中的entity.java.ftl复制一份放到项目的resources/templates目录下

2、修改entity.java.ftl 文件，下面列出了主要的修改内容：

package ${package.Entity};

<#assign hasDateTime="0">
<#list table.importPackages as pkg>
import ${pkg};
    <#if pkg == "java.time.LocalDateTime"><#assign hasDateTime="1"></#if>
</#list>
<#if swagger>
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
</#if>
<#if hasDateTime == "1">
import com.fasterxml.jackson.annotation.JsonFormat;
</#if>

...

    <#-- 时间格式转换 -->
    <#if field.propertyType == "LocalDateTime" >
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
    </#if>
    private ${field.propertyType} ${field.propertyName};
</#list>
<#------------  END 字段循环遍历  ---------->

四、IDEA插件MyBatisX

idea安装插件mybatisx后可以方便Maper的java文件和xml文件之间互相调整和创建代码。

本文到此结束。