MyBatis Generator中文文档
MyBatis Generator中文文档地址：
http://mbg.cndocs.ml/
该中文文档由于尽可能和原文内容一致，所以有些地方如果不熟悉，看中文版的文档的也会有一定的障碍，所以本章根据该中文文档以及实际应用，使用通俗的语言来讲解详细的配置。
本文中所有节点的链接都是对应的中文文档地址，可以点击查看详细信息。
注:本文后面提到的MBG全部指代MyBatis Generator。
MyBatis Generator 1.3.4 扩展，可以设置 Mapper（Dao）后缀
运行MyBatis Generator
有4种运行MBG的方法，具体请看文档 运行 MyBatis Generator
MBG下载地址:http://repo1.maven.org/maven2/org/mybatis/generator/mybatis-generator-core/
XML配置详解
在MBG中，最主要也最重要的就是XML配置文件，因此本篇文章主要的内容就是XML配置。
这里按照配置的顺序对配置逐个讲解，更细的内容可以配合中文文档参照。
1. 配置文件头
使用最新版的MBG需要使用上面的xml头，配置文件必须包含上面的DOCTYPE。
2. 根节点
generatorConfiguration节点没有任何属性，直接写节点即可，如下：
3.
从这段开始，就是配置的主要内容，这些配置都是generatorConfiguration元素的子元素。
包含以下子元素（有严格的顺序）：
这个元素用来指定外部的属性元素，不是必须的元素。
元素用于指定一个需要在配置中解析使用的外部属性文件，引入属性文件后，可以在配置中使用 ${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的配置中，至少需要有一个
该元素只有一个必选属性id，用来唯一确定一个
id属性可以在运行MBG的使用。
此外还有几个可选属性：
defaultModelType:这个属性很重要，这个属性定义了MBG如何生成实体类。
这个属性有以下可选值：
conditional:*这是默认值*,这个模型和下面的hierarchical类似，除了如果那个单独的类将只包含一个字段，将不会生成一个单独的类。 因此,如果一个表的主键只有一个字段,那么不会为该字段生成单独的实体类,会将该字段合并到基本实体类中。flat:该模型为每一张表只生成一个实体类。这个实体类包含表中的所有字段。这种模型最简单，推荐使用。hierarchical:如果表有主键,那么该模型会产生一个单独的主键实体类,如果表还有BLOB字段， 则会为表生成一个包含所有BLOB字段的单独的实体类,然后为所有其他的字段生成一个单独的实体类。 MBG会在所有生成的实体类之间维护一个继承关系。
targetRuntime:此属性用于指定生成的代码的运行时环境。该属性支持以下可选值：MyBatis3:*这是默认值*MyBatis3SimpleIbatis2Java2Ibatis2Java5一般情况下使用默认值即可，有关这些值的具体作用以及区别请查看中文文档的详细内容。
introspectedColumnImpl:该参数可以指定扩展org.mybatis.generator.api.IntrospectedColumn该类的实现类。该属性的作用可以查看扩展MyBatis Generator。
一般情况下，我们使用如下的配置即可：
如果你希望不生成和Example查询有关的内容，那么可以按照如下进行配置:
使用MyBatis3Simple可以避免在后面的
中逐个进行配置（后面会提到）。
MBG配置中的其他几个元素，基本上都是
其中 属性比较特殊，后面讲解的时候都会和父元素一起进行讲解。在讲解 属性前，我们先看看什么是分隔符？。
这里通过一个例子说明。假设在Mysql数据库中有一个表名为user info，你没有看错，中间是一个空格，这种情况下如果写出select * from user info这样的语句，肯定是要报错的，在Mysql中的时候我们一般会写成如下的样子:
select * from `user info` 这里的使用的反单引号(`)就是分隔符，分隔符可以用于表名或者列名。
下面继续看 支持的属性：
autoDelimitKeywordsbeginningDelimiterendingDelimiterjavaFileEncodingjavaFormatterxmlFormatter
由于这些属性比较重要，这里一一讲解。
首先是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:阻止生成注释，默认为falsesuppressDate:阻止生成的注释包含时间戳，默认为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下，就需要通过
该元素有两个必选属性:
driverClass:访问数据库的JDBC驱动程序的完全限定类名connectionURL:访问数据库的JDBC连接URL
该元素还有两个可选属性:
userId:访问数据库的用户IDpassword:访问数据库的密码
此外该元素还可以接受多个 子元素，这里配置的 属性都会添加到JDBC驱动的属性中。
这个元素配置起来最容易，这里举个简单例子：
该元素最多可以配置一个。
这个元素的配置用来指定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:指定目标项目路径，可以是绝对路径或相对路径（如 targetProject="src/main/java"）。
该元素支持以下几个 子元素属性：
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，只有当
- 如果指定了一个
- 如果没有指定
- 如果指定了一个
该元素只有两个属性（和前面提过的
targetPackage:生成实体类存放的包名，一般就是放在该包下。实际还会受到其他配置的影响(
targetProject:指定目标项目路径，可以是绝对路径或相对路径（如 targetProject="src/main/resources"）。
该元素支持 子元素，只有一个可以配置的属性：
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接口
- MyBatis3:
targetPackage:生成实体类存放的包名，一般就是放在该包下。实际还会受到其他配置的影响(
targetProject:指定目标项目路径，可以是绝对路径或相对路径（如 targetProject="src/main/java"）。
该元素还有一个可选属性：
implementationPackage:如果指定了该属性，实现类就会生成在这个包中。
该元素支持 子元素设置的属性：
enableSubPackagesexampleMethodVisibilitymethodNameCalculatorrootInterfaceuseLegacyBuilder
这几个属性不太常用，具体作用请看完整的文档，这里对rootInterface做个简单介绍。
rootInterface用于指定一个所有生成的接口都继承的父接口。 这个值可以通过
配置的rootInterface属性覆盖。
这个属性对于通用Mapper来说，可以让生成的所有接口都继承该接口。
配置示例：
元素
该元素至少要配置一个，可以配置多个。
该元素用来配置要通过内省的表。只有配置的才会生成实体类和其他文件。
该元素有一个必选属性：
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个元素进行详细讲解。
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_NAMECUST_STREET_ADDRESSCUST_CITYCUST_STATE
生成的所有属性名中如果都包含CUST的前缀可能会让人不爽。这些前缀可以通过如下方式定义重命名规则:
注意，在内部，MBG使用java.util.regex.Matcher.replaceAll方法实现这个功能。 请参阅有关该方法的文档和在Java中使用正则表达式的例子。
当
该元素有一个必选属性：
searchString:定义将被替换的字符串的正则表达式。
该元素有一个可选属性：
replaceString:这是一个用来替换搜索字符串列每一个匹配项的字符串。如果没有指定，就会使用空字符串。
关于
的 属性useActualColumnNames对此的影响可以查看完整文档。
该元素可选，可以配置多个。
该元素从将某些属性默认计算的值更改为指定的值。
该元素有一个必选属性:
column:要重写的列名。
该元素有多个可选属性：
property:要使用的Java属性的名称。如果没有指定，MBG会根据列名生成。 例如，如果一个表的一列名为STRT_DTE，MBG会根据
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接口（该接口很容易继承）的全限定的类名。如果没有指定或者是空白，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。
- 当数据库字段使用
CHAR时，建议在
- 在
type="XMLMAPPER",不建议使用注解或混合模式，比较代码和SQL完全分离易于维护。 - 建议尽可能在
中配置
如果有其他有价值的经验，会继续补充。
综合以上信息，这里给出一个Mysql的简单配置：
这里用的通配符匹配全部的表，另外所有表都有自动增长的id字段。如果不是所有表的配置都一样，可以做针对性的配置。
改动：去掉来不建议使用Example查询的建议，Example在单表操作上优势明显，可以看个人情况使用。
发布者：全栈程序员-站长，转载请注明出处：https://javaforall.net/176377.html原文链接：https://javaforall.net
