版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
MyBatis Generator： MyBatis 的开发团队提供了一个很强大的代码生成器，代码包含了数据库表对应的实体
类 、 Mapper 接口类、 Mapper XML 文件和 Example 对象等，这些代码文件中几乎包含了全部的单表操作方
法，使用 MBG 可以极大程度上方便我们使用 MyBatis，还可以减少很多重复操作。
XML配置详解
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=UTF-8&useSSL=false&allowMultiQueries=true
jdbc.username=root
jdbc.password=123456
mysql.connector.jar.path=D:/jar/mysql-connector-java-5.1.38.jar #可不配置，然后在pom文件中用依赖取代
<?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>
<!-- 引入配置文件 -->
<properties resource="application.properties"/>
<!-- 加载数据库驱动，这里也可不写，在pom进行依赖配置 -->
<classPathEntry location="${mysql.connector.jar.path}"/>
<!-- context:生成一组对象的环境
id:必选，上下文id，用于在生成错误时提示
defaultModelType:指定生成对象的样式
1，conditional：类似hierarchical；
2，flat：所有内容（主键，blob）等全部生成在一个对象中，推荐使用；
3，hierarchical：主键生成一个XXKey对象(key class)，Blob等单独生成一个对象，其他简单属性在一个对象中(record class)
targetRuntime:
1，MyBatis3：默认的值，生成基于MyBatis3.x以上版本的内容，包括XXXBySample；
2，MyBatis3Simple：类似MyBatis3，只是不生成XXXBySample；
-->
<context id="MyBatis" targetRuntime="MyBatis3Simple" defaultModelType="flat">
<!-- 生成的Java文件的编码 -->
<property name="javaFileEncoding" value="UTF-8"/>
<!-- 自动识别数据库关键字，默认false，如果设置为true，根据SqlReservedWords中定义的关键字列表；
一般保留默认值，遇到数据库关键字（Java关键字），使用columnOverride覆盖 -->
<property name="autoDelimitKeywords" value="false"/>
<!-- 格式化java代码 -->
<property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
<!-- 格式化XML代码 -->
<property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
<!-- beginningDelimiter和endingDelimiter：指明数据库的用于标记数据库对象名的符号，比如ORACLE就是双引号，MYSQL默认是`反引号；-->
<property name="beginningDelimiter" value="`"/>
<property name="endingDelimiter" value="`"/>
<commentGenerator>
<!-- 是否去除自动生成的注释 true:是；false:否 -->
<property name="suppressAllComments" value="true"/>
<!-- 阻止注释中包含时间戳 true:是；false:否 -->
<property name="suppressDate" value="true"/>
<!-- 注释是否包含数据库表的注释信息 true:是；false:否 -->
<property name="addRemarkComments" value="true"/>
</commentGenerator>
<!--数据库连接的信息：驱动类、连接地址、用户名、密码 -->
<jdbcConnection
driverClass="${jdbc.driver}"
connectionURL="${jdbc.url}"
userId="${jdbc.username}"
password="${jdbc.password}">
</jdbcConnection>
<!-- java类型处理器
用于处理DB中的类型到Java中的类型，默认使用JavaTypeResolverDefaultImpl；
注意一点，默认会先尝试使用Integer，Long，Short等来对应DECIMAL和 NUMERIC数据类型；
-->
<javaTypeResolver type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl">
<!--
true：使用BigDecimal对应DECIMAL和 NUMERIC数据类型
false：默认,
scale>0;length>18：使用BigDecimal;
scale=0;length[10,18]：使用Long；
scale=0;length[5,9]：使用Integer；
scale=0;length<5：使用Short；
-->
<property name="forceBigDecimals" value="false"/>
</javaTypeResolver>
<!-- java模型创建器，是必须要的元素
负责：1，key类（见context的defaultModelType）；2，java类；3，查询类
targetPackage：生成的类要放的包，真实的包受enableSubPackages属性控制；
targetProject：目标项目，指定一个存在的目录下，生成的内容会放到指定目录中，如果目录不存在，MBG不会自动建目录
-->
<javaModelGenerator targetPackage="com.kami.model" targetProject="src/main/java">
<!-- for MyBatis3/MyBatis3Simple
自动为每一个生成的类创建一个构造方法，构造方法包含了所有的field；而不是使用setter；-->
<property name="constructorBased" value="false"/>
<!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false -->
<property name="enableSubPackages" value="false"/>
<!-- for MyBatis3 / MyBatis3Simple
是否创建一个不可变的类，如果为true，
那么MBG会创建一个没有setter方法的类，取而代之的是类似constructorBased的类 -->
<property name="immutable" value="false"/>
<!-- 设置是否在getter方法中，对String类型字段调用trim()方法 -->
<property name="trimStrings" value="true"/>
<!-- 设置一个根对象，
如果设置了这个根对象，那么生成的keyClass或者recordClass会继承这个类；在Table的rootClass属性中可以覆盖该选项
注意：如果在key class或者record class中有root class相同的属性，MBG就不会重新生成这些属性了，包括：
1，属性名相同，类型相同，有相同的getter/setter方法；
-->
<!--<property name="rootClass" value="com.kami.model.AbstractPersistable"/>-->
</javaModelGenerator>
<!-- 生成SQL mapper的XML文件生成器，targetPackage可使用 . 表示直接生成在resources目录下
注意，在Mybatis3之后，我们可以使用mapper.xml文件+Mapper接口（或者不用mapper接口），
或者只使用Mapper接口+Annotation，所以，如果 javaClientGenerator配置中配置了需要生成XML的话，这个元素就必须配置
targetPackage/targetProject:同javaModelGenerator
-->
<sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
<!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false -->
<property name="enableSubPackages" value="false"/>
</sqlMapGenerator>
<!-- 对于mybatis来说，即生成Mapper接口，注意，如果没有配置该元素，那么默认不会生成Mapper接口
type：选择怎么生成mapper接口（在MyBatis3/MyBatis3Simple下）：
1，ANNOTATEDMAPPER：会生成使用Mapper接口+Annotation的方式创建（SQL生成在annotation中），不会生成对应的XML；
2，MIXEDMAPPER：使用混合配置，会生成Mapper接口，并适当添加合适的Annotation，但是XML会生成在XML中；
3，XMLMAPPER：会生成Mapper接口，接口完全依赖XML；
注意，如果context是MyBatis3Simple：只支持ANNOTATEDMAPPER和XMLMAPPER
-->
<javaClientGenerator targetPackage="com.kami.mapper" targetProject="src/main/java" type="XMLMAPPER">
<!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false -->
<property name="enableSubPackages" value="false"/>
<!-- 可以为所有生成的接口添加一个父接口，但是MBG只负责生成，不负责检查 -->
<!--<property name="rootInterface" value="com.kami.mapper.BaseMapper"/>-->
</javaClientGenerator>
<!--
可选参数：
1、schema：数据库的schema
2、tableName(必要)：要生成对象的表名，可指定表名、也可使用 % 指定所有表
3、catalog：数据库的catalog
4、alias：为数据表设置的别名，如果设置了alias，那么生成的所有的SELECT SQL语句中，列名会变成：alias_actualColumnName
5、domainObjectName：生成的domain类的名字，如果不设置，直接使用表名作为domain类的名字；可以设置为packageName.domainName，
那么会自动把domainName类再放到packageName包里面；
6、enableInsert（默认true）：指定是否生成insert语句
7、enableSelectByPrimaryKey（默认true）：指定是否生成按照主键查询对象的语句
8、enableUpdateByPrimaryKey（默认true）：指定是否生成按照主键修改对象的语句
9、enableDeleteByPrimaryKey（默认true）：指定是否生成按照主键删除对象的语句
10、modelType：参考context元素的defaultModelType，相当于覆盖；
11、delimitIdentifiers：参考tableName的解释，注意，默认的delimitIdentifiers是双引号，如果类似MYSQL这样的数据库，
使用的是`（反引号，那么还需要设置context的beginningDelimiter和endingDelimiter属性）
12，delimitAllColumns：设置是否所有生成的SQL中的列名都使用标识符引起来。默认为false，delimitIdentifiers参考context的属性
13、enableSelectByExample（默认true）：MyBatis3Simple为false，指定是否生成动态查询语句
14、enableDeleteByExample（默认true）：MyBatis3Simple为false，指定是否生成动态删除语句；
15、enableCountByExample（默认true）：MyBatis3Simple为false，指定是否生成动态查询总条数语句（用于分页的总条数查询）
16、enableUpdateByExample（默认true）：MyBatis3Simple为false，指定是否生成动态修改语句（只修改对象中不为空的属性）；
-->
<table schema="test" tableName="%" domainObjectName="User"
selectByExampleQueryId="false"
enableSelectByExample="false"
enableUpdateByExample="false"
enableDeleteByExample="false"
enableCountByExample="false">
<!-- generatedKey用于生成生成主键的方法，
如果设置了该元素，MBG会在生成的<insert>元素中生成一条正确的<selectKey>元素，该元素可选
column:主键的列名；
sqlStatement：要生成的selectKey语句，有以下可选项：
Cloudscape:相当于selectKey的SQL为： VALUES IDENTITY_VAL_LOCAL()
DB2 :相当于selectKey的SQL为： VALUES IDENTITY_VAL_LOCAL()
DB2_MF :相当于selectKey的SQL为：SELECT IDENTITY_VAL_LOCAL() FROM SYSIBM.SYSDUMMY1
Derby :相当于selectKey的SQL为：VALUES IDENTITY_VAL_LOCAL()
HSQLDB :相当于selectKey的SQL为：CALL IDENTITY()
Informix :相当于selectKey的SQL为：select dbinfo('sqlca.sqlerrd1') from systables where tabid=1
MySql :相当于selectKey的SQL为：SELECT LAST_INSERT_ID()
SqlServer :相当于selectKey的SQL为：SELECT SCOPE_IDENTITY()
SYBASE :相当于selectKey的SQL为：SELECT @@IDENTITY
JDBC :相当于在生成的insert元素上添加useGeneratedKeys="true"和keyProperty属性
-->
<generatedKey column="id" sqlStatement="MySql"/>
</table>
</context>
</generatorConfiguration>
我们 generatorConfig.xml 一般配置基本如下，其实上述 <table> 标签中还有更多的属性可进行一些，有需要的话可以自行添加
... //省略上述已介绍的
<!--
可选参数：
1、schema：数据库的schema
2、tableName(必要)：要生成对象的表名，可指定表名、也可使用 % 指定所有表
3、catalog：数据库的catalog
4、alias：为数据表设置的别名，如果设置了alias，那么生成的所有的SELECT SQL语句中，列名会变成：alias_actualColumnName
5、domainObjectName：生成的domain类的名字，如果不设置，直接使用表名作为domain类的名字；可以设置为packageName.domainName，
那么会自动把domainName类再放到packageName包里面；
6、enableInsert（默认true）：指定是否生成insert语句
7、enableSelectByPrimaryKey（默认true）：指定是否生成按照主键查询对象的语句
8、enableUpdateByPrimaryKey（默认true）：指定是否生成按照主键修改对象的语句
9、enableDeleteByPrimaryKey（默认true）：指定是否生成按照主键删除对象的语句
10、modelType：参考context元素的defaultModelType，相当于覆盖；
11、delimitIdentifiers：参考tableName的解释，注意，默认的delimitIdentifiers是双引号，如果类似MYSQL这样的数据库，
使用的是`（反引号，那么还需要设置context的beginningDelimiter和endingDelimiter属性）
12，delimitAllColumns：设置是否所有生成的SQL中的列名都使用标识符引起来。默认为false，delimitIdentifiers参考context的属性
13、enableSelectByExample（默认true）：MyBatis3Simple为false，指定是否生成动态查询语句
14、enableDeleteByExample（默认true）：MyBatis3Simple为false，指定是否生成动态删除语句；
15、enableCountByExample（默认true）：MyBatis3Simple为false，指定是否生成动态查询总条数语句（用于分页的总条数查询）
16、enableUpdateByExample（默认true）：MyBatis3Simple为false，指定是否生成动态修改语句（只修改对象中不为空的属性）；
-->
<table schema="test" tableName="%" domainObjectName="User"
selectByExampleQueryId="false"
enableSelectByExample="false"
enableUpdateByExample="false"
enableDeleteByExample="false"
enableCountByExample="false">
<!-- 参考javaModelGenerator的constructorBased属性-->
<property name="constructorBased" value="false"/>
<!-- 参考javaModelGenerator的immutable属性 -->
<property name="immutable" value="false"/>
<!-- 参考 javaModelGenerator的rootClass 属性 -->
<property name="rootClass" value=""/>
<!-- 参考javaClientGenerator的rootInterface 属性 -->
<property name="rootInterface" value=""/>
<!-- 指定是否只生成domain类，如果设置为true，只生成domain类，如果还配置了sqlMapGenerator，那么在mapper XML文件中，只生成resultMap元素 -->
<property name="modelOnly" value="false"/>
<!-- 默认为false，如果设置为true，生成的model类会直接使用column本身的名字，而不会再使用驼峰命名方法 -->
<property name="useActualColumnNames" value="false"/>
<!-- 默认为false，如果设置为true，在生成的SQL中，table名字不会加上schema或catalog -->
<property name="ignoreQualifiersAtRuntime" value="false"/>
<!-- 如果设置了runtimeSchema，那么在生成的SQL中，使用该指定的schema，而不是table元素上的schema -->
<property name="runtimeSchema" value=""/>
<!-- 如果设置了runtimeCatalog，那么在生成的SQL中，使用该指定的catalog，而不是table元素上的catalog -->
<property name="runtimeCatalog" value=""/>
<!-- 如果设置了runtimeTableName，那么在生成的SQL中，使用该指定的tableName，而不是table元素上的tableName -->
<property name="runtimeTableName" value=""/>
<!-- 注意，该属性只针对MyBatis3Simple有用；
如果选择的runtime是MyBatis3Simple，那么会生成一个SelectAll方法，如果指定了selectAllOrderByClause，那么会在该SQL中添加指定的这个order条件；
-->
<property name="selectAllOrderByClause" value="age desc,username asc"/>
<!-- generatedKey用于生成生成主键的方法，
如果设置了该元素，MBG会在生成的<insert>元素中生成一条正确的<selectKey>元素，该元素可选
column:主键的列名；
sqlStatement：要生成的selectKey语句，有以下可选项：
Cloudscape:相当于selectKey的SQL为： VALUES IDENTITY_VAL_LOCAL()
DB2 :相当于selectKey的SQL为： VALUES IDENTITY_VAL_LOCAL()
DB2_MF :相当于selectKey的SQL为：SELECT IDENTITY_VAL_LOCAL() FROM SYSIBM.SYSDUMMY1
Derby :相当于selectKey的SQL为：VALUES IDENTITY_VAL_LOCAL()
HSQLDB :相当于selectKey的SQL为：CALL IDENTITY()
Informix :相当于selectKey的SQL为：select dbinfo('sqlca.sqlerrd1') from systables where tabid=1
MySql :相当于selectKey的SQL为：SELECT LAST_INSERT_ID()
SqlServer :相当于selectKey的SQL为：SELECT SCOPE_IDENTITY()
SYBASE :相当于selectKey的SQL为：SELECT @@IDENTITY
JDBC :相当于在生成的insert元素上添加useGeneratedKeys="true"和keyProperty属性
-->
<generatedKey column="id" sqlStatement="MySql"/>
<!--
该元素会在根据表中列名计算对象属性名之前先重命名列名，非常适合用于表中的列都有公用的前缀字符串的时候，
比如列名为：CUST_ID,CUST_NAME,CUST_EMAIL,CUST_ADDRESS等；
那么就可以设置searchString为"^CUST_"，并使用空白替换，那么生成的Customer对象中的属性名称就不是
custId,custName等，而是先被替换为ID,NAME,EMAIL,然后变成属性：id，name，email；
注意，MBG是使用java.util.regex.Matcher.replaceAll来替换searchString和replaceString的，
如果使用了columnOverride元素，该属性无效；
-->
<columnRenamingRule searchString="" replaceString=""/>
<!-- 用来修改表中某个列的属性，MBG会使用修改后的列来生成domain的属性；
column:要重新设置的列名；
注意，一个table元素中可以有多个columnOverride元素
-->
<columnOverride column="username">
<!-- 使用property属性来指定列要生成的属性名称 -->
<property name="property" value="userName"/>
<!-- javaType用于指定生成的domain的属性类型，使用类型的全限定名 -->
<property name="javaType" value=""/>
<!-- jdbcType用于指定该列的JDBC类型 -->
<property name="jdbcType" value=""/>
<!-- typeHandler 用于指定该列使用到的TypeHandler，如果要指定，配置类型处理器的全限定名
注意，mybatis中，不会生成到mybatis-config.xml中的typeHandler
只会生成类似：where id = #{id,jdbcType=BIGINT,typeHandler=com._520it.mybatis.MyTypeHandler}的参数描述
-->
<property name="jdbcType" value=""/>
<!-- 参考table元素的delimitAllColumns配置，默认为false -->
<property name="delimitedColumnName" value=""/>
</columnOverride>
<!-- ignoreColumn设置一个MGB忽略的列，如果设置了改列，那么在生成的domain中，生成的SQL中，都不会有该列出现
column:指定要忽略的列的名字；
delimitedColumnName：参考table元素的delimitAllColumns配置，默认为false
注意，一个table元素中可以有多个ignoreColumn元素
-->
<ignoreColumn column="deptId" delimitedColumnName=""/>
</table>
</context>
</generatorConfiguration>
怎么运行MGB
上述详细介绍了如何配置我们的 Mybatis Generator 的 generatorConfig.xml XML文件，现在我们就来看看应该如何运行。
使用 Maven Plugin
我们首先在 pom 文件下配置如下信息
... //省略
</pluginManagement>
<!--解决有资源、配置文件build不到包-->
<resources>
<resource>
<directory>src/main/resources</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>true</filtering>
</resource>
</resources>
<plugins>
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.5</version>
<configuration>
<!-- generatorConfig.xml存放路径 -->
<configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
<!--允许移动生成的文件 -->
<verbose>true</verbose>
<!--允许覆盖生成的文件 -->
<overwrite>true</overwrite>
</configuration>
<executions>
<execution>
<id>Generate Mybatis Artifacts</id>
<goals>
<goal>generate</goal>
</goals>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.5</version>
</dependency>
<!--插件找不到mysql驱动，要么配置本地的，要么放置这里-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.38</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
然后我们在 Maven Projects 工程中，就可以找到我们的相关的 mybatis-generator 插件进行运行了。
另外我们还可以直接在IDEA的 “Run运行” 选项中配置一下，如下
配置完成后，就可以直接运行了
从另一个 Java 程序使用 XML 配置文件
上面我们介绍了使用 maven 插件就可以直接运行我们的MBG，但是要是我们的项目没有使用 maven ，那么该如何运行呢？
我们还可以从另一个 Java 程序使用 XML 配置文件，我们可以直接用 main 方法，也可以用 Junit 的 Test 方法进行运行，如下
public class MybatisGeneratorTest {
@Test
public void mybatisGeneratorTest(){
List<String> warnings = new ArrayList<>();
boolean overwrite = true;
String genConfig = "generatorConfig.xml";
File configFile = new File(getClass().getClassLoader().getResource(genConfig).getFile());
ConfigurationParser configurationParser = new ConfigurationParser(warnings);
Configuration config = null;
try {
config = configurationParser.parseConfiguration(configFile);
} catch (IOException e) {
e.printStackTrace();
} catch (XMLParserException e) {
e.printStackTrace();
}
DefaultShellCallback callback = new DefaultShellCallback(overwrite);
MyBatisGenerator myBatisGenerator = null;
try {
myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
} catch (InvalidConfigurationException e) {
e.printStackTrace();
}
try {
myBatisGenerator.generate(null);
} catch (SQLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
} catch (InterruptedException e) {
e.printStackTrace();
}
}
}
我们在运行上述方法时，还需要加入一些依赖的，如下
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.11</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-test</artifactId>
<version>4.3.2.RELEASE</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.5</version>
<scope>test</scope>
</dependency>
运行命令使用 XML 配置文件
首先我们需要在项目的 src 文件夹下，放上入选三个所需文件
其中我们的 generatorConfig.xml 需要做一点路径上的改变，如我们没有使用 .properties 文件了，而是直接将相关信息写入 xml 文件之中
然后我们就可以直接在我们的 cmd 中，切换至我们的项目路径之下，运行下列命令即可。
java -Dfile.encoding=UTF-8 -jar mybatis-generator-core-1.3.5.jar -configfile generatorConfig.xml -overwrite