MyBatis Generator中文文档

MyBatis Generator中文文档地址：

http://mbg.cndocs.tk/

该中文文档因为尽可能和原文内容一致，所以有些地方假设不熟悉，看中文版的文档的也会有一定的障碍。所以本章依据该中文文档以及实际应用，使用通俗的语言来解说具体的配置。

本文中全部节点的链接都是相应的中文文档地址，能够点击查看具体信息。

下载本文档的PDF版本号

注:本文后面提到的MBG所有指代MyBatis Generator。

执行MyBatis Generator

有4种执行MBG的方法，详细请看文档执行 MyBatis Generator

MBG下载地址:http://repo1.maven.org/maven2/org/mybatis/generator/mybatis-generator-core/

XML配置具体解释

在MBG中，最主要也最重要的就是XML配置文件，因此本篇文章基本的内容就是XML配置。

这里依照配置的顺序对配置逐个解说。更细的内容能够配合中文文档參照。

1. 配置文件头

<?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">

使用最新版的MBG须要使用上面的xml头，配置文件必须包括上面的DOCTYPE。

2. 根节点`<generatorConfiguration>`

generatorConfiguration节点没有不论什么属性。直接写节点就可以。例如以下：

<generatorConfiguration>
    <!-- 详细配置内容 -->
</generatorConfiguration>

3. `<generatorConfiguration>`子元素

从这段開始，就是配置的主要内容，这些配置都是generatorConfiguration元素的子元素。

包括下面子元素（有严格的顺序）：

<properties> (0个或1个)
<classPathEntry> (0个或多个)
<context> (1个或多个)

3.1 `<properties>` 元素

这个元素用来指定外部的属性元素。不是必须的元素。

元素用于指定一个须要在配置中解析使用的外部属性文件，引入属性文件后，能够在配置中使用 ${property}这样的形式的引用，通过这样的方式引用属性文件里的属性值。对于后面须要配置的**jdbc信息**和targetProject属性会非常实用。

这个属性能够通过resource或者url来指定属性文件的位置，这两个属性仅仅能使用当中一个来指定，同一时候出现会报错。

resource：指定**classpath**下的属性文件，使用类似com/myproject/generatorConfig.properties这种属性值。
url：能够指定文件系统上的特定位置。比如file:///C:/myfolder/generatorConfig.properties

3.2 `<classPathEntry>` 元素

这个元素能够0或多个。不受限制。

最常见的使用方法是通过这个属性指定驱动的路径，比如：

<classPathEntry location="E:\mysql\mysql-connector-java-5.1.29.jar"/>

重点提醒：本文之前在这里有误导。特别强调。

注意，classPathEntry仅仅在以下这两种情况下才有效：

当载入 JDBC 驱动内省数据库时
当载入根类中的 JavaModelGenerator 检查重写的方法时

因此，假设你须要载入其它用途的jar包，classPathEntry起不到作用。不能这么写，解决的办法就是将你用的jar包加入到类路径中，在Eclipse等IDE中执行的时候，加入jar包比較easy。

当从命令行执行的时候，须要用java -cp xx.jar,xx2.jar xxxMainClass这样的方式在-cp后面指定来使用(注意-jar会导致-cp无效)。

3.3 `<context>` 元素

在MBG的配置中，至少须要有一个<context>元素。

<context>元素用于指定生成一组对象的环境。比如指定要连接的数据库，要生成对象的类型和要处理的数据库中的表。执行MBG的时候还能够指定要执行的<context>。

该元素仅仅有一个**必选属性**id，用来唯一确定一个<context>元素，该id属性能够在执行MBG的使用。

此外还有几个**可选属性**：

defaultModelType:**这个属性非常重要**。这个属性定义了MBG怎样生成**实体类**。

这个属性有下面可选值：
- conditional:*这是默认值*,这个模型和以下的hierarchical类似，除了假设那个单独的类将仅仅包括一个字段，将不会生成一个单独的类。因此,假设一个表的主键仅仅有一个字段,那么不会为该字段生成单独的实体类,会将该字段合并到基本实体类中。
- flat:该模型为每一张表仅仅生成一个实体类。
  这个实体类包括表中的全部字段。
  **这样的模型最简单，推荐使用。
  **
- hierarchical:假设表有主键,那么该模型会产生一个单独的主键实体类,假设表还有BLOB字段。则会为表生成一个包括全部BLOB字段的单独的实体类,然后为全部其它的字段生成一个单独的实体类。
  MBG会在全部生成的实体类之间维护一个继承关系。
targetRuntime:此属性用于指定生成的代码的执行时环境。该属性支持下面可选值：
- MyBatis3:*这是默认值*
- MyBatis3Simple
- Ibatis2Java2
- Ibatis2Java5 普通情况下使用默认值就可以，有关这些值的具体作用以及差别请查看中文文档的具体内容。
introspectedColumnImpl:该參数能够指定扩展org.mybatis.generator.api.IntrospectedColumn该类的实现类。该属性的作用能够查看扩展MyBatis Generator。

普通情况下，我们使用例如以下的配置就可以：

<context id="Mysql" defaultModelType="flat">

假设你希望不生成和Example查询有关的内容，那么能够依照例如以下进行配置:

<context id="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">

使用MyBatis3Simple能够避免在后面的<table>中逐个进行配置（后面会提到）。

MBG配置中的其它几个元素，基本上都是<context>的子元素，这些子元素（有严格的配置顺序）包含：

<property> (0个或多个)
<plugin> (0个或多个)
<commentGenerator> (0个或1个)
<jdbcConnection> (1个)
<javaTypeResolver> (0个或1个)
<javaModelGenerator> (1个)
<sqlMapGenerator> (0个或1个)
<javaClientGenerator> (0个或1个)
<table> (1个或多个)

当中<property>属性比較特殊，后面解说的时候都会和父元素一起进行解说。在解说<property>属性前，我们先看看**什么是分隔符？**。

这里通过一个样例说明。如果在Mysql数据库中有一个表名为user info，你没有看错，中间是一个空格，这样的情况下假设写出select * from user info这种语句，肯定是要报错的。在Mysql中的时候我们通常会写成例如以下的样子:

select * from `user info`

这里的使用的**反单引號(`)**就是**分隔符**，**分隔符**能够用于**表名**或者**列名**。

以下继续看<property>支持的属性：

autoDelimitKeywords
beginningDelimiter
endingDelimiter
javaFileEncoding
javaFormatter
xmlFormatter

因为这些属性比較重要，这里一一解说。

首先是autoDelimitKeywords，当表名或者字段名为SQLkeyword的时候，能够设置该属性为true。MBG会自己主动给表名或字段名加入**分隔符**。

然后这里继续上面的样例来讲beginningDelimiter和endingDelimiter属性。

因为beginningDelimiter和endingDelimiter的默认值为双引號(")，在Mysql中不能这么写，所以还要将这两个默认值改为**反单引號(`)**，配置例如以下：

<property name="beginningDelimiter" value="`"/>
<property name="endingDelimiter" value="`"/>

属性javaFileEncoding设置要使用的Java文件的编码，默认使用当前平台的编码。仅仅有当生产的编码须要特殊指定时才须要使用。一般用不到。

最后两个javaFormatter和xmlFormatter属性**可能会**非常实用，假设你想使用模板来定制生成的java文件和xml文件的样式。你能够通过指定这两个属性的值来实现。

接下来分节对其它的子元素逐个进行介绍。

3.3.1 `<plugin>` 元素

该元素能够配置0个或者多个，不受限制。

<plugin>元素用来定义一个插件。

插件用于扩展或改动通过MyBatis Generator (MBG)代码生成器生成的代码。

插件将按在配置中配置的顺序运行。

有关插件的具体信息能够參考开发插件和提供的插件了解很多其它。

3.3.2 `<commentGenerator>` 元素

该元素最多能够配置1个。

这个元素非常实用。相信非常多人都有过这种需求。就是希望MBG生成的代码中能够包括**凝视信息**，详细就是生成表或字段的备注信息。

使用这个元素就能非常easy的实现我们想要的功能。这里先介绍该元素，介绍完后会举例怎样扩展实现该功能。

该元素有一个可选属性type,能够指定用户的实现类，该类须要实现org.mybatis.generator.api.CommentGenerator接口。并且必有一个默认的构造方法。这个属性接收默认的特殊值DEFAULT，会使用默认的实现类org.mybatis.generator.internal.DefaultCommentGenerator。

默认的实现类中提供了两个可选属性。须要通过<property>属性进行配置。

suppressAllComments:**阻止**生成凝视，默觉得false
suppressDate:**阻止**生成的凝视包括时间戳，默觉得false

普通情况下因为MBG生成的凝视信息没有不论什么价值，并且有时间戳的情况下每次生成的凝视都不一样，使用**版本号控制**的时候每次都会提交。因而普通情况下我们都会屏蔽凝视信息。能够例如以下配置：

<commentGenerator>
    <property name="suppressAllComments" value="true"/>
    <property name="suppressDate" value="true"/>
</commentGenerator>

接下来我们简单举例实现生成包括表字段凝视信息的凝视

由于系统提供了一个默认的实现类，所以对我们来说，自己实现一个会非常easy。最简单的方法就是复制默认实现类代码到一个新的文件里，改动类名如MyCommentGenerator，在你自己的实现类中。你能够选择是否继续支持上面的两个属性，你还能够添加对其它属性的支持。

我们通过以下一个方法的改动来了解，其它几个方法请自行改动(写本章的时候我也没有全然实现该类，所以不提供完整源代码了):

@Override
public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
    if (introspectedColumn.getRemarks() != null && !introspectedColumn.getRemarks().equals("")) {
        field.addJavaDocLine("/**");
        field.addJavaDocLine(" * " + introspectedColumn.getRemarks());
        addJavadocTag(field, false);
        field.addJavaDocLine(" */");
    }
}

这种方法是给字段加入凝视信息的，当中IntrospectedColumn包括了字段的完整信息，通过getRemarks方法能够获取字段的凝视信息。

上面这种方法改动起来还是非常easy的。

除了字段的凝视外还有Getter和Setter，以及类的凝视。此外还有生成XML的凝视，大家能够依据默认的实现进行改动。

完毕我们自己的实现类后。我们还须要做例如以下配置：

<commentGenerator type="com.github.abel533.mybatis.generator.MyCommentGenerator"/>

3.3.3 `<jdbcConnection>` 元素

<jdbcConnection>用于指定数据库连接信息，该元素必选，而且仅仅能有一个。

配置该元素仅仅须要注意假设JDBC驱动不在**classpath**下，就须要通过<classPathEntry>元素引入jar包。这里**推荐**将jar包放到**classpath**下。

该元素有两个必选属性:

driverClass:訪问数据库的JDBC驱动程序的全然限定类名
connectionURL:訪问数据库的JDBC连接URL

该元素还有两个可选属性:

userId:訪问数据库的用户ID
password:訪问数据库的密码

此外该元素还能够接受多个<property>子元素，这里配置的<property>属性都会加入到JDBC驱动的属性中。

这个元素配置起来最easy，这里举个简单样例：

<jdbcConnection driverClass="com.mysql.jdbc.Driver"
                connectionURL="jdbc:mysql://localhost:3306/test"
                userId="root"
                password="">
</jdbcConnection>

3.3.4 `<javaTypeResolver>` 元素

该元素最多能够配置一个。

这个元素的配置用来指定JDBC类型和Java类型怎样转换。

该元素提供了一个可选的属性type，和<commentGenerator>比較类型。提供了默认的实现DEFAULT，普通情况下使用默认就可以。须要特殊处理的情况能够通过其它元素配置来解决。不建议改动该属性。

该属性另一个能够配置的<property>元素。

能够配置的属性为forceBigDecimals，该属性能够控制是否强制DECIMAL和NUMERIC类型的字段转换为Java类型的java.math.BigDecimal,默认值为false。一般不须要配置。

默认情况下的转换规则为：

假设精度>0或者长度>18。就会使用java.math.BigDecimal
假设精度=0而且10<=长度<=18，就会使用java.lang.Long
假设精度=0而且5<=长度<=9，就会使用java.lang.Integer
假设精度=0而且长度<5，就会使用java.lang.Short

假设设置为true，那么一定会使用java.math.BigDecimal，配置示比例如以下：

<javaTypeResolver >
    <property name="forceBigDecimals" value="true" />
</javaTypeResolver>

3.3.5 `<javaModelGenerator>` 元素

该元素必须配置一个，而且最多一个。

该元素用来控制生成的实体类，依据<context>中配置的defaultModelType，一个表可能会相应生成多个不同的实体类。

一个表相应多个类实际上并不方便，所曾经面也推荐使用flat。这样的情况下一个表相应一个实体类。

该元素仅仅有两个属性，都是必选的。

targetPackage:生成实体类存放的包名，一般就是放在该包下。实际还会受到其它配置的影响(<table>中会提到)。
targetProject:指定目标项目路径。使用的是文件系统的绝对路径。

该元素支持下面几个<property>子元素属性：

constructorBased:该属性仅仅对MyBatis3有效，假设true就会使用构造方法入參，假设false就会使用setter方式。
默觉得false。
enableSubPackages:假设true，MBG会依据catalog和schema来生成子包。假设false就会直接用targetPackage属性。
默觉得false。
immutable:该属性用来配置实体类属性是否可变。假设设置为true，那么constructorBased无论设置成什么，都会使用构造方法入參，而且不会生成setter方法。
假设为false，实体类属性就能够改变。
默觉得false。
rootClass:设置全部实体类的基类。假设设置，须要使用类的全限定名称。而且假设MBG可以载入rootClass。那么MBG不会覆盖和父类中全然匹配的属性。匹配规则：
- 属性名全然同样
- 属性类型同样
- 属性有getter方法
- 属性有setter方法
trimStrings:是否对数据库查询结果进行trim操作，假设设置为true就会生成类似这样public void setUsername(String username) {this.username = username == null ?
null : username.trim();}的setter方法。默认值为false。

配置示比例如以下：

<javaModelGenerator targetPackage="test.model" targetProject="E:\MyProject\src\main\java">
    <property name="enableSubPackages" value="true" />
    <property name="trimStrings" value="true" />
</javaModelGenerator>

3.3.6 `<sqlMapGenerator>` 元素

该元素可选。最多配置一个。可是有例如以下两种必选的特殊情况：

假设targetRuntime目标是**iBATIS2**。该元素必须配置一个。
假设targetRuntime目标是**MyBatis3**，仅仅有当<javaClientGenerator>须要XML时，该元素必须配置一个。假设没有配置<javaClientGenerator>。则使用下面的规则：
- 假设指定了一个<sqlMapGenerator>，那么MBG将仅仅生成XML的SQL映射文件和实体类。
- 假设没有指定<sqlMapGenerator>，那么MBG将仅仅生成实体类。

该元素仅仅有两个属性（和前面提过的<javaModelGenerator>的属性含义一样），都是必选的。

targetPackage:生成实体类存放的包名，一般就是放在该包下。实际还会受到其它配置的影响(<table>中会提到)。
targetProject:指定目标项目路径。使用的是文件系统的绝对路径。

该元素支持<property>子元素，仅仅有一个能够配置的属性：

enableSubPackages:假设true。MBG会依据catalog和schema来生成子包。
假设false就会直接用targetPackage属性。
默觉得false。

配置演示样例：

<sqlMapGenerator targetPackage="test.xml"  targetProject="E:\MyProject\src\main\resources">
    <property name="enableSubPackages" value="true" />
</sqlMapGenerator>

3.3.7 `<javaClientGenerator>` 元素

该元素可选。最多配置一个。

假设不配置该元素，就不会生成Mapper接口。

该元素有3个必选属性：

type:该属性用于选择一个提前定义的client代码（能够理解为Mapper接口）生成器，用户能够自己定义实现，须要继承org.mybatis.generator.codegen.AbstractJavaClientGenerator类。必选有一个默认的构造方法。
该属性提供了下面预定的代码生成器，首先依据<context>的targetRuntime分成三类：
- MyBatis3:
  - ANNOTATEDMAPPER:基于注解的Mapper接口，不会有相应的XML映射文件
  - MIXEDMAPPER:XML和注解的混合形式，(上面这样的情况中的)SqlProvider注解方法会被XML替代。
  - XMLMAPPER:全部的方法都在XML中，接口调用依赖XML文件。
- MyBatis3Simple:
  - ANNOTATEDMAPPER:基于注解的Mapper接口，不会有相应的XML映射文件
  - XMLMAPPER:全部的方法都在XML中，接口调用依赖XML文件。
- Ibatis2Java2或**Ibatis2Java5**:
  - IBATIS:生成的对象符合iBATIS的DAO框架（不建议使用）。
  - GENERIC-CI:生成的对象将仅仅依赖于SqlMapClient，通过构造方法注入。
  - GENERIC-SI:生成的对象将仅仅依赖于SqlMapClient，通过setter方法注入。
  - SPRING:生成的对象符合Spring的DAO接口
targetPackage:生成实体类存放的包名，一般就是放在该包下。
实际还会受到其它配置的影响(<table>中会提到)。
targetProject:指定目标项目路径，使用的是文件系统的绝对路径。

该元素另一个可选属性：

implementationPackage:假设指定了该属性，实现类就会生成在这个包中。

该元素支持<property>子元素设置的属性：

enableSubPackages
exampleMethodVisibility
methodNameCalculator
rootInterface
useLegacyBuilder

这几个属性不太经常使用，详细作用请看完整的文档，这里对rootInterface做个简介。

rootInterface用于指定一个全部生成的接口都继承的父接口。

这个值能够通过<table>配置的rootInterface属性覆盖。

这个属性对于通用Mapper来说，能够让生成的全部接口都继承该接口。

配置演示样例：

<javaClientGenerator type="XMLMAPPER" targetPackage="test.dao"
              targetProject="E:\MyProject\src\main\java"/>

3.3.8 `<table>` 元素

该元素至少要配置一个，能够配置多个。

该元素用来配置要通过内省的表。仅仅有配置的才会生成实体类和其它文件。

该元素有一个必选属性：

tableName：指定要生成的表名，能够使用SQL通配符匹配多个表。

比如要生成所有的表。能够按例如以下配置：

<table tableName="%" />

该元素包括多个可选属性：

schema:数据库的schema,能够使用SQL通配符匹配。假设设置了该值，生成SQL的表名会变成如schema.tableName的形式。
catalog:数据库的catalog，假设设置了该值，生成SQL的表名会变成如catalog.tableName的形式。
alias:假设指定。这个值会用在生成的select查询SQL的表的别名和列名上。列名会被别名为 alias_actualColumnName(别名_实际列名) 这样的模式。
domainObjectName:生成对象的基本名称。假设没有指定，MBG会自己主动依据表名来生成名称。
enableXXX:XXX代表多种SQL方法，该属性用来指定是否生成相应的XXX语句。
selectByPrimaryKeyQueryId:DBA跟踪工具会用到，具体请看具体文档。
selectByExampleQueryId:DBA跟踪工具会用到，具体请看具体文档。
modelType:和<context>的defaultModelType含义一样。这里能够针对表进行配置，这里的配置会覆盖<context>的defaultModelType配置。
escapeWildcards:这个属性表示当查询列，是否对schema和表名中的SQL通配符 ('_' and '%') 进行转义。
对于某些驱动当schema或表名中包括SQL通配符时（比如，一个表名是MY_TABLE，有一些驱动须要将下划线进行转义）是必须的。默认值是false。
delimitIdentifiers:是否给标识符添加**分隔符**。
默认false。
当catalog,schema或tableName中包括空白时，默觉得true。
delimitAllColumns:是否对全部列加入**分隔符**。
默认false。

该元素包括多个可用的<property>子元素。可选属性为：

constructorBased:和<javaModelGenerator>中的属性含义一样。
ignoreQualifiersAtRuntime:生成的SQL中的表名将不会包括schema和catalog前缀。
immutable:和<javaModelGenerator>中的属性含义一样。
modelOnly:此属性用于配置是否为表仅仅生成实体类。假设设置为true就不会有Mapper接口。假设配置了<sqlMapGenerator>。而且modelOnly为true。那么XML映射文件里仅仅有实体对象的映射元素(<resultMap>)。
假设为true还会覆盖属性中的enableXXX方法。将不会生成不论什么CRUD方法。
rootClass:和<javaModelGenerator>中的属性含义一样。
rootInterface:和<javaClientGenerator>中的属性含义一样。
runtimeCatalog:执行时的catalog，当生成表和执行环境的表的catalog不一样的时候能够使用该属性进行配置。
runtimeSchema:执行时的schema。当生成表和执行环境的表的schema不一样的时候能够使用该属性进行配置。
runtimeTableName:执行时的tableName，当生成表和执行环境的表的tableName不一样的时候能够使用该属性进行配置。
selectAllOrderByClause:该属性值会追加到selectAll方法后的SQL中。会直接跟order by拼接后加入到SQL末尾。
useActualColumnNames:假设设置为true,那么MBG会使用从数据库元数据获取的列名作为生成的实体对象的属性。
假设为false(默认值)。MGB将会尝试将返回的名称转换为驼峰形式。在这两种情况下，能够通过元素显示指定。在这样的情况下将会忽略这个（useActualColumnNames）属性。
useColumnIndexes:假设是true,MBG生成resultMaps的时候会使用列的索引,而不是结果中列名的顺序。
useCompoundPropertyNames:假设是true,那么MBG生成属性名的时候会将列名和列备注接起来. 这对于那些通过第四代语言自己主动生成列(比如:FLD22237),可是备注包括实用信息(比如:"customer id")的数据库来说非常实用. 在这样的情况下,MBG会生成属性名FLD2237_CustomerId。

除了<property>子元素外，<table>还包括下面子元素：

<generatedKey> (0个或1个)
<columnRenamingRule> (0个或1个)
<columnOverride> (0个或多个)
<ignoreColumn> (0个或多个)

以下对这4个元素进行具体解说。

1. <generatedKey> 元素

这个元素最多能够配置一个。
这个元素用来指定自己主动生成主键的属性（identity字段或者sequences序列）。

假设指定这个元素。MBG在生成insert的SQL映射文件里插入一个<selectKey>元素。这个元素**很重要**，这个元素包括以下两个必选属性：

column:生成列的列名。
sqlStatement:将返回新值的 SQL 语句。假设这是一个identity列。您能够使用当中一个提前定义的的特殊值。
提前定义值例如以下：
- Cloudscape
- DB2
- DB2_MF
- Derby
- HSQLDB
- Informix
- MySql
- SqlServer
- SYBASE
- JDBC:这会配置MBG使用MyBatis3支持的JDBC标准的生成key来生成代码。这是一个独立于数据库获取标识列中的值的方法。重要: 仅仅有当目标执行为MyBatis3时才会产生正确的代码。假设与iBATIS2一起使用目标执行时会产生执行时错误的代码。

这个元素还包括两个可选属性：

identity:当设置为true时,该列会被标记为identity列，而且<selectKey>元素会被插入在insert后面。
当设置为false时，<selectKey>会插入到insert之前（一般是序列）。
**重要**: 即使您type属性指定为post，您仍然须要为identity列将该參数设置为true。这将标志MBG从插入列表中删除该列。默认值是false。
type:type=post and identity=true的时候生成的<selectKey>中的order=AFTER,当type=pre的时候。identity仅仅能为false，生成的<selectKey>中的order=BEFORE。能够这么理解。自己主动增长的列仅仅有插入到数据库后才干得到ID，所以是AFTER,使用序列时，仅仅有先获取序列之后。才干插入数据库，所以是BEFORE。

配置演示样例一：

<table tableName="user login info" domainObjectName="UserLoginInfo">
    <generatedKey column="id" sqlStatement="Mysql"/>
</table>

相应的生成的结果：

<insert id="insert" parameterType="test.model.UserLoginInfo">
    <selectKey keyProperty="id" order="BEFORE" resultType="java.lang.Integer">
        SELECT LAST_INSERT_ID()
    </selectKey>
    insert into `user login info` (Id, username, logindate, loginip)
    values (#{id,jdbcType=INTEGER}, #{username,jdbcType=VARCHAR}, #{logindate,jdbcType=TIMESTAMP}, #{loginip,jdbcType=VARCHAR})
</insert>

配置演示样例二：

<table tableName="user login info" domainObjectName="UserLoginInfo">
    <generatedKey column="id" sqlStatement="select SEQ_ID.nextval from dual"/>
</table>

相应的生成结果：

<insert id="insert" parameterType="test.model.UserLoginInfo">
    <selectKey keyProperty="id" order="BEFORE" resultType="java.lang.Integer">
        select SEQ_ID.nextval from dual
    </selectKey>
    insert into `user login info` (Id, username, logindate, loginip)
    values (#{id,jdbcType=INTEGER}, #{username,jdbcType=VARCHAR}, #{logindate,jdbcType=TIMESTAMP},#{loginip,jdbcType=VARCHAR})
</insert>

2. <columnRenamingRule> 元素

该元素最多能够配置一个，使用该元素能够在生成列之前。对列进行重命名。这对那些存在同一前缀的字段想在生成属性名时去除前缀的表很实用。比如如果一个表包括下面的列：

CUST_BUSINESS_NAME
CUST_STREET_ADDRESS
CUST_CITY
CUST_STATE

生成的全部属性名中假设都包括CUST的前缀可能会让人不爽。

这些前缀能够通过例如以下方式定义重命名规则:

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

注意，在内部，MBG使用java.util.regex.Matcher.replaceAll方法实现这个功能。

请參阅有关该方法的文档和在Java中使用正則表達式的样例。

当<columnOverride>匹配一列时。这个元素（<columnRenamingRule>）会被忽略。<columnOverride>优先于重命名的规则。

该元素有一个必选属性：

searchString:定义将被替换的字符串的正則表達式。

该元素有一个可选属性：

replaceString:这是一个用来替换搜索字符串列每个匹配项的字符串。假设没有指定，就会使用空字符串。

关于<table>的<property>属性useActualColumnNames对此的影响能够查看完整文档。

3. <columnOverride> 元素

该元素可选。能够配置多个。

该元素从将某些属性默认计算的值更改为指定的值。

该元素有一个必选属性:

column:要重写的列名。

该元素有多个可选属性：

property:要使用的Java属性的名称。假设没有指定，MBG会依据列名生成。
比如，假设一个表的一列名为STRT_DTE。MBG会依据<table>的useActualColumnNames属性生成STRT_DTE或strtDte。
javaType:该列属性值为全然限定的Java类型。
假设须要，这能够覆盖由JavaTypeResolver计算出的类型。对某些数据库来说。这是必要的用来处理**“奇怪的”**数据库类型（比如MySql的unsigned bigint类型须要映射为java.lang.Object)。
jdbcType:该列的JDBC类型(INTEGER, DECIMAL, NUMERIC, VARCHAR等等)。假设须要，这能够覆盖由JavaTypeResolver计算出的类型。
对某些数据库来说。这是必要的用来处理怪异的JDBC驱动 (比如DB2的LONGVARCHAR类型须要为iBATIS 映射为VARCHAR)。
typeHandler:用户定义的须要用来处理这列的类型处理器。它必须是一个继承iBATIS的TypeHandler类或TypeHandlerCallback接口（该接口非常easy继承）的全限定的类名。
假设没有指定或者是空白。iBATIS会用默认的类型处理器来处理类型。**重要**:MBG不会校验这个类型处理器是否存在或者可用。 MGB仅仅是简单的将这个值插入到生成的SQL映射的配置文件里。
delimitedColumnName:指定是否应在生成的SQL的列名称上添加**分隔符**。
假设列的名称中包括空格。MGB会自己主动加入**分隔符**，所以这个重写仅仅有当列名须要强制为一个合适的名字或者列名是数据库中的保留字时是必要的。

配置演示样例：

<table schema="DB2ADMIN" tableName="ALLTYPES" >
    <columnOverride column="LONG_VARCHAR_FIELD" javaType="java.lang.String" jdbcType="VARCHAR" />
</table>

4. <ignoreColumn> 元素

该元素可选，能够配置多个。

该元素能够用来屏蔽不须要生成的列。

该元素有一个必选属性：

column:要忽略的列名。

该元素另一个可选属性：

delimitedColumnName:匹配列名的时候是否区分大写和小写。假设为true则区分。默认值为false。不区分大写和小写。

MyBatis Generator最佳实践

本节内容针对MyBatis3。使用iBATIS的不一定适用。

下面依据个人经验（对此有意见的能够留言）对一些配置看法列出例如以下几点：

关于实体类的modelType。建议使用defaultModelType="flat"。仅仅有一个对象的情况下管理毕竟方便。使用也简单。
关于凝视<commentGenerator>，无论你是否要重写自己的凝视生成器，有一点不能忘记。那就是凝视中一定要保留@mbggenerated,MBG通过该字符串来推断代码是否为代码生成器生成的代码。有该标记的的代码在又一次生成的时候会被删除，不会反复。
不会在XML中出现反复元素。
使用MBG生成的代码时。建议尽可能不要去改动自己主动生成的代码。并且要生成带有@mbggenerated。这样才不会在每次又一次生成代码的时候须要手动改动好多内容。
仍然是凝视相关。在<commentGenerator>中。建议一定要保留suppressAllComments属性(使用默认值false)，一定要取消(设为true)时间戳suppressDate，避免反复提交SVN。
<jdbcConnection>建议将JDBC驱动放到项目的**classpath**下。而不是使用<classPathEntry>来引入jar包，主要考虑到全部开发者的统一性。
当数据库字段使用CHAR时，建议在<javaModelGenerator>中设置<property name="trimStrings" value="true" />。能够自己主动去掉不必要的空格。
在<javaClientGenerator>中。建议设置type="XMLMAPPER",不建议使用注解或混合模式，比較代码和SQL全然分离易于维护。
建议尽可能在<table>中配置<generatedKey>，避免手工操作，以便于MBG反复运行代码生成。

假设有其它有价值的经验，会继续补充。

综合以上信息，这里给出一个Mysql的简单配置：

<?
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>
    <context id="MysqlContext" targetRuntime="MyBatis3" defaultModelType="flat">
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>

        <commentGenerator>
            <property name="suppressDate" value="true"/>
        </commentGenerator>

        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/test"
                        userId="root"
                        password="">
        </jdbcConnection>

        <javaModelGenerator targetPackage="test.model" targetProject="G:\MyProject\src\main\java">
            <property name="trimStrings" value="true" />
        </javaModelGenerator>

        <sqlMapGenerator targetPackage="test.xml"  targetProject="G:\MyProject\src\main\resources"/>

        <javaClientGenerator type="XMLMAPPER" targetPackage="test.dao"  targetProject="G:\MyProject\src\main\java"/>

        <table tableName="%">
            <generatedKey column="id" sqlStatement="Mysql"/>
        </table>
    </context>
</generatorConfiguration>

<table>这里用的通配符匹配全部的表，另外全部表都有自己主动增长的id字段。

假设不是全部表的配置都一样，能够做针对性的配置。

修改：去掉来不建议使用Example查询的建议，Example在单表操作上优势明显，能够看个人情况使用。

posted @ 2018-02-07 17:11 yjbjingcha 阅读(830) 评论(0) 收藏举报

刷新页面返回顶部

MyBatis Generator中文文档