- 微信
- 微博
  
  分享文章到微博
- 复制链接
  
  复制链接到剪贴板

代码自动生成工具mybatis-generator根据表生成model、mapper、xml代码

object 发表于 2022/06/22 17:54:23 2022/06/22

【摘要】工具使用场景，之前在公司接触一个新项目，由于时间紧迫，需要快速搭建好一个web平台，数据库及功能模块都涉及好了，只需要快速编写代码即可，由于人员有限，新建一些必要的实体和增删改查浪费了大量时间。对于实体，普通的增删改查等能够直接快速生成，这样就能更多聚焦更多的时间到服务层，提高开发效率。该代码可直接作为工具使用，不需要集成到新项目。一、依赖组件 mybatis-generator-core...

工具使用场景，之前在公司接触一个新项目，由于时间紧迫，需要快速搭建好一个web平台，数据库及功能模块都涉及好了，只需要快速编写代码即可，由于人员有限，新建一些必要的实体和增删改查浪费了大量时间。对于实体，普通的增删改查等能够直接快速生成，这样就能更多聚焦更多的时间到服务层，提高开发效率。该代码可直接作为工具使用，不需要集成到新项目。

一、依赖组件 mybatis-generator-core

pom.xml文件如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.0</version>
        <relativePath/>
    </parent>
    <groupId>com.example</groupId>
    <artifactId>generator</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>generator</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper-spring-boot-starter</artifactId>
            <version>1.3.0</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.1.23</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.4.0</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.20</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

二、配置文件说明

generator.properties 和 generatorConfig.xml

generator.properties 存放数据库信息

jdbc.driverClass=com.mysql.cj.jdbc.Driver
jdbc.connectionURL=jdbc:mysql://localhost:3306/generator?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
jdbc.userId=root
jdbc.password=123456

generatorConfig.xml 配置就很多了，主要对代码生成做各种设置，如名字，位置，数据连接等

源代码如下：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
        PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
        "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

<generatorConfiguration>
    <properties resource="generator.properties"/>
<!--    一个数据连接-->
    <context id="MySqlContext" targetRuntime="MyBatis3" defaultModelType="flat">
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
        <property name="javaFileEncoding" value="UTF-8"/>
        <!-- 为模型生成序列化方法-->
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
        <!-- 为生成的Java模型创建一个toString方法 -->
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>
        <!--生成mapper.xml时覆盖原文件-->
        <plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin" />

        <commentGenerator type="com.example.generator.CommentGenerator">
            <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
            <property name="suppressAllComments" value="true"/>
            <property name="suppressDate" value="true"/>
            <property name="addRemarkComments" value="true"/>
        </commentGenerator>

        <jdbcConnection driverClass="${jdbc.driverClass}"
                        connectionURL="${jdbc.connectionURL}"
                        userId="${jdbc.userId}"
                        password="${jdbc.password}">
            <!--解决mysql驱动升级到8.0后不生成指定数据库代码的问题-->
            <property name="nullCatalogMeansCurrent" value="true" />
        </jdbcConnection>

        <!-- java代码生成位置       -->
        <javaModelGenerator targetPackage="com.example.generator.model" targetProject="generator\src\main\java"/>
        <!-- xml文件代码生成位置    -->
        <sqlMapGenerator targetPackage="mapper" targetProject="generator\src\main\resources"/>
        <!-- mapper接口代码生成位置    -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.example.generator.mapper"
                             targetProject="generator\src\main\java"/>

        <!--生成全部表tableName设为%-->
<!--        <table tableName="%">-->
<!--            <generatedKey column="id" sqlStatement="MySql" identity="true"/>-->
<!--        </table>-->
        <!--        不生成指定mapper函数 -->
        <table tableName="%" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false"
            enableSelectByExample="false" selectByExampleQueryId="false">
            <!-- 指定主键,新增数据后，返回主键，具体变化在xml中展示-->
<!--            <generatedKey column="id" sqlStatement="MySql" identity="true"/>-->
            <!-- 重新命名生成的表名 ,需要注意，开头必须大写才能匹配，否则会匹配不上          -->
<!--            <domainObjectRenamingRule searchString="^U" replaceString="b"/>-->
            <!-- 各种属性设置，有很多很多种，就不展开了，大多数都用不上，下面的意思是只生成model类-->
<!--            <property name="modelOnly" value="false"/>-->
            <!-- 重写列的名字和java类型-->
<!--            <columnOverride column="user_name" property="userName1" javaType="java.lang.Integer"/>-->
            <!-- 列名批量替换，跟上面略微不同，不需要大写开头-->
<!--            <columnRenamingRule searchString="^user" replaceString=""/>-->
            <!-- 隐藏指定列-->
<!--            <ignoreColumn column="user_name"/>-->
            <!-- 隐藏符合正则的列-->
<!--            <ignoreColumnsByRegex pattern="^user.+" />-->
        </table>

    </context>
</generatorConfiguration>

针对配置，可能涉及的几个配置：

plugin 标签

插件标签，生成代码时，提供额外的插件功能

<!-- 为模型生成序列化方法-->
<plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
<!-- 为生成的Java模型创建一个toString方法 -->
<plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>
<!--生成mapper.xml时覆盖原文件-->
<plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin" />

效果展示如下：

生成toString代码

除此以外，还有的插件...

org.mybatis.generator.plugins.CachePlugin 用来生成在XML中的<cache>元素

org.mybatis.generator.plugins.CaseInsensitiveLikePlugin 这个插件用来在XXXExample类中生成大小写敏感的LIKE方法

org.mybatis.generator.plugins.EqualsHashCodePlugin 用来给Java模型生成equals和hashcode方法

org.mybatis.generator.plugins.FluentBuilderMethodsPlugin 生成带有fluent风格的model代码

org.mybatis.generator.plugins.MapperConfigPlugin 可以用来帮助生成一个默认的MapperConfig.xml文件骨架

org.mybatis.generator.plugins.RenameExampleClassPlugin 使用正则表达式的方式来重命名生成的XXXExample类

org.mybatis.generator.plugins.RowBoundsPlugin 生成一个新的selectByExample方法

org.mybatis.generator.plugins.SerializablePlugin 生成的Java模型类添加序列化接口

org.mybatis.generator.plugins.SqlMapConfigPlugin 成一个SqlMapConfig文件，包含sqlMap条目所有生成的SQL映射

org.mybatis.generator.plugins.VirtualPrimaryKeyPlugin 用于指定充当主键的列，即使它们没有严格定义为数据库中的主键

等等...

commentGenerator 标签

自定义注释器，用于生成代码时，生成注释说明

<commentGenerator type="com.example.generator.CommentGenerator">
    <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
    <property name="suppressAllComments" value="true"/>
    <property name="suppressDate" value="true"/>
    <property name="addRemarkComments" value="true"/>
</commentGenerator>

type属性：指定默认注释类型配置器。默认的是org.mybatis.generator.internal.DefaultCommentGenerator

代码展示如下，注释代码自动生成：

里面可设置property标签，去除自动生成的注释，上面代码展示，value=true即视为隐藏注释

效果展示如下，自动生成的注释就没有了

如果需要自定义注释，例如，根据数据库的备注生成相应的注释，就需要重写type指定的注释生成器。重写代码如下：

public class CommentGenerator extends DefaultCommentGenerator {
    private boolean addRemarkComments = false;
    private static final String EXAMPLE_SUFFIX="Example";
    private static final String MAPPER_SUFFIX="BaseMapper";
    private static final String API_MODEL_PROPERTY_FULL_CLASS_NAME="io.swagger.annotations.ApiModelProperty";

    /**
     * 设置用户配置的参数
     */
    @Override
    public void addConfigurationProperties(Properties properties) {
        super.addConfigurationProperties(properties);
        this.addRemarkComments = StringUtility.isTrue(properties.getProperty("addRemarkComments"));
    }

    /**
     * 给字段添加注释
     */
    @Override
    public void addFieldComment(Field field, IntrospectedTable introspectedTable,
                                IntrospectedColumn introspectedColumn) {
        String remarks = introspectedColumn.getRemarks();
        //根据参数和备注信息判断是否添加备注信息
        if(addRemarkComments&&StringUtility.stringHasValue(remarks)){
            addFieldJavaDoc(field, remarks);
            //数据库中特殊字符需要转义
            if(remarks.contains("\"")){
                remarks = remarks.replace("\"","'");
            }
            //给model的字段添加swagger注解
            field.addJavaDocLine("@ApiModelProperty(value = \""+remarks+"\")");
        }
    }

    /**
     * 给model的字段添加注释
     */
    private void addFieldJavaDoc(Field field, String remarks) {
        //文档注释开始
        field.addJavaDocLine("/**");
        //获取数据库字段的备注信息
        String[] remarkLines = remarks.split(System.getProperty("line.separator"));
        for(String remarkLine:remarkLines){
            field.addJavaDocLine(" * "+remarkLine);
        }
        addJavadocTag(field, false);
        field.addJavaDocLine(" */");
    }

    @Override
    public void addJavaFileComment(CompilationUnit compilationUnit) {
        super.addJavaFileComment(compilationUnit);
        //只在model中添加swagger注解类的导入
        if(!compilationUnit.getType().getFullyQualifiedName().contains(MAPPER_SUFFIX)&&!compilationUnit.getType().getFullyQualifiedName().contains(EXAMPLE_SUFFIX)){
            compilationUnit.addImportedType(new FullyQualifiedJavaType(API_MODEL_PROPERTY_FULL_CLASS_NAME));
        }
    }
}

展示效果如下：自动新增了注释和@Api注解

位置定义标签

主要是定义生成的代码位置，分别对应model,mapper,xml

<!-- java代码生成位置       -->
<javaModelGenerator targetPackage="com.example.generator.model" targetProject="generator\src\main\java"/>
<!-- xml文件代码生成位置    -->
<sqlMapGenerator targetPackage="mapper" targetProject="generator\src\main\resources"/>
<!-- mapper接口代码生成位置    -->
<javaClientGenerator type="XMLMAPPER" targetPackage="com.example.generator.mapper"
                     targetProject="generator\src\main\java"/>

table标签

针对每个表做相应的设置，如指定表名，生成的默认函数，列名对应，主键设置，等等

table标签里面有很多属性，例如：enableCountByExample="false"，隐藏自动countbyexample函数，这个还是比较重要的，因为默认是生成了很多函数，会让代码看起来很杂，而且生成的方法不够安全，存在注入的风险，强烈不要求使用这些方法，都关闭掉。

未关闭生成多余的方法展示如下：

<table tableName="%">
    <generatedKey column="id" sqlStatement="MySql" identity="true"/>
</table>

底层代码逻辑就是利用实体，完成sql拼接，然后将拼接的sql直接放入条件，达到使用函数的方式实现sql拼接，由于使用了${},就需要对参数校验有很高的要求，否则容易出现sql注入风险。

解决办法：如果需要关闭也比较简单，只需要在table标签设置几个属性，自动生成的方法都设置了是否允许生成，只需要都设置为false即可。就可以取消了

<table tableName="%" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false"
            enableSelectByExample="false" selectByExampleQueryId="false">
</table>

最后是table内部标签，已经列举如下，就不一一展示效果。tableName="%"代表全部表，可以有多个table，对每个table单独设置

        <table tableName="%" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false"
            enableSelectByExample="false" selectByExampleQueryId="false">
            <!-- 指定主键,新增数据后，返回主键，具体变化在xml中展示-->
<!--            <generatedKey column="id" sqlStatement="MySql" identity="true"/>-->
            <!-- 重新命名生成的表名 ,需要注意，开头必须大写才能匹配，否则会匹配不上          -->
<!--            <domainObjectRenamingRule searchString="^U" replaceString="b"/>-->
            <!-- 各种属性设置，有很多很多种，就不展开了，大多数都用不上，下面的意思是只生成model类-->
<!--            <property name="modelOnly" value="false"/>-->
            <!-- 重写列的名字和java类型-->
<!--            <columnOverride column="user_name" property="userName1" javaType="java.lang.Integer"/>-->
            <!-- 列名批量替换，跟上面略微不同，不需要大写开头-->
<!--            <columnRenamingRule searchString="^user" replaceString=""/>-->
            <!-- 隐藏指定列-->
<!--            <ignoreColumn column="user_name"/>-->
            <!-- 隐藏符合正则的列-->
<!--            <ignoreColumnsByRegex pattern="^user.+" />-->
        </table>

主入口函数

主要将各个配置配置串联，输出警告消息，这也是能直接提取作为工具的原因。

代码展示如下：

public class GeneratorApplication {

    public static void main(String[] args) throws Exception {
        //MBG 执行过程中的警告信息
        List<String> warnings = new ArrayList<>();
        //当生成的代码重复时，覆盖原代码。 如果为false，则会生成新的文件，不删除旧文件
        boolean overwrite = true;
        //读取我们的 MBG 配置文件
        InputStream is = GeneratorApplication.class.getResourceAsStream("/generatorConfig.xml");
        ConfigurationParser cp = new ConfigurationParser(warnings);
        Configuration config = cp.parseConfiguration(is);
        is.close();

        DefaultShellCallback callback = new DefaultShellCallback(overwrite);
        //创建 MBG
        MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
        //执行生成代码
        myBatisGenerator.generate(null);
        //输出警告信息
        for (String warning : warnings) {
            System.out.println(warning);
        }
    }
}

做完这一步，只需要库中存在表，就可以直接点击主入口，启动，本地就会自动生成相应的表的model，mapper，xml。

最终展示效果如下：

拓展

自定义接口、变量、覆盖问题

仅针对除前期搭建项目，开发中途依旧使用该代码生成器维护代码的情况，如经常变更表结构的情况。或者一直大量表加入的情况。

由于每次生成的代码都会将旧生成的文件做删除并替换，这样自定义的代码就不会就会被删除。不利于开发，针对这种情况，参考了很多资料，有根据上文提到自动生成的注释来判断是否是自动生成代码，做追加操作，有重写代码生成器逻辑的方法，我觉得都不是特别靠谱，而且配置较为复杂，就我个人而言，觉得每次重新生成也能保证实体和表的一一对照性，我觉得也是可以的。

好的，直接说方法，就是继承。以生成的代码作为基础（base），再此基础上，继承自动生成的代码，这样就能保证新生成的会覆盖会覆盖自定义代码。

展示效果如下：

public class UserModel extends User {
    private String address;
}

public interface UserModelMapper extends UserMapper{
    String getAddress();
}

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.example.generator.mapper.UserModelMapper">

  <select id="getAddress" resultType="java.lang.String">
    select 
      <include refid="com.example.generator.mapper.UserMapper.Base_Column_List"/>
    from user
    where id = #{id,jdbcType=INTEGER}
  </select>

</mapper>

即使表有了更新，重新生成了新的代码，也不会影响到我们自己写的，当然有利有弊，这样的话，一个表就需要多维护一份持久层数据，对于一些简单表就显得多余

最后，自动代码生成有好有坏，适合的才是最好的。请合理选择。

第一次写了这么长的文档，感觉还是相当耗费精力的，主要是写的过程中，会遇到很多问题，特别是一些不是很重要的点，一个人的使用的话，可能就过了，但是想着要尽可能的写的详细，就需要收集更多的资料，学习更多的知识点，虽然只是很简单的一篇代码生成工具介绍，但是感觉整个文档写下来还是很疲惫的，不过最终动手的人才是最记忆深刻的人，算是收获满满，最后希望自己能继续坚持，每天进步一点点，君共勉。

点赞
收藏
关注作者

0/1000

抱歉，系统识别当前为高风险访问，暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称，即可参与社区互动！

*长度不超过10个汉字或20个英文字符，设置后3个月内不可修改。

确认取消

加入云驻计划，成为创作者

华为云周边好礼
免费体验产品
特殊身份标识
线下官方门票
内部专家零距离
与10000+优质创作者共同成长

立即加入

代码自动生成工具mybatis-generator根据表生成model、mapper、xml代码

一、依赖组件 mybatis-generator-core

二、配置文件说明

plugin 标签

commentGenerator 标签

位置定义标签

table标签

主入口函数

拓展

自定义接口、变量、覆盖问题

全部回复

设置昵称

关于作者

目录

加入云驻计划，成为创作者

代码自动生成工具mybatis-generator根据表生成model、mapper、xml代码

一、依赖组件 mybatis-generator-core

二、配置文件说明

plugin 标签

commentGenerator 标签

位置定义标签

table标签

主入口函数

拓展

自定义接口、变量、覆盖问题

全部回复

设置昵称

关于作者

目录

加入云驻计划，成为创作者

推荐阅读

相关产品