A3. MyBatis Generator生成规则详解

生成器配置文件结构

生成器配置文件generatorConfig.xml的顶层结构如下：

• generatorConfiguration
  • classPathEntry（JDBC驱动的绝对路径）
  • properties（properties文件路径）
  • context（生成对象的环境设置）
    • property（Context作用域参数）
    • jdbcConnection（JDBC连接）
    • connectionFactory（JDBC连接工厂）
    • commentGenerator（注释生成器）
    • javaModelGenerator（实体对象生成器）
    • javaClientGenerator（Mapper 接口或实现类生成器）
    • sqlMapGenerator（xml 生成器）
    • table（用于生成对象的表）
    • javaTypeResolver（Java 类型处理器）
    • plugin（插件）

      生成器规则详解

      context*节点

      <context>节点用于指定生成一系列对象的环境。我们可以在配置文件中配置多个节点来实现从不同数据源或采用不同生成参数生成对象。

<context>节点最重要的属性是**targetRuntime**，它直接决定该环境下生成的代码风格，常用的风格为 MyBatis3DynamicSql 和 MyBatis3Simple。

<context>节点最重要的属性是**targetRuntime**，它直接决定该环境下生成的代码风格（详见6.3）。

property节点

<property>节点支持以下参数。针对 mysql 数据库，可以将定界符修改为反单引号。如果想要使用自定义的代码格式或 XML 格式，可以配置自定义实现。

jdbcConnection节点

<jdbcConnection>节点用于指定 MBG 进行数据库交互所用的 JDBC 连接。

注意，<jdbcConnection>和<connectionFactory>节点只要一个就行了。

包含以下子节点
<property> (0..N)：用于定义 JDBC 驱动所需的一些参数，较少用到。

connectionFactory节点

<jdbcConnection>节点用于指定和配置 MBG 进行数据库交互时获取 JDBC 连接的工厂。

注意，<jdbcConnection>和<connectionFactory>节点只要一个就行了。

<jdbcConnection>的子节点为 (0..N)，参数如下表。如果是使用默认的连接工厂，这几个参数必须按照下表的提供，但是，如果是自定义的连接工厂，需要提供什么参数由你自己决定。

commentGenerator*节点

<commentGenerator>节点用于指定和配置 Java 代码或 XML 文件中使用的注释生成器。

默认的注释生成器比较鸡肋，很多人都会考虑自己实现，详见6.5。

<commentGenerator>的子节点为 (0..N)，参数如下表。注意，这些参数是针对默认注释生成器的，如果是自定义的，需要提供什么参数由你自己决定。

javaTypeResolver节点

<javaTypeResolver> 节点用于指定和配置 Java 类型解析器。默认的解析器可能会将数据库类型 decimal 或 numberic 解析为Short、Integer、Long等 Java 类型，如果我们不希望这样解析，就需要使用到这个节点。Java 类型解析器使用默认的就行，一般不会去重写它。

<javaTypeResolver>的子节点为 (0..N)，参数如下表。注意，这些参数是针对默认注释生成器的，如果是自定义的，需要提供什么参数由你自己决定。

javaModelGenerator节点

<javaModelGenerator>节点用于配置实体类生成器。实体类生成器不支持自定义。

<javaModelGenerator>的子节点为 (0..N)，参数如下表。用的比较多的是 rootClass 和 trimStrings。

javaClientGenerator节点

<javaClientGenerator>节点用于指定和配置客户端类生成器。这个节点是可选的，如果不指定，则不会生成客户端类。客户端类一般指的是 Mapper 接口及 Mapper 接口的一些辅助类，例如SqlProvider 。

下面的 type 属性仅针对 MyBatis3Simple 和 MyBatis3 风格生效，而且 MyBatis3Simple 风格不支持 MIXEDMAPPER。

的子节点为 (0..N)，参数如下表。注意，这些参数是针对默认注释生成器的，如果是自定义的，需要提供什么参数由你自己决定。

sqlMapGenerator节点

<sqlMapGenerator> 节点用于配置 XML 生成器，不支持自定义。

<sqlMapGenerator>的子节点为 (0..N)，参数如下表。

table*节点

<table> 节点用于指定需要用于生成对象的表以及配置某些生成规则。这个节点相比前面提到的，要更加复杂一些。<table>节点支持的属性很多，一般保持默认就可以了。

| 是否生成指定语句。默认为true。 | | selectByPrimaryKeyQueryId
selectByExampleQueryId | 如果指定，在select 语句中将添加 ‘value’ as QUERYID | | modelType | 指定实体对象的类型。context节点中已介绍过了 | | escapeWildcards | 当 schema 或 tableName 包含 SQL 通配符，在搜素列时是否对其进行转义 | | delimitIdentifiers | 是否在 SQL 中对表名使用定界符并且使用确定的表名大小写。默认为false。 | | delimitAllColumns | 是否在 SQL 中对所有列名都添加定界符。默认为false。 |

<table>的子节点如下：

• (0..N)
• (0 or 1)
• (0 or 1)
• (0 or 1)
• (0..N)
• (0..N)
• (0..N)

这几个子节点中，常用到的是，其他的用的比较少。下面挑几个来分析下：

配置的大部分参数都是为了覆盖全局的配置，并不常用。

domainObjectRenamingRule/columnRenamingRule
<domainObjectRenamingRule>节点一般用于重命名实体类类名。例如，在没有指定 domainObjectName 的情况下，demo_employee 的表将生成实体类 DemoEmloyee，但我希望去掉前面的 Demo 前缀，则可以这样处理：

        <table tableName="demo_%" >
            <!-- replaceString属性可以省略 -->
            <domainObjectRenamingRule searchString="^Demo" replaceString=""/>
        </table>

另一个子节点<columnRenamingRule>也是相同的用法。

        <table tableName="demo_%" >
            <columnRenamingRule searchString="^Employee_" replaceString="" />
        </table>

gnoreColumnsByRegex/ignoreColumn
<ignoreColumnsByRegex>和<ignoreColumn>节点用于告诉 MBG 生成代码时忽略某些列。使用方法如下。

    <table tableName="Foo">
      <ignoreColumnsByRegex pattern="(?i)col.*">
        <except column="col01"/>
        <except column="col13"/>
      </ignoreColumnsByRegex>
    </table>

plugin*节点

<plugin>节点用于定义和配置插件。这个节点只有一个 type 属性，用于指定使用哪个插件，并通过子节点 property 来为这个插件设置参数。

官方插件

M官方为我们提供了许多好用的插件，如下：

插件的配置方式非常简单，如下：

        <!-- 插件 -->
        <plugin type="org.mybatis.generator.plugins.EqualsHashCodePlugin">
            <property name="useEqualsHashCodeFromRoot" value="true"/>
        </plugin>
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin">
            <property name="useToStringFromRoot" value="true"/>
        </plugin>

运行 Java 程序，可以看到实体类中生成类 toString 、hashCode 和 equals 方法。

自定义插件

如果自定义的话，需要实现org.mybatis.generator.api.Plugin接口，并提供无参构造，当然，这里推荐继承org.mybatis.generator.api.PluginAdapter来避免重写太多方法。下面举个例子来讲解自定义插件的使用。

例如对于menu表自动生成的实体名字是 Menu，如果想命名为 MenuDomain，而生成的 Mapper 命名为 MenuDAO。为了实现这种需求，我们可以先定义一个插件，如下：

public class RenameFilePlugin extends PluginAdapter {

    @Override
    public boolean validate(List<String> warnings) {
        return true;
    }

    @Override
    public void initialized(IntrospectedTable introspectedTable) {
        // 更改实体类名称，例如：cn.zzs.mybatis.entity.Menu => cn.zzs.mybatis.entity.MenuDomain
        String oldType = introspectedTable.getBaseRecordType();
        introspectedTable.setBaseRecordType(oldType + "Domain");

        // 更改Mapper名称
        String mapperType = introspectedTable.getMyBatis3JavaMapperType();
        introspectedTable.setMyBatis3JavaMapperType(mapperType.replace("Mapper", "DAO"));
    }
}

然后将插件配置：

<plugin type="cn.zzs.mybatis.plugin.RenameFilePlugin"></plugin>

下一章中我们将使用一个自定义的插件给生成的代码添加额外的注解