代码生成器Mybatis-Generator使用教程

原创已于 2023-03-07 16:07:35 修改 · 6.3k 阅读 ·

本内容遵循CC 4.0 BY-SA版权协议

收录于

SSM

代码可运行

于 2023-03-07 16:06:59 首次发布

文章介绍了Mybatis-Generator的多种运行方式，重点讲解了通过Java代码和XML配置文件以及通过Maven插件的运行方法。在使用Maven插件时，需要配置数据库驱动依赖以解决异常。XML配置文件是核心，控制代码生成行为，包括表的实体类、映射文件和DAO的生成。文章还详细列出了配置文件各元素的属性和作用。

引入插件

Mybatis-Generator的运行方式有很多种：

基于mybatis-generator-core-x.x.x.jar和其XML配置文件，通过命令行运行。

通过Ant的Task结合其XML配置文件运行。

通过Maven插件运行。

通过Java代码和其XML配置文件运行。

通过Java代码和编程式配置运行。

通过Eclipse Feature运行。

这里介绍方法3和方法4，这两个方法的共同点都是要提前配好XML配置文件。

通过编码和配置文件运行

通过编码方式去运行插件先需要引入mybatis-generator-core依赖，编写本文的时候最新的版本为：

<dependency>
     <groupId>org.mybatis.generator</groupId>
     <artifactId>mybatis-generator-core</artifactId>
     <version>1.3.2</version>
</dependency>

假设已经配置好XML文件，文件名是generatorConfig.xml，

代码生成器的编码：

public class TestGenerator {
    @Test
    public void Test1() throws XMLParserException, IOException {
        List<String> warnings = new ArrayList<>();
        // 如果已经存在生成过的文件是否进行覆盖
        boolean overwrite = true;
        File configFile = new File("F:\\My Project\\JAVA\\SSM\\SSMDemo\\src\\main\\resources\\generatorConfig.xml");
        ConfigurationParser cp = new ConfigurationParser(warnings);
        Configuration config = cp.parseConfiguration(configFile);
        DefaultShellCallback callback = new DefaultShellCallback(overwrite);
        MyBatisGenerator generator = null;
        try {
            generator = new MyBatisGenerator(config, callback, warnings);
        } catch (InvalidConfigurationException e) {
            e.printStackTrace();
        }
        try {
            generator.generate(null);
        } catch (SQLException e) {
            e.printStackTrace();
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

运行测试代码即可生成对应的表的实体类

通过Maven插件运行

如果使用Maven插件，那么不需要引入mybatis-generator-core依赖，只需要引入一个Maven的插件mybatis-generator-maven-plugin，将引入的插件写在pom.xml文件的build里

        <plugins>
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.2</version>
                <executions>
                    <execution>
                        <id>Generate MyBatis Artifacts</id>
                        <goals>
                            <goal>generate</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <!-- 输出详细信息 -->
                    <verbose>true</verbose>
                    <!-- 覆盖生成文件 -->
                    <overwrite>true</overwrite>
                    <!-- 定义配置文件 -->
                    <configurationFile>F:\My Project\JAVA\SSM\SSMDemo\src\main\resources\generatorConfig.xml</configurationFile>
                </configuration>
            </plugin>
        </plugins>

mybatis-generator-maven-plugin的更详细配置和可选参数可以参考：Running With Maven。插件配置完毕之后，使用下面的命令即可运行：

mvn mybatis-generator:generate

或者使用可视化界面的操作，在idea右边的maven栏里，双击运行即可：

此时，用插件运行我们发现一个报错

Execution default-cli of goal org.mybatis.generator:mybatis
-generator-maven-plugin:1.3.2:generate failed: Exception getting JDBC Driver: com.mysql.cj.jdbc.Driver

原因是需要在插件中加入数据库驱动jar包的依赖

                <dependencies>
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>8.0.30</version>
                    </dependency>
                </dependencies>

完整的插件引用代码：

   <build>
        <plugins>
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.2</version>
                <executions>
                    <execution>
                        <id>Generate MyBatis Artifacts</id>
                        <goals>
                            <goal>generate</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <!-- 输出详细信息 -->
                    <verbose>true</verbose>
                    <!-- 覆盖生成文件 -->
                    <overwrite>true</overwrite>
                    <!-- 定义配置文件 -->
                    <configurationFile>F:\My Project\JAVA\SSM\SSMDemo\src\main\resources\generatorConfig.xml</configurationFile>
                </configuration>
                <!--添加依赖，解决Exception getting JDBC Driver: com.mysql.cj.jdbc.Driver-->
                <dependencies>
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>8.0.30</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
</build>

XML配置文件详解

XML配置文件才是Mybatis-Generator的核心，它用于控制代码生成的所有行为。所有非标签独有的公共配置的Key可以在mybatis-generator-core的PropertyRegistry类中找到。下面是一个相对完整的配置文件的模板：

<?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="db.properties"/>-->

    <context id="springmvc" targetRuntime="MyBatis3"  >
        <plugin type="org.mybatis.generator.plugins.CaseInsensitiveLikePlugin"></plugin>
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"></plugin>
        <!-- Pagination -->

        <commentGenerator>
            <!-- 是否去除自动生成的注释 -->
            <property name="suppressAllComments" value="true"/>
            <!--是否生成注释代时间戳-->
            <property name="suppressDate" value="true"/>
        </commentGenerator>

        <!-- 数据库连接url、用户名、密码 -->
        <!--MySQL 5版本使用jdbc5驱动，驱动类使用：com.mysql.jdbc.Driver
        MySQL 8版本使用jdbc8驱动，驱动类使用：com.mysql.cj.jdbc.Driver-->
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/mybtistest" userId="root" password="000000">
        </jdbcConnection>

        <!--
        默认false，把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer
            true，把JDBC DECIMAL 和 NUMERIC 类型解析为java.math.BigDecimal
        -->
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>

        <!-- 生成模型的包名和位置 -->
        <!--
        生成model模型，对应的包路径，以及文件存放路径(targetProject)，targetProject可以指定具体的路径,如./src/main/java，
        也可以使用“MAVEN”来自动生成，这样生成的代码会在target/generatord-source目录下
        -->
        <javaModelGenerator targetPackage="com.mybatis.entity" targetProject="src\main\java">
            <!--是否在当前路径下增加一层schema,eg:false路径com.mybatis.entity,true路径com.mybatis.entity.[schema]-->
            <property name="enableSubPackages" value="true" />
            <!-- 从数据库返回的值被清理前后的空格  -->
            <property name="trimStrings" value="true" />
        </javaModelGenerator>

        <!-- 生成映射文件的包名和位置 -->
        <!--对应的mapper.xml文件  -->
        <sqlMapGenerator targetPackage="com.mybatis.mapper" targetProject="src\main\resources">
            <property name="enableSubPackages" value="true" />
        </sqlMapGenerator>

        <!-- 生成DAO的包名和位置 -->
        <!-- 对应的Mapper接口类文件 -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.mybatis.mapper" targetProject="src\main\java">
            <property name="enableSubPackages" value="true" />
        </javaClientGenerator>

        <!-- 要生成的表 tableName对应数据库中的表名、domainObjectName对应实体类名 -->
        <!--schema即为数据库名 tableName为对应的数据库表名 domainObjectName要生成的实体类 enableSelectByExample是否生成Example类-->
        <table tableName="t_user" domainObjectName="User">
            <!--是否使用列名作为实体类的属性名-->
            <!--<property name="useActualColumnNames" value="true"/>-->
            <!--在有自增ID的时候，在generatorConfig.xml中对表的配置，都要加上一行generatedKey,否则无法从
            当前这个Entity中获取到插入之后的Id-->
            <generatedKey column="id" sqlStatement="mysql" identity="true" />
        </table>

<!--        <table tableName="student" domainObjectName="StudentEntity"></table>-->

    </context>
</generatorConfiguration>

配置文件中，最外层的标签为<generatorConfiguration>，它的子标签包括：

0或者1个<properties>标签，用于指定全局配置文件，下面可以通过占位符的形式读取<properties>指定文件中的值。

0或者N个<classPathEntry>标签，<classPathEntry>只有一个location属性，用于指定数据源驱动包（jar或者zip）的绝对路径，具体选择什么驱动包取决于连接什么类型的数据源。

1或者N个<context>标签，用于运行时的解析模式和具体的代码生成行为，所以这个标签里面的配置是最重要的。

context标签

<context>标签在mybatis-generator-core中对应的实现类为org.mybatis.generator.config.Context，它除了大量的子标签配置之外，比较主要的属性是：id：Context示例的唯一ID，用于输出错误信息时候作为唯一标记。

id：Context示例的唯一ID，用于输出错误信息时候作为唯一标记。

targetRuntime：用于执行代码生成模式。

defaultModelType：控制Domain类的生成行为。执行引擎为MyBatis3DynamicSql或者MyBatis3Kotlin时忽略此配置，可选值：

conditional：默认值，类似hierarchical，但是只有一个主键的时候会合并所有属性生成在同一个类。

flat：所有内容全部生成在一个对象中。

hierarchical：键生成一个XXKey对象，Blob等单独生成一个对象，其他简单属性在一个对象中。

targetRuntime属性的可选值比较多，这里做个简单的小结：

<context>标签支持0或N个<property>标签，<property>的可选属性有：

plugin标签

<plugin>标签是<context>的子标签，用于引入一些插件对代码生成的一些特性进行扩展，该标签只包含一个type属性，用于指定org.mybatis.generator.api.Plugin接口的实现类。内置的插件实现见Supplied Plugins。例如：引入org.mybatis.generator.plugins.SerializablePlugin插件会让生成的实体类自动实现java.io.Serializable接口并且添加serialVersionUID属性。

commentGenerator标签

<commentGenerator>标签是可选的，用于控制生成的实体的注释内容。它在mybatis-generator-core中对应的实现类为org.mybatis.generator.internal.DefaultCommentGenerator，可以通过可选的type属性指定一个自定义的CommentGenerator实现。<commentGenerator>标签支持0或N个<property>标签，<property>的可选属性有：

jdbcConnection标签

<jdbcConnection>标签用于指定数据源的连接信息，它在mybatis-generator-core中对应的实现类为org.mybatis.generator.config.JDBCConnectionConfiguration，主要属性包括：

javaTypeResolver标签

<javaTypeResolver>标签是<context>的子标签，用于解析和计算数据库列类型和Java类型的映射关系，该标签只包含一个type属性，用于指定org.mybatis.generator.api.JavaTypeResolver接口的实现类。<javaTypeResolver>标签支持0或N个<property>标签，<property>的可选属性有：

如果useJSR310Types属性设置为true，那么生成代码的时候类型映射关系如下（主要针对日期时间类型）：

引入mybatis-generator-core后，可以查看JavaTypeResolver的默认实现为JavaTypeResolverDefaultImpl，从它的源码可以得知一些映射关系：

BIGINT --> Long
BIT --> Boolean
INTEGER --> Integer
SMALLINT --> Short
TINYINT --> Byte
......

有些时候，我们希望INTEGER、SMALLINT和TINYINT都映射为Integer，那么我们需要覆盖JavaTypeResolverDefaultImpl的构造方法：

public class DefaultJavaTypeResolver extends JavaTypeResolverDefaultImpl {
 
    public DefaultJavaTypeResolver() {
        super();
        typeMap.put(Types.SMALLINT, new JdbcTypeInformation("SMALLINT",
                new FullyQualifiedJavaType(Integer.class.getName())));
        typeMap.put(Types.TINYINT, new JdbcTypeInformation("TINYINT",
                new FullyQualifiedJavaType(Integer.class.getName())));
    }
}

javaModelGenerator标签

<javaModelGenerator标签>标签是<context>的子标签，主要用于控制实体（Model）类的代码生成行为。它支持的属性如下：

<javaModelGenerator标签>标签支持0或N个<property>标签，<property>的可选属性有：

sqlMapGenerator标签

<sqlMapGenerator>标签是<context>的子标签，主要用于控制XML映射文件的代码生成行为。它支持的属性如下：

<sqlMapGenerator>标签支持0或N个<property>标签，<property>的可选属性有：

javaClientGenerator标签

<javaClientGenerator>标签是<context>的子标签，主要用于控制Mapper接口的代码生成行为。它支持的属性如下：

type属性的可选值如下：

ANNOTATEDMAPPER：Mapper接口生成的时候依赖于注解和SqlProviders（也就是纯注解实现），不会生成XML映射文件。

XMLMAPPER：Mapper接口生成接口方法，对应的实现代码生成在XML映射文件中（也就是纯映射文件实现）。

MIXEDMAPPER：Mapper接口生成的时候复杂的方法实现生成在XML映射文件中，而简单的实现通过注解和SqlProviders实现（也就是注解和映射文件混合实现）。

注意两点：

<context>标签的targetRuntime属性指定为MyBatis3Simple的时候，type只能选用ANNOTATEDMAPPER或者XMLMAPPER。

<context>标签的targetRuntime属性指定为MyBatis3的时候，type可以选用ANNOTATEDMAPPER、XMLMAPPER或者MIXEDMAPPER。

<javaClientGenerator>标签支持0或N个<property>标签，<property>的可选属性有：

table标签

<table>标签是<context>的子标签，主要用于配置要生成代码的数据库表格，定制一些代码生成行为等等。它支持的属性众多，列举如下：

<table>标签支持0或N个<property>标签，<property>的可选属性有：

<table>标签还支持众多的非property的子标签：

0或1个<generatedKey>用于指定主键生成的规则，指定此标签后会生成一个<selectKey>标签：

<!-- column：指定主键列 -->
<!-- sqlStatement：查询主键的SQL语句，例如填写了MySql，则使用SELECT LAST_INSERT_ID() -->
<!-- type：可选值为pre或者post，pre指定selectKey标签的order为BEFORE，post指定selectKey标签的order为AFTER -->
<!-- identity：true的时候，指定selectKey标签的order为AFTER -->
<generatedKey column="id" sqlStatement="MySql" type="post" identity="true" />

0或1个<domainObjectRenamingRule>用于指定实体类重命名规则：

<!-- searchString中正则命中的实体类名部分会替换为replaceString -->
<domainObjectRenamingRule searchString="^Sys" replaceString=""/>
<!-- 例如 SysUser会变成User -->
<!-- 例如 SysUserMapper会变成UserMapper -->

0或1个<columnRenamingRule>用于指定列重命名规则：

<!-- searchString中正则命中的列名部分会替换为replaceString -->
<columnRenamingRule searchString="^CUST_" replaceString=""/>
<!-- 例如 CUST_BUSINESS_NAME会变成BUSINESS_NAME（useActualColumnNames=true） -->
<!-- 例如 CUST_BUSINESS_NAME会变成businessName（useActualColumnNames=false） -->

0或N个<columnOverride>用于指定具体列的覆盖映射规则：

<!-- column：指定要覆盖配置的列 -->
<!-- property：指定要覆盖配置的属性 -->
<!-- delimitedColumnName：是否为列名添加定界符，例如`{column}` -->
<!-- isGeneratedAlways：是否一定生成此列 -->
<columnOverride column="customer_name" property="customerName" javaType="" jdbcType="" typeHandler="" delimitedColumnName="" isGeneratedAlways="">
   <!-- 覆盖table或者javaModelGenerator级别的trimStrings属性配置 -->
   <property name="trimStrings" value="true"/>
<columnOverride/>

0或N个<ignoreColumn>用于指定忽略生成的列：

<ignoreColumn column="version" delimitedColumnName="false"/>

编程式自定义类型映射

前面提到过的数据类型的转换，都转换成integer

public class DefaultJavaTypeResolver extends JavaTypeResolverDefaultImpl {
 
    public DefaultJavaTypeResolver() {
        super();
        typeMap.put(Types.SMALLINT, new JdbcTypeInformation("SMALLINT",
                new FullyQualifiedJavaType(Integer.class.getName())));
        typeMap.put(Types.TINYINT, new JdbcTypeInformation("TINYINT",
                new FullyQualifiedJavaType(Integer.class.getName())));
    }
}

此时最好使用编程式运行代码生成器，不要使用maven插件，修改XML配置文件：

<javaTypeResolver type="club.throwable.mbg.DefaultJavaTypeResolver">
        <property name="forceBigDecimals" value="false"/>
</javaTypeResolver>
...

如果数据库的TINYINT类型，生成出来的文件中的字段全部替换使用Integer类型定义。

标签

#mybatis #java

分类开发工具