MyBatis代码生成器

亦凉 2022-11-24 14:27 246阅读 0赞

# 一：序言 #

mybatis代码生成器官网地址：[http://mybatis.org/generator/index.html][http_mybatis.org_generator_index.html]

> MyBatis 是一款优秀的持久层框架，它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解来配置和映射原生信息。

上面这一段话来自`Mybatis官网`的介绍, 初用Mybatis时感觉这个框架相比于JDBC优雅多了, 用起来也如官网说的非常简单。但是用了一段时间之后, 弊端就慢慢凸显出来了

使用Mybatis时不得不为每个表创建一个`Entity.java`、`Mapper.xml(Mapper可以融合入Dao中)`、`Dao.java`,`Service.java` 层次很清晰, 但是太多重复性的工作了, 费时间且易于出错，并且当数据库发生一点改动的时候... 苦不堪言

详情使用方法可以查看官网。这里总结一下主要使用过程

## 二：介绍使用方式 ##

对于MyBatis Generator运行方式，官网给出了如下几种

> MyBatis Generator (MBG) can be run in the following ways:
> 
>  *  From the [command prompt][] with an XML configuration
>  *  As an [Ant task][] with an XML configuration
>  *  As a [Maven Plugin][]
>  *  From another [Java program][] with an XML configuration
>  *  From another [Java program][] with a Java based configuration
>  *  As an [Eclipse Feature][]

*  基于`mybatis-generator-core-x.x.x.jar`和其`XML`配置文件，通过命令行运行。
 *  通过`Ant`的`Task`结合其`XML`配置文件运行。
 *  通过`Maven`插件运行。
 *  通过`Java`代码和其`XML`配置文件运行。
 *  通过`Java`代码和编程式配置运行。
 *  通过`Eclipse Feature`运行。

这里介绍两种：通过编码和配置文件运行+通过`Maven`插件运行

两种方式有个特点：都要提前编写好`XML`配置文件。个人感觉`XML`配置文件相对直观，后文会花大量篇幅去说明`XML`配置文件中的配置项及其作用。这里先注意一点：默认的配置文件为`ClassPath:generatorConfig.xml`。

## 1、通过编码和配置文件运行 ##

这里简单说下创建和使用过程，通过编码方式去运行插件先需要引入`mybatis-generator-core`依赖，编写本文的时候最新的版本为：1.4.0

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

假设编写好的`XML`配置文件是`ClassPath`下的`generator-configuration.xml`，那么使用代码生成器的编码方式大致如下

List<String> warnings = new ArrayList<>();
    // 如果已经存在生成过的文件是否进行覆盖
    boolean overwrite = true;
    File configFile = new File("ClassPath路径/generator-configuration.xml");
    ConfigurationParser cp = new ConfigurationParser(warnings);
    Configuration config = cp.parseConfiguration(configFile);
    DefaultShellCallback callback = new DefaultShellCallback(overwrite);
    MyBatisGenerator generator = new MyBatisGenerator(config, callback, warnings);
    generator.generate(null);

## 2、通过Maven插件+配置文件使用 ##

大多数开发人员可能选择这种方式

如果使用`Maven`插件，那么**不需要**引入`mybatis-generator-core`依赖，在自己ssm项目或者springboot项目或者自己独立得maven项目只需要引入一个`Maven`的插件`mybatis-generator-maven-plugin`：

<plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.4.0</version>
                <executions>
                    <execution>
                        <id>Generate MyBatis Artifacts</id>
                        <goals>
                            <goal>generate</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    
                    <verbose>true</verbose>
                    
                    <overwrite>true</overwrite>
                    
                    <configurationFile>${basedir}/src/main/resources/generator-configuration.xml</configurationFile>
                </configuration>
            </plugin>

配置文件（案例配置）

<?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>
        
        <classPathEntry
                location="E:\tool\mysql-connector-java-5.1.49.jar"/>
        <context id="default" targetRuntime="MyBatis3">
            <property name="javaFileEncoding" value="UTF-8"/>
            
            <commentGenerator>
                <property name="suppressDate" value="true"/>
                <property name="suppressAllComments" value="true"/>
            </commentGenerator>
    
            <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                            connectionURL="jdbc:mysql://localhost:3306/demo"
                            userId="root"
                            password="root">
            </jdbcConnection>
    
            
            <javaTypeResolver>
                <property name="forceBigDecimals" value="false"/>
            </javaTypeResolver>
            <javaModelGenerator targetPackage="com.sysconfig.pojo.po" targetProject="src/main/java">
                <property name="enableSubPackages" value="true"/>
            </javaModelGenerator>
            <sqlMapGenerator targetPackage="mapper.sysconfig" targetProject="src/main/resources">
                <property name="enableSubPackages" value="true"/>
            </sqlMapGenerator>
            <javaClientGenerator type="XMLMAPPER" targetPackage="com.sysconfig.dao" targetProject="src/main/java">
                <property name="enableSubPackages" value="true"/>
            </javaClientGenerator>
    
            <table tableName="sys_config"
                   enableCountByExample="false"
                   enableDeleteByExample="false"
                   enableSelectByExample="false"
                   enableUpdateByExample="false"
                   domainObjectName="SysConfig"
                   mapperName="SysConfigMapper">
                <generatedKey column="id" sqlStatement="MySql"/>
            </table>
        </context>
    </generatorConfiguration>

插件配置完毕之后，使用下面的命令即可运行：

> `mvn mybatis-generator:generate`

或者在开发工具，这里用得idea。直接maven projects按钮，弹窗里选择

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NDkxNTA4_size_16_color_FFFFFF_t_70][]

`mybatis-generator-maven-plugin`的更详细配置和可选参数可以参考：

[http://mybatis.org/generator/running/runningWithMaven.html][Maven Plugin]

# 三：配置文件详解 #

`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"/>
    
      <classPathEntry location="/Program Files/IBM/SQLLIB/java/db2java.zip" />
    
      <context id="DB2Tables" targetRuntime="MyBatis3">
    
        <jdbcConnection driverClass="COM.ibm.db2.jdbc.app.DB2Driver"
            connectionURL="jdbc:db2:TEST"
            userId="db2admin"
            password="db2admin">
        </jdbcConnection>
    
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
    
        <commentGenerator>
            <property name="suppressDate" value="true"/>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
    
        <javaTypeResolver>
          <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>
    
        <javaModelGenerator targetPackage="test.model" targetProject="\MBGTestProject\src">
          <property name="enableSubPackages" value="true" />
          <property name="trimStrings" value="true" />
        </javaModelGenerator>
    
        <sqlMapGenerator targetPackage="test.xml"  targetProject="\MBGTestProject\src">
          <property name="enableSubPackages" value="true" />
        </sqlMapGenerator>
    
        <javaClientGenerator type="XMLMAPPER" targetPackage="test.dao"  targetProject="\MBGTestProject\src">
          <property name="enableSubPackages" value="true" />
        </javaClientGenerator>
    
        <table schema="DB2ADMIN" tableName="ALLTYPES" domainObjectName="Customer" >
          <property name="useActualColumnNames" value="true"/>
          <generatedKey column="ID" sqlStatement="DB2" identity="true" />
          <columnOverride column="DATE_FIELD" property="startDate" />
          <ignoreColumn column="FRED" />
          <columnOverride column="LONG_VARCHAR_FIELD" jdbcType="VARCHAR" />
        </table>
    
      </context>
    </generatorConfiguration>

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

*  0或者1个`<properties>`标签，用于指定全局配置文件，下面可以通过占位符的形式读取`<properties>`指定文件中的值。
 *  0或者N个`<classPathEntry>`标签，`<classPathEntry>`只有一个`location`属性，用于指定数据源驱动包（`jar`或者`zip`）的绝对路径，具体选择什么驱动包取决于连接什么类型的数据源。
 *  1或者N个`<context>`标签，用于运行时的解析模式和具体的代码生成行为，所以这个标签里面的配置是最重要的。

下面分别列举和分析一下`<context>`标签和它的主要子标签的一些属性配置和功能。

### context标签 ###

`<context>`标签在`mybatis-generator-core`中对应的实现类为`org.mybatis.generator.config.Context`，它除了大量的子标签配置之外，比较主要的属性是：

*  `id`：`Context`示例的唯一`ID`，用于输出错误信息时候作为唯一标记。
 *  `targetRuntime`：用于执行代码生成模式。
 *  `defaultModelType`：控制`Domain`类的生成行为。执行引擎为`MyBatis3DynamicSql`或者`MyBatis3Kotlin`时忽略此配置，可选值：
    
     *  `conditional`：默认值，类似`hierarchical`，但是只有一个主键的时候会合并所有属性生成在同一个类。
     *  `flat`：所有内容全部生成在一个对象中。
     *  `hierarchical`：键生成一个XXKey对象，Blob等单独生成一个对象，其他简单属性在一个对象中。

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

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>功能描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>MyBatis3DynamicSql</code></td> 
   <td>默认值，兼容<code>JDK8+</code>和<code>MyBatis 3.4.2+</code>，不会生成<code>XML</code>映射文件，忽略<code>&lt;sqlMapGenerator&gt;</code>的配置项，也就是<code>Mapper</code>全部注解化，依赖于<code>MyBatis Dynamic SQL</code>类库</td> 
  </tr> 
  <tr> 
   <td><code>MyBatis3Kotlin</code></td> 
   <td>行为类似于<code>MyBatis3DynamicSql</code>，不过兼容<code>Kotlin</code>的代码生成</td> 
  </tr> 
  <tr> 
   <td><code>MyBatis3</code></td> 
   <td>提供基本的基于动态<code>SQL</code>的<code>CRUD</code>方法和<code>XXXByExample</code>方法，会生成<code>XML</code>映射文件</td> 
  </tr> 
  <tr> 
   <td><code>MyBatis3Simple</code></td> 
   <td>提供基本的基于动态<code>SQL</code>的<code>CRUD</code>方法，会生成<code>XML</code>映射文件</td> 
  </tr> 
  <tr> 
   <td><code>MyBatis3DynamicSqlV1</code></td> 
   <td>已经过时，不推荐使用</td> 
  </tr> 
 </tbody> 
</table>

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

<table> 
 <thead> 
  <tr> 
   <th>property属性</th> 
   <th>功能描述</th> 
   <th>默认值</th> 
   <th>备注</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>autoDelimitKeywords</code></td> 
   <td>是否使用分隔符号括住数据库关键字</td> 
   <td><code>false</code></td> 
   <td>例如<code>MySQL</code>中会使用反引号括住关键字</td> 
  </tr> 
  <tr> 
   <td><code>beginningDelimiter</code></td> 
   <td>分隔符号的开始符号</td> 
   <td><code>"</code></td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td><code>endingDelimiter</code></td> 
   <td>分隔符号的结束号</td> 
   <td><code>"</code></td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td><code>javaFileEncoding</code></td> 
   <td>文件的编码</td> 
   <td><code>系统默认值</code></td> 
   <td>来源于<code>java.nio.charset.Charset</code></td> 
  </tr> 
  <tr> 
   <td><code>javaFormatter</code></td> 
   <td>类名和文件格式化器</td> 
   <td><code>DefaultJavaFormatter</code></td> 
   <td>见<code>JavaFormatter</code>和<code>DefaultJavaFormatter</code></td> 
  </tr> 
  <tr> 
   <td><code>targetJava8</code></td> 
   <td>是否JDK8和启动其特性</td> 
   <td><code>true</code></td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td><code>kotlinFileEncoding</code></td> 
   <td><code>Kotlin</code>文件编码</td> 
   <td><code>系统默认值</code></td> 
   <td>来源于<code>java.nio.charset.Charset</code></td> 
  </tr> 
  <tr> 
   <td><code>kotlinFormatter</code></td> 
   <td><code>Kotlin</code>类名和文件格式化器</td> 
   <td><code>DefaultKotlinFormatter</code></td> 
   <td>见<code>KotlinFormatter</code>和<code>DefaultKotlinFormatter</code></td> 
  </tr> 
  <tr> 
   <td><code>xmlFormatter</code></td> 
   <td><code>XML</code>文件格式化器</td> 
   <td><code>DefaultXmlFormatter</code></td> 
   <td>见<code>XmlFormatter</code>和<code>DefaultXmlFormatter</code></td> 
  </tr> 
 </tbody> 
</table>

### jdbcConnection标签 ###

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

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>功能描述</th> 
   <th>是否必须</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>driverClass</code></td> 
   <td>数据源驱动的全类名</td> 
   <td><code>Y</code></td> 
  </tr> 
  <tr> 
   <td><code>connectionURL</code></td> 
   <td><code>JDBC</code>的连接<code>URL</code></td> 
   <td><code>Y</code></td> 
  </tr> 
  <tr> 
   <td><code>userId</code></td> 
   <td>连接到数据源的用户名</td> 
   <td><code>N</code></td> 
  </tr> 
  <tr> 
   <td><code>password</code></td> 
   <td>连接到数据源的密码</td> 
   <td><code>N</code></td> 
  </tr> 
 </tbody> 
</table>

### commentGenerator标签 ###

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

<table> 
 <thead> 
  <tr> 
   <th>property属性</th> 
   <th>功能描述</th> 
   <th>默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>suppressAllComments</code></td> 
   <td>是否生成注释</td> 
   <td><code>false</code></td> 
  </tr> 
  <tr> 
   <td><code>suppressDate</code></td> 
   <td>是否在注释中添加生成的时间戳</td> 
   <td><code>false</code></td> 
  </tr> 
  <tr> 
   <td><code>dateFormat</code></td> 
   <td>配合<code>suppressDate</code>使用，指定输出时间戳的格式</td> 
   <td><code>java.util.Date#toString()</code></td> 
  </tr> 
  <tr> 
   <td><code>addRemarkComments</code></td> 
   <td>是否输出表和列的<code>Comment</code>信息</td> 
   <td><code>false</code></td> 
  </tr> 
 </tbody> 
</table>

建议保持默认值，也就是什么注释都不输出，生成代码干净的实体。

### javaTypeResolver标签 ###

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

<table> 
 <thead> 
  <tr> 
   <th>property属性</th> 
   <th>功能描述</th> 
   <th>默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>forceBigDecimals</code></td> 
   <td>是否强制把所有的数字类型强制使用<code>java.math.BigDecimal</code>类型表示</td> 
   <td><code>false</code></td> 
  </tr> 
  <tr> 
   <td><code>useJSR310Types</code></td> 
   <td>是否支持<code>JSR310</code>，主要是<code>JSR310</code>的新日期类型</td> 
   <td><code>false</code></td> 
  </tr> 
 </tbody> 
</table>

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

<table> 
 <thead> 
  <tr> 
   <th>数据库（JDBC）类型</th> 
   <th>Java类型</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>DATE</code></td> 
   <td><code>java.time.LocalDate</code></td> 
  </tr> 
  <tr> 
   <td><code>TIME</code></td> 
   <td><code>java.time.LocalTime</code></td> 
  </tr> 
  <tr> 
   <td><code>TIMESTAMP</code></td> 
   <td><code>java.time.LocalDateTime</code></td> 
  </tr> 
  <tr> 
   <td><code>TIME_WITH_TIMEZONE</code></td> 
   <td><code>java.time.OffsetTime</code></td> 
  </tr> 
  <tr> 
   <td><code>TIMESTAMP_WITH_TIMEZONE</code></td> 
   <td><code>java.time.OffsetDateTime</code></td> 
  </tr> 
 </tbody> 
</table>

引入`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())));
        }
    }

注意一点的是这种自定义实现`JavaTypeResolver`接口的方式使用编程式运行`MBG`会相对方便，如果需要使用`Maven`插件运行，那么需要把上面的`DefaultJavaTypeResolver`类打包到插件中。

### javaModelGenerator标签 ###

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

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>功能描述</th> 
   <th>是否必须</th> 
   <th>备注</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>targetPackage</code></td> 
   <td>生成的实体类的包名</td> 
   <td><code>Y</code></td> 
   <td>例如<code>club.throwable.model</code></td> 
  </tr> 
  <tr> 
   <td><code>targetProject</code></td> 
   <td>生成的实体类文件相对于项目（根目录）的位置</td> 
   <td><code>Y</code></td> 
   <td>例如<code>src/main/java</code></td> 
  </tr> 
 </tbody> 
</table>

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

<table> 
 <thead> 
  <tr> 
   <th>property属性</th> 
   <th>功能描述</th> 
   <th>默认值</th> 
   <th>备注</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>constructorBased</code></td> 
   <td>是否生成一个带有所有字段属性的构造函数</td> 
   <td><code>false</code></td> 
   <td><code>MyBatis3Kotlin</code>模式下忽略此属性配置</td> 
  </tr> 
  <tr> 
   <td><code>enableSubPackages</code></td> 
   <td>是否允许通过<code>Schema</code>生成子包</td> 
   <td><code>false</code></td> 
   <td>如果为<code>true</code>，例如包名为<code>club.throwable</code>，如果<code>Schema</code>为<code>xyz</code>，那么实体类文件最终会生成在<code>club.throwable.xyz</code>目录</td> 
  </tr> 
  <tr> 
   <td><code>exampleTargetPackage</code></td> 
   <td>生成的伴随实体类的<code>Example</code>类的包名</td> 
   <td>-</td> 
   <td>-</td> 
  </tr> 
  <tr> 
   <td><code>exampleTargetProject</code></td> 
   <td>生成的伴随实体类的<code>Example</code>类文件相对于项目（根目录）的位置</td> 
   <td>-</td> 
   <td>-</td> 
  </tr> 
  <tr> 
   <td><code>immutable</code></td> 
   <td>是否不可变</td> 
   <td><code>false</code></td> 
   <td>如果为<code>true</code>，则不会生成<code>Setter</code>方法，所有字段都使用<code>final</code>修饰，提供一个带有所有字段属性的构造函数</td> 
  </tr> 
  <tr> 
   <td><code>rootClass</code></td> 
   <td>为生成的实体类添加父类</td> 
   <td>-</td> 
   <td>通过<code>value</code>指定父类的全类名即可</td> 
  </tr> 
  <tr> 
   <td><code>trimStrings</code></td> 
   <td><code>Setter</code>方法是否对字符串类型进行一次<code>trim</code>操作</td> 
   <td><code>false</code></td> 
   <td>-</td> 
  </tr> 
 </tbody> 
</table>

### javaClientGenerator标签 ###

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

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>功能描述</th> 
   <th>是否必须</th> 
   <th>备注</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>type</code></td> 
   <td><code>Mapper</code>接口生成策略</td> 
   <td><code>Y</code></td> 
   <td><code>&lt;context&gt;</code>标签的<code>targetRuntime</code>属性为<code>MyBatis3DynamicSql</code>或者<code>MyBatis3Kotlin</code>时此属性配置忽略</td> 
  </tr> 
  <tr> 
   <td><code>targetPackage</code></td> 
   <td>生成的<code>Mapper</code>接口的包名</td> 
   <td><code>Y</code></td> 
   <td>例如<code>club.throwable.mapper</code></td> 
  </tr> 
  <tr> 
   <td><code>targetProject</code></td> 
   <td>生成的<code>Mapper</code>接口文件相对于项目（根目录）的位置</td> 
   <td><code>Y</code></td> 
   <td>例如<code>src/main/java</code></td> 
  </tr> 
 </tbody> 
</table>

`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> 
 <thead> 
  <tr> 
   <th>property属性</th> 
   <th>功能描述</th> 
   <th>默认值</th> 
   <th>备注</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>enableSubPackages</code></td> 
   <td>是否允许通过<code>Schema</code>生成子包</td> 
   <td><code>false</code></td> 
   <td>如果为<code>true</code>，例如包名为<code>club.throwable</code>，如果<code>Schema</code>为<code>xyz</code>，那么<code>Mapper</code>接口文件最终会生成在<code>club.throwable.xyz</code>目录</td> 
  </tr> 
  <tr> 
   <td><code>useLegacyBuilder</code></td> 
   <td>是否通过<code>SQL Builder</code>生成动态<code>SQL</code></td> 
   <td><code>false</code></td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td><code>rootInterface</code></td> 
   <td>为生成的<code>Mapper</code>接口添加父接口</td> 
   <td>-</td> 
   <td>通过<code>value</code>指定父接口的全类名即可</td> 
  </tr> 
 </tbody> 
</table>

### sqlMapGenerator标签 ###

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

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>功能描述</th> 
   <th>是否必须</th> 
   <th>备注</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>targetPackage</code></td> 
   <td>生成的<code>XML</code>映射文件的包名</td> 
   <td><code>Y</code></td> 
   <td>例如<code>mappings</code></td> 
  </tr> 
  <tr> 
   <td><code>targetProject</code></td> 
   <td>生成的<code>XML</code>映射文件相对于项目（根目录）的位置</td> 
   <td><code>Y</code></td> 
   <td>例如<code>src/main/resources</code></td> 
  </tr> 
 </tbody> 
</table>

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

### plugin标签 ###

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

### table标签 ###

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

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>功能描述</th> 
   <th>是否必须</th> 
   <th>备注</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>tableName</code></td> 
   <td>数据库表名称</td> 
   <td><code>Y</code></td> 
   <td>例如<code>t_order</code></td> 
  </tr> 
  <tr> 
   <td><code>schema</code></td> 
   <td>数据库<code>Schema</code></td> 
   <td><code>N</code></td> 
   <td>-</td> 
  </tr> 
  <tr> 
   <td><code>catalog</code></td> 
   <td>数据库<code>Catalog</code></td> 
   <td><code>N</code></td> 
   <td>-</td> 
  </tr> 
  <tr> 
   <td><code>alias</code></td> 
   <td>表名称标签</td> 
   <td><code>N</code></td> 
   <td>如果指定了此值，则查询列的时候结果格式为<code>alias_column</code></td> 
  </tr> 
  <tr> 
   <td><code>domainObjectName</code></td> 
   <td>表对应的实体类名称，可以通过<code>.</code>指定包路径</td> 
   <td><code>N</code></td> 
   <td>如果指定了<code>bar.User</code>，则包名为<code>bar</code>，实体类名称为<code>User</code></td> 
  </tr> 
  <tr> 
   <td><code>mapperName</code></td> 
   <td>表对应的<code>Mapper</code>接口类名称，可以通过<code>.</code>指定包路径</td> 
   <td><code>N</code></td> 
   <td>如果指定了<code>bar.UserMapper</code>，则包名为<code>bar</code>，<code>Mapper</code>接口类名称为<code>UserMapper</code></td> 
  </tr> 
  <tr> 
   <td><code>sqlProviderName</code></td> 
   <td>动态<code>SQL</code>提供类<code>SqlProvider</code>的类名称</td> 
   <td><code>N</code></td> 
   <td>-</td> 
  </tr> 
  <tr> 
   <td><code>enableInsert</code></td> 
   <td>是否允许生成<code>insert</code>方法</td> 
   <td><code>N</code></td> 
   <td>默认值为<code>true</code>，执行引擎为<code>MyBatis3DynamicSql</code>或者<code>MyBatis3Kotlin</code>时忽略此配置</td> 
  </tr> 
  <tr> 
   <td><code>enableSelectByPrimaryKey</code></td> 
   <td>是否允许生成<code>selectByPrimaryKey</code>方法</td> 
   <td><code>N</code></td> 
   <td>默认值为<code>true</code>，执行引擎为<code>MyBatis3DynamicSql</code>或者<code>MyBatis3Kotlin</code>时忽略此配置</td> 
  </tr> 
  <tr> 
   <td><code>enableSelectByExample</code></td> 
   <td>是否允许生成<code>selectByExample</code>方法</td> 
   <td><code>N</code></td> 
   <td>默认值为<code>true</code>，执行引擎为<code>MyBatis3DynamicSql</code>或者<code>MyBatis3Kotlin</code>时忽略此配置</td> 
  </tr> 
  <tr> 
   <td><code>enableUpdateByPrimaryKey</code></td> 
   <td>是否允许生成<code>updateByPrimaryKey</code>方法</td> 
   <td><code>N</code></td> 
   <td>默认值为<code>true</code>，执行引擎为<code>MyBatis3DynamicSql</code>或者<code>MyBatis3Kotlin</code>时忽略此配置</td> 
  </tr> 
  <tr> 
   <td><code>enableDeleteByPrimaryKey</code></td> 
   <td>是否允许生成<code>deleteByPrimaryKey</code>方法</td> 
   <td><code>N</code></td> 
   <td>默认值为<code>true</code>，执行引擎为<code>MyBatis3DynamicSql</code>或者<code>MyBatis3Kotlin</code>时忽略此配置</td> 
  </tr> 
  <tr> 
   <td><code>enableDeleteByExample</code></td> 
   <td>是否允许生成<code>deleteByExample</code>方法</td> 
   <td><code>N</code></td> 
   <td>默认值为<code>true</code>，执行引擎为<code>MyBatis3DynamicSql</code>或者<code>MyBatis3Kotlin</code>时忽略此配置</td> 
  </tr> 
  <tr> 
   <td><code>enableCountByExample</code></td> 
   <td>是否允许生成<code>countByExample</code>方法</td> 
   <td><code>N</code></td> 
   <td>默认值为<code>true</code>，执行引擎为<code>MyBatis3DynamicSql</code>或者<code>MyBatis3Kotlin</code>时忽略此配置</td> 
  </tr> 
  <tr> 
   <td><code>enableUpdateByExample</code></td> 
   <td>是否允许生成<code>updateByExample</code>方法</td> 
   <td><code>N</code></td> 
   <td>默认值为<code>true</code>，执行引擎为<code>MyBatis3DynamicSql</code>或者<code>MyBatis3Kotlin</code>时忽略此配置</td> 
  </tr> 
  <tr> 
   <td><code>selectByPrimaryKeyQueryId</code></td> 
   <td><code>value</code>指定对应的主键列提供列表查询功能</td> 
   <td><code>N</code></td> 
   <td>执行引擎为<code>MyBatis3DynamicSql</code>或者<code>MyBatis3Kotlin</code>时忽略此配置</td> 
  </tr> 
  <tr> 
   <td><code>selectByExampleQueryId</code></td> 
   <td><code>value</code>指定对应的查询<code>ID</code>提供列表查询功能</td> 
   <td><code>N</code></td> 
   <td>执行引擎为<code>MyBatis3DynamicSql</code>或者<code>MyBatis3Kotlin</code>时忽略此配置</td> 
  </tr> 
  <tr> 
   <td><code>modelType</code></td> 
   <td>覆盖<code>&lt;context&gt;</code>的<code>defaultModelType</code>属性</td> 
   <td><code>N</code></td> 
   <td>见<code>&lt;context&gt;</code>的<code>defaultModelType</code>属性</td> 
  </tr> 
  <tr> 
   <td><code>escapeWildcards</code></td> 
   <td>是否对通配符进行转义</td> 
   <td><code>N</code></td> 
   <td>-</td> 
  </tr> 
  <tr> 
   <td><code>delimitIdentifiers</code></td> 
   <td>标记匹配表名称的时候是否需要使用分隔符去标记生成的SQL</td> 
   <td><code>N</code></td> 
   <td>-</td> 
  </tr> 
  <tr> 
   <td><code>delimitAllColumns</code></td> 
   <td>是否所有的列都添加分隔符</td> 
   <td><code>N</code></td> 
   <td>默认值为<code>false</code>，如果设置为<code>true</code>，所有列名会添加起始和结束分隔符</td> 
  </tr> 
 </tbody> 
</table>

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

<table> 
 <thead> 
  <tr> 
   <th>property属性</th> 
   <th>功能描述</th> 
   <th>默认值</th> 
   <th>备注</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>constructorBased</code></td> 
   <td>是否为实体类生成一个带有所有字段的构造函数</td> 
   <td><code>false</code></td> 
   <td>执行引擎为<code>MyBatis3Kotlin</code>的时候此属性忽略</td> 
  </tr> 
  <tr> 
   <td><code>ignoreQualifiersAtRuntime</code></td> 
   <td>是否在运行时忽略别名</td> 
   <td><code>false</code></td> 
   <td>如果为<code>true</code>，则不会在生成表的时候把<code>schema</code>和<code>catalog</code>作为表的前缀</td> 
  </tr> 
  <tr> 
   <td><code>immutable</code></td> 
   <td>实体类是否不可变</td> 
   <td><code>false</code></td> 
   <td>执行引擎为<code>MyBatis3Kotlin</code>的时候此属性忽略</td> 
  </tr> 
  <tr> 
   <td><code>modelOnly</code></td> 
   <td>是否仅仅生成实体类</td> 
   <td><code>false</code></td> 
   <td>-</td> 
  </tr> 
  <tr> 
   <td><code>rootClass</code></td> 
   <td>如果配置此属性，则实体类会继承此指定的超类</td> 
   <td><code>-</code></td> 
   <td>如果有主键属性会把主键属性在超类生成</td> 
  </tr> 
  <tr> 
   <td><code>rootInterface</code></td> 
   <td>如果配置此属性，则实体类会实现此指定的接口</td> 
   <td><code>-</code></td> 
   <td>执行引擎为<code>MyBatis3Kotlin</code>或者<code>MyBatis3DynamicSql</code>的时候此属性忽略</td> 
  </tr> 
  <tr> 
   <td><code>runtimeCatalog</code></td> 
   <td>指定运行时的<code>Catalog</code></td> 
   <td><code>-</code></td> 
   <td>当生成表和运行时的表的<code>Catalog</code>不一样的时候可以使用该属性进行配置</td> 
  </tr> 
  <tr> 
   <td><code>runtimeSchema</code></td> 
   <td>指定运行时的<code>Schema</code></td> 
   <td><code>-</code></td> 
   <td>当生成表和运行时的表的<code>Schema</code>不一样的时候可以使用该属性进行配置</td> 
  </tr> 
  <tr> 
   <td><code>runtimeTableName</code></td> 
   <td>指定运行时的表名称</td> 
   <td><code>-</code></td> 
   <td>当生成表和运行时的表的表名称不一样的时候可以使用该属性进行配置</td> 
  </tr> 
  <tr> 
   <td><code>selectAllOrderByClause</code></td> 
   <td>指定字句内容添加到<code>selectAll()</code>方法的<code>order by</code>子句之中</td> 
   <td><code>-</code></td> 
   <td>执行引擎为<code>MyBatis3Simple</code>的时候此属性才适用</td> 
  </tr> 
  <tr> 
   <td><code>trimStrings</code></td> 
   <td>实体类的字符串类型属性会做<code>trim</code>处理</td> 
   <td><code>-</code></td> 
   <td>执行引擎为<code>MyBatis3Kotlin</code>的时候此属性忽略</td> 
  </tr> 
  <tr> 
   <td><code>useActualColumnNames</code></td> 
   <td>是否使用列名作为实体类的属性名</td> 
   <td><code>false</code></td> 
   <td>-</td> 
  </tr> 
  <tr> 
   <td><code>useColumnIndexes</code></td> 
   <td><code>XML</code>映射文件中生成的<code>ResultMap</code>使用列索引定义而不是列名称</td> 
   <td><code>false</code></td> 
   <td>执行引擎为<code>MyBatis3Kotlin</code>或者<code>MyBatis3DynamicSql</code>的时候此属性忽略</td> 
  </tr> 
  <tr> 
   <td><code>useCompoundPropertyNames</code></td> 
   <td>是否把列名和列备注拼接起来生成实体类属性名</td> 
   <td><code>false</code></td> 
   <td>-</td> 
  </tr> 
 </tbody> 
</table>

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

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

<generatedKey column="id" sqlStatement="MySql" type="post" identity="true" />

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

<domainObjectRenamingRule searchString="^Sys" replaceString=""/>

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

<columnRenamingRule searchString="^CUST_" replaceString=""/>

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

<columnOverride column="customer_name" property="customerName" javaType="" jdbcType="" typeHandler="" delimitedColumnName="" isGeneratedAlways="">
       
       <property name="trimStrings" value="true"/>
    <columnOverride/>

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

# 四: 编程式自定义类型映射 #

如果把所有得非长整型的数字，统一使用`Integer`接收，因此需要自定义类型映射。编写映射器如下：

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

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

运行方法代码如下：

public class Main {
    
        public static void main(String[] args) throws Exception {
            List<String> warnings = new ArrayList<>();
            // 如果已经存在生成过的文件是否进行覆盖
            boolean overwrite = true;
            ConfigurationParser cp = new ConfigurationParser(warnings);
            Configuration config = cp.parseConfiguration(Main.class.getResourceAsStream("/generator-configuration.xml"));
            DefaultShellCallback callback = new DefaultShellCallback(overwrite);
            MyBatisGenerator generator = new MyBatisGenerator(config, callback, warnings);
            generator.generate(null);
        }
    }

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

## 小结[\#][Link 1] ##

本文相对详尽地介绍了`Mybatis Generator`的使用方式，具体分析了`XML`配置文件中主要标签以及标签属性的功能。因为`Mybatis`在`Java`的`ORM`框架体系中还会有一段很长的时间处于主流地位，了解`Mybatis Generator`可以简化`CRUD`方法模板代码、实体以及`Mapper`接口代码生成，从而解放大量生产力。`Mybatis Generator`有不少第三方的扩展，例如`tk.mapper`或者`mybatis-plus`自身的扩展，可能附加的功能不一样，但是基本的使用是一致的。

参考地址：[https://www.cnblogs.com/throwable/p/12046848.html\#%E5%B0%8F%E7%BB%93][Link 1]

[http_mybatis.org_generator_index.html]: http://mybatis.org/generator/index.html
[command prompt]: http://mybatis.org/generator/running/runningFromCmdLine.html
[Ant task]: http://mybatis.org/generator/running/runningWithAnt.html
[Maven Plugin]: http://mybatis.org/generator/running/runningWithMaven.html
[Java program]: http://mybatis.org/generator/running/runningWithJava.html
[Eclipse Feature]: http://mybatis.org/generator/running/runningWithEclipse.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NDkxNTA4_size_16_color_FFFFFF_t_70]: /images/20221124/ca8fd76715194fe482d59ad23fdda288.png
[Supplied Plugins]: http://mybatis.org/generator/reference/plugins.html
[Link 1]: https://www.cnblogs.com/throwable/p/12046848.html#%E5%B0%8F%E7%BB%93