最近在做创业项目的时候因为有比较多的新需求，需要频繁基于DDL生成Mybatis适合的实体、Mapper接口和映射文件。其中，代码生成器是MyBatis Generator(MBG)，用到了Mybatis-Generator-Core相关依赖，这里通过一篇文章详细地分析这个代码生成器的使用方式。本文编写的时候使用的Mybatis-Generator版本为1.4.0，其他版本没有进行过调研。

引入插件

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

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

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

通过编码和配置文件运行

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

    org.mybatis.generator
    mybatis-generator-core
    1.4.0

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

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

通过Maven插件运行

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

    
        org.mybatis.generator
        mybatis-generator-maven-plugin
        1.4.0
        
            
                Generate MyBatis Artifacts
                
                    generate
                
            
        
        
            
            true
            
            true
            
            ${basedir}/src/main/resources/generator-configuration.xml
        
    

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

mvn mybatis-generator:generate

XML配置文件详解

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

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

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

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

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。例如：

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

jdbcConnection标签

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

commentGenerator标签

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

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

javaTypeResolver标签

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

如果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标签

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

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

javaClientGenerator标签

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

type属性的可选值如下：

• ANNOTATEDMAPPER：Mapper接口生成的时候依赖于注解和SqlProviders（也就是纯注解实现），不会生成XML映射文件。
• XMLMAPPER：Mapper接口生成接口方法，对应的实现代码生成在XML映射文件中（也就是纯映射文件实现）。
• MIXEDMAPPER：Mapper接口生成的时候复杂的方法实现生成在XML映射文件中，而简单的实现通过注解和SqlProviders实现（也就是注解和映射文件混合实现）。

注意两点：

• 标签的targetRuntime属性指定为MyBatis3Simple的时候，type只能选用ANNOTATEDMAPPER或者XMLMAPPER。
• 标签的targetRuntime属性指定为MyBatis3的时候，type可以选用ANNOTATEDMAPPER、XMLMAPPER或者MIXEDMAPPER。

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

sqlMapGenerator标签

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

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

plugin标签

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

table标签