mybatis-generator有三种用法：命令行、eclipse插件、maven插件。我的以为maven插件最方便，能够在eclipse/intellij idea等ide上能够通用。html

下面是从官网上的截图：java

在MBG中，最主要也最重要的就是XML配置文件，所以本篇文章主要的内容就是XML配置。这里按照配置的顺序对配置逐个讲解，更细的内容能够配合中文文档参照。mysql

1. 配置文件头

/p>

PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"

"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

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

generatorConfiguration节点没有任何属性，直接写节点便可，以下：github

3. 子元素

从这段开始，就是配置的主要内容，这些配置都是generatorConfiguration元素的子元素。正则表达式

包含如下子元素(有严格的顺序)：sql

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

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

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

resource：指定**classpath**下的属性文件，使用相似com/myproject/generatorConfig.properties这样的属性值。

url：能够指定文件系统上的特定位置，例如file:///C:/myfolder/generatorConfig.properties

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

最多见的用法是经过这个属性指定驱动的路径，例如：

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

注意，classPathEntry只在下面这两种状况下才有效：

当加载 JDBC 驱动内省数据库时

当加载根类中的 JavaModelGenerator 检查重写的方法时

所以，若是你须要加载其余用途的jar包，classPathEntry起不到做用，不能这么写，解决的办法就是将你用的jar包添加到类路径中，在Eclipse等IDE中运行的时候，添加jar包比较容易。当从命令行执行的时候，须要用java -cp xx.jar,xx2.jar xxxMainClass这种方式在-cp后面指定来使用(注意-jar会致使-cp无效)。

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

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

该元素只有一个**必选属性**id，用来惟一肯定一个元素，该id属性能够在运行MBG的使用。

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

defaultModelType:**这个属性很重要**，这个属性定义了MBG如何生成**实体类**。这个属性有如下可选值：

conditional:*这是默认值*,这个模型和下面的hierarchical相似，除了若是那个单独的类将只包含一个字段，将不会生成一个单独的类。 所以,若是一个表的主键只有一个字段,那么不会为该字段生成单独的实体类,会将该字段合并到基本实体类中。

flat:该模型为每一张表只生成一个实体类。这个实体类包含表中的全部字段。**这种模型最简单，推荐使用。**

hierarchical:若是表有主键,那么该模型会产生一个单独的主键实体类,若是表还有BLOB字段， 则会为表生成一个包含全部BLOB字段的单独的实体类,而后为全部其余的字段生成一个单独的实体类。 MBG会在全部生成的实体类之间维护一个继承关系。

targetRuntime:此属性用于指定生成的代码的运行时环境。该属性支持如下可选值：

MyBatis3:*这是默认值*

MyBatis3Simple

Ibatis2Java2

Ibatis2Java5 通常状况下使用默认值便可，有关这些值的具体做用以及区别请查看中文文档的详细内容。

introspectedColumnImpl:该参数能够指定扩展org.mybatis.generator.api.IntrospectedColumn该类的实现类。该属性的做用能够查看扩展MyBatis Generator。

通常状况下，咱们使用以下的配置便可：

若是你但愿不生成和Example查询有关的内容，那么能够按照以下进行配置:

使用MyBatis3Simple能够避免在后面的

MBG配置中的其余几个元素，基本上都是的子元素，这些子元素(有严格的配置顺序)包括：

其中属性比较特殊，后面讲解的时候都会和父元素一块儿进行讲解。在讲解属性前，咱们先看看**什么是分隔符？**。

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

select * from `user info`

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

下面继续看支持的属性：

autoDelimitKeywords

beginningDelimiter

endingDelimiter

javaFileEncoding

javaFormatter

xmlFormatter

因为这些属性比较重要，这里一一讲解。

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

而后这里继续上面的例子来说beginningDelimiter和endingDelimiter属性。因为beginningDelimiter和endingDelimiter的默认值为双引号(")，在Mysql中不能这么写，因此还要将这两个默认值改成**反单引号(`)**，配置以下：

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

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

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

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

元素用来定义一个插件。插件用于扩展或修改经过MyBatis Generator (MBG)代码生成器生成的代码。

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

有关插件的详细信息能够参考开发插件和提供的插件了解更多。

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

这个元素很是有用，相信不少人都有过这样的需求，就是但愿MBG生成的代码中能够包含**注释信息**，具体就是生成表或字段的备注信息。

使用这个元素就能很简单的实现咱们想要的功能。这里先介绍该元素，介绍完后会举例如何扩展实现该功能。

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

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

suppressAllComments:**阻止**生成注释，默认为false

suppressDate:**阻止**生成的注释包含时间戳，默认为false

通常状况下因为MBG生成的注释信息没有任何价值，并且有时间戳的状况下每次生成的注释都不同，使用**版本控制**的时候每次都会提交，于是通常状况下咱们都会屏蔽注释信息，能够以下配置：

接下来咱们简单举例实现生成包含表字段注释信息的注释

由于系统提供了一个默认的实现类，因此对咱们来讲，本身实现一个会很容易，最简单的方法就是复制默认实现类代码到一个新的文件中，修改类名如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方法能够获取字段的注释信息。上面这个方法修改起来仍是很容易的。除了字段的注释外还有Getter和Setter，以及类的注释。此外还有生成XML的注释，你们能够根据默认的实现进行修改。

完成咱们本身的实现类后，咱们还须要作以下配置：

用于指定数据库链接信息，该元素必选，而且只能有一个。

配置该元素只须要注意若是JDBC驱动不在**classpath**下，就须要经过元素引入jar包，这里**推荐**将jar包放到**classpath**下。

该元素有两个必选属性:

driverClass:访问数据库的JDBC驱动程序的彻底限定类名

connectionURL:访问数据库的JDBC链接URL

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

userId:访问数据库的用户ID

password:访问数据库的密码

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

这个元素配置起来最容易，这里举个简单例子：

connectionURL="jdbc:mysql://localhost:3306/test"

userId="root"

password="">

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

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

该元素提供了一个可选的属性type，和比较类型，提供了默认的实现DEFAULT，通常状况下使用默认便可，须要特殊处理的状况能够经过其余元素配置来解决，不建议修改该属性。

该属性还有一个能够配置的元素。

能够配置的属性为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，配置示例以下：

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

该元素用来控制生成的实体类，根据中配置的defaultModelType，一个表可能会对应生成多个不一样的实体类。一个表对应多个类实际上并不方便，因此前面也推荐使用flat，这种状况下一个表对应一个实体类。

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

targetPackage:生成实体类存放的包名，通常就是放在该包下。实际还会受到其余配置的影响(

targetProject:指定目标项目路径，使用的是文件系统的绝对路径。

该元素支持如下几个子元素属性：

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。

配置示例以下：

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

若是targetRuntime目标是**iBATIS2**，该元素必须配置一个。

若是targetRuntime目标是**MyBatis3**，只有当须要XML时，该元素必须配置一个。 若是没有配置，则使用如下的规则：

若是指定了一个，那么MBG将只生成XML的SQL映射文件和实体类。

若是没有指定，那么MBG将只生成实体类。

该元素只有两个属性(和前面提过的的属性含义同样)，都是必选的。

targetPackage:生成实体类存放的包名，通常就是放在该包下。实际还会受到其余配置的影响(

targetProject:指定目标项目路径，使用的是文件系统的绝对路径。

该元素支持子元素，只有一个能够配置的属性：

enableSubPackages:若是true，MBG会根据catalog和schema来生成子包。若是false就会直接用targetPackage属性。默认为false。

配置示例：

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

若是不配置该元素，就不会生成Mapper接口。

该元素有3个必选属性：

type:该属性用于选择一个预约义的客户端代码(能够理解为Mapper接口)生成器，用户能够自定义实现，须要继承org.mybatis.generator.codegen.AbstractJavaClientGenerator类，必选有一个默认的构造方法。 该属性提供了如下预约的代码生成器，首先根据的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:生成实体类存放的包名，通常就是放在该包下。实际还会受到其余配置的影响(

targetProject:指定目标项目路径，使用的是文件系统的绝对路径。

该元素还有一个可选属性：

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

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

enableSubPackages

exampleMethodVisibility

methodNameCalculator

rootInterface

useLegacyBuilder

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

rootInterface用于指定一个全部生成的接口都继承的父接口。 这个值能够经过

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

配置示例：

targetProject="E:\MyProject\src\main\java"/>

3.3.8

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

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

该元素有一个必选属性：

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

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

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

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:和的defaultModelType含义同样，这里能够针对表进行配置，这里的配置会覆盖的defaultModelType配置。

escapeWildcards:这个属性表示当查询列，是否对schema和表名中的SQL通配符 ('_' and '%') 进行转义。 对于某些驱动当schema或表名中包含SQL通配符时(例如，一个表名是MY_TABLE，有一些驱动须要将下划线进行转义)是必须的。默认值是false。

delimitIdentifiers:是否给标识符增长**分隔符**。默认false。当catalog,schema或tableName中包含空白时，默认为true。

delimitAllColumns:是否对全部列添加**分隔符**。默认false。

该元素包含多个可用的子元素，可选属性为：

constructorBased:和中的属性含义同样。

ignoreQualifiersAtRuntime:生成的SQL中的表名将不会包含schema和catalog前缀。

immutable:和中的属性含义同样。

modelOnly:此属性用于配置是否为表只生成实体类。若是设置为true就不会有Mapper接口。若是配置了，而且modelOnly为true，那么XML映射文件中只有实体对象的映射元素()。若是为true还会覆盖属性中的enableXXX方法，将不会生成任何CRUD方法。

rootClass:和中的属性含义同样。

rootInterface:和中的属性含义同样。

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。

除了子元素外，

下面对这4个元素进行详细讲解。

这个元素最多能够配置一个。这个元素用来指定自动生成主键的属性(identity字段或者sequences序列)。若是指定这个元素，MBG在生成insert的SQL映射文件中插入一个元素。 这个元素**很是重要**，这个元素包含下面两个必选属性：

column:生成列的列名。

sqlStatement:将返回新值的 SQL 语句。若是这是一个identity列，您可使用其中一个预约义的的特殊值。预约义值以下：

Cloudscape

DB2

DB2_MF

Derby

HSQLDB

Informix

MySql

SqlServer

SYBASE

JDBC:这会配置MBG使用MyBatis3支持的JDBC标准的生成key来生成代码。 这是一个独立于数据库获取标识列中的值的方法。 重要: 只有当目标运行为MyBatis3时才会产生正确的代码。 若是与iBATIS2一块儿使用目标运行时会产生运行时错误的代码。

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

identity:当设置为true时,该列会被标记为identity列， 而且元素会被插入在insert后面。 当设置为false时，会插入到insert以前(一般是序列)。**重要**: 即便您type属性指定为post，您仍然须要为identity列将该参数设置为true。 这将标志MBG从插入列表中删除该列。默认值是false。

type:type=post and identity=true的时候生成的中的order=AFTER,当type=pre的时候，identity只能为false，生成的中的order=BEFORE。能够这么理解，自动增加的列只有插入到数据库后才能获得ID，因此是AFTER,使用序列时，只有先获取序列以后，才能插入数据库，因此是BEFORE。

配置示例一：

对应的生成的结果：

SELECT LAST_INSERT_ID()

insert into `user login info` (Id, username, logindate, loginip)

values (#{id,jdbcType=INTEGER}, #{username,jdbcType=VARCHAR}, #{logindate,jdbcType=TIMESTAMP}, #{loginip,jdbcType=VARCHAR})

配置示例二：

对应的生成结果：

select SEQ_ID.nextval from dual

insert into `user login info` (Id, username, logindate, loginip)

values (#{id,jdbcType=INTEGER}, #{username,jdbcType=VARCHAR}, #{logindate,jdbcType=TIMESTAMP},#{loginip,jdbcType=VARCHAR})

该元素最多能够配置一个，使用该元素能够在生成列以前，对列进行重命名。这对那些存在同一前缀的字段想在生成属性名时去除前缀的表很是有用。 例如假设一个表包含如下的列：

CUST_BUSINESS_NAME

CUST_STREET_ADDRESS

CUST_CITY

CUST_STATE

生成的全部属性名中若是都包含CUST的前缀可能会让人不爽。这些前缀能够经过以下方式定义重命名规则:

注意，在内部，MBG使用java.util.regex.Matcher.replaceAll方法实现这个功能。 请参阅有关该方法的文档和在Java中使用正则表达式的例子。

当匹配一列时，这个元素()会被忽略。优先于重命名的规则。

该元素有一个必选属性：

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

该元素有一个可选属性：

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

关于

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

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

该元素有一个必选属性:

column:要重写的列名。

该元素有多个可选属性：

property:要使用的Java属性的名称。若是没有指定，MBG会根据列名生成。 例如，若是一个表的一列名为STRT_DTE，MBG会根据

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接口(该接口很容易继承)的全限定的类名。若是没有指定或者是空白，iBATIS会用默认的类型处理器来处理类型。**重要**:MBG不会校验这个类型处理器是否存在或者可用。 MGB只是简单的将这个值插入到生成的SQL映射的配置文件中。

delimitedColumnName:指定是否应在生成的SQL的列名称上增长**分隔符**。 若是列的名称中包含空格，MGB会自动添加**分隔符**， 因此这个重写只有当列名须要强制为一个合适的名字或者列名是数据库中的保留字时是必要的。

配置示例：

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

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

该元素有一个必选属性：

column:要忽略的列名。

该元素还有一个可选属性：

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

MyBatis Generator最佳实践

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

如下根据我的经验(对此有意见的能够留言)对一些配置见解列出以下几点：

关于实体类的modelType，建议使用defaultModelType="flat"，只有一个对象的状况下管理毕竟方便，使用也简单。

关于注释，无论你是否要重写本身的注释生成器，有一点不能忘记，那就是注释中必定要保留@mbggenerated,MBG经过该字符串来判断代码是否为代码生成器生成的代码，有该标记的的代码在从新生成的时候会被删除，不会重复。不会在XML中出现重复元素。

使用MBG生成的代码时，建议尽量不要去修改自动生成的代码，并且要生成带有@mbggenerated，这样才不会在每次从新生成代码的时候须要手动修改好多内容。

仍然是注释相关，在中，建议必定要保留suppressAllComments属性(使用默认值false)，必定要取消(设为true)时间戳suppressDate，避免重复提交SVN。

建议将JDBC驱动放到项目的**classpath**下，而不是使用来引入jar包，主要考虑到全部开发人员的统一性。

当数据库字段使用CHAR时，建议在中设置，能够自动去掉没必要要的空格。

在中，建议设置type="XMLMAPPER",不建议使用注解或混合模式，比较代码和SQL彻底分离易于维护。

建议尽量在

若是有其余有价值的经验，会继续补充。

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

/p>

PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"

"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

connectionURL="jdbc:mysql://localhost:3306/test"

userId="root"

password="">