官方网站：http://mybatis.org/generator/index.html

基于DDL生成Mybatis适合的实体、Mapper接口和映射文件。其中，代码生成器是MyBatis Generator(MBG)，用到了Mybatis-Generator-Core相关依赖，使用的Mybatis-Generator版本为1.4.0

1. 引入插件

Mybatis-Generator的运行方式：

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

• 通过Maven插件运行。

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

默认的配置文件为ClassPath:generatorConfig.xml。

2. 通过编码和配置文件运行

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

<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);

3. 通过Maven插件运行

如果使用Maven插件，那么不需要引入mybatis-generator-core依赖，只需要引入一个Maven的插件mybatis-generator-maven-plugin：

<plugins><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>
</plugins>

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

mvn mybatis-generator:generate

4. XML配置文件详解

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

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfigurationPUBLIC "-//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属性的可选值比较多，这里做个简单的小结：

笔者偏向于把SQL文件和代码分离，所以一般选用MyBatis3或者MyBatis3Simple。例如：

<context id="default" targetRuntime="MyBatis3">

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

jdbcConnection

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

commentGenerator

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

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

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

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

javaModelGenerator

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

<javaModelGenerator标签>标签支持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>的可选属性有：

sqlMapGenerator

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

<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

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

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

标签还支持众多的非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"/>

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfigurationPUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN""http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration><!-- 驱动包绝对路径 --><classPathEntrylocation="I:\\Develop\\Maven-Repository\\mysql\\mysql-connector-java\\5.1.48\\mysql-connector-java-5.1.48.jar"/><context id="default" targetRuntime="这里选择合适的引擎"><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/local"userId="root"password="root"></jdbcConnection><!-- 不强制把所有的数字类型转化为BigDecimal --><javaTypeResolver><property name="forceBigDecimals" value="false"/></javaTypeResolver><javaModelGenerator targetPackage="club.throwable.entity" targetProject="src/main/java"><property name="enableSubPackages" value="true"/></javaModelGenerator><sqlMapGenerator targetPackage="mappings" targetProject="src/main/resources"><property name="enableSubPackages" value="true"/></sqlMapGenerator><javaClientGenerator type="这里选择合适的Mapper类型" targetPackage="club.throwable.dao" targetProject="src/main/java"><property name="enableSubPackages" value="true"/></javaClientGenerator><table tableName="t_order"enableCountByExample="false"enableDeleteByExample="false"enableSelectByExample="false"enableUpdateByExample="false"domainObjectName="Order"mapperName="OrderMapper"><generatedKey column="id" sqlStatement="MySql"/></table></context>
</generatorConfiguration>

5. 纯注解

使用纯注解需要引入mybatis-dynamic-sql：

<dependency><groupId>org.mybatis.dynamic-sql</groupId><artifactId>mybatis-dynamic-sql</artifactId><version>1.1.4</version>
</dependency>

需要修改两个位置：

<context id="default" targetRuntime="MyBatis3DynamicSql">
...<javaClientGenerator type="ANNOTATEDMAPPER"
...

6. XML映射文件

XML映射文件生成只需要简单修改配置文件：

<context id="default" targetRuntime="MyBatis3Simple">
...<javaClientGenerator type="XMLMAPPER"
...

7. 编程式自定义类型映射

所有的非长整型的数字，统一使用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())));}
}

此时最好使用编程式运行代码生成器，修改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类型定义。