MyBatis Generator的使用
前言：使用mybatis的Generator插件，可以快速的生成数据库表对应的实体类文件以及其sql映射接口文件（mapper）。本文主要讲解MyBatis Generator（MBG）的使用。
环境：IDEA14.1.7
jdk 1.7
1.mybatis环境的搭建
mybatis环境的搭建，请参看：MyBatis知识点总结（一）。笔者搭建的mybatis项目目录接口如下图。
注：mybatis-generator-config.xml为MBG的配置文件，实际操作中主要工作就这配置文件中，下面对其做详细介绍。
2.MBG插件
要使用MBG进行开发，需要MBG插件的支持，可以通过maven进行插件的依赖，具体如下：
1 <plugins> 2 <plugin> 3 <!--Mybatis-generator插件,用于自动生成Mapper和POJO--> 4 <groupId>org.mybatis.generator</groupId> 5 <artifactId>mybatis-generator-maven-plugin</artifactId> 6 <version>1.3.6</version> 7 <configuration> 8 <!--配置文件的位置--> 9 <configurationFile>src/main/resources/mybatis-generator-config.xml</configurationFile> 10 <verbose>true</verbose> 11 <overwrite>true</overwrite> 12 </configuration> 13 <executions> 14 <execution> 15 <id>Generate MyBatis Artifacts</id> 16 <goals> 17 <goal>generate</goal> 18 </goals> 19 </execution> 20 </executions> 21 <dependencies> 22 <dependency> 23 <groupId>org.mybatis.generator</groupId> 24 <artifactId>mybatis-generator-core</artifactId> 25 <version>1.3.6</version> 26 </dependency> 27 </dependencies> 28 </plugin> 29 </plugins>
通过上述相关依赖，即可使用MBG插件，下面就插件的具体配置做讲解。
3.MBG配置文件详解。
1 <?xml version="1.0" encoding="UTF-8"?> 2 <!DOCTYPE generatorConfiguration 3 PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" 4 "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd"> 5 <!-- 配置生成器 --> 6 <generatorConfiguration> 7 <!-- 可以通过properties标签来进行数据库配置信息的引用。 8 该标签有resource和url两个属性 9 resource：配置资源加载地址，使用resource，MBG从classpath开始找，比如com/myproject/generatorConfig.properties 10 url：配置资源加载地质，使用URL的方式，比如file:///C:/myfolder/generatorConfig.properties. 11 注意，两个属性只能选址一个; 12 --> 13 <properties resource="DataBaseConfig/db.properties"/> 14 15 <!-- 在MBG工作的时候，需要额外加载数据库驱动jar包（重要点，不能缺少该标签） 16 location属性指明加载jar包的全路径 17 --> 18 <classPathEntry location="E:/IdeaProject/mbgmysqlconnectionjar/mysql-connector-java-5.1.20.jar" /> 19 20 <!-- 21 context:生成一组对象的环境（核心配置标签） 22 id:必选，上下文id，用于在生成错误时提示 23 defaultModelType:指定生成对象的样式 24 1，conditional 25 默认值 26 这个模型与hierarchical模型相似,除了如果一个实体类只包含一个字段,则不会单独生成此实体类。因此,如果一个表的主键只有一个字段,那么不会为该字段生成单独的实体类,会将该字段合并到基本实体类中。 27 2，flat 28 所有内容（主键，blob）等全部生成在一个对象中，一般使用这个模型就够了 29 3，hierarchical 30 主键生成一个XXKey对象(key class)，Blob等单独生成一个对象，其他简单属性在一个对象中(record class) 31 targetRuntime: 32 1，MyBatis3：默认的值，生成基于MyBatis3.x以上版本的内容，包括XXXBySample； 33 2，MyBatis3Simple：类似MyBatis3，只是不生成XXXBySample； 34 introspectedColumnImpl：类全限定名，用于扩展MBG 35 --> 36 <context id="mysql" defaultModelType="flat" targetRuntime="MyBatis3"> 37 38 <!-- 自动识别数据库关键字，默认false，如果设置为true，根据SqlReservedWords中定义的关键字列表； 39 一般保留默认值，遇到数据库关键字（Java关键字），使用columnOverride覆盖 40 --> 41 <property name="autoDelimitKeywords" value="false"/> 42 <!-- 生成的Java文件的编码 --> 43 <property name="javaFileEncoding" value="UTF-8"/> 44 <!-- 格式化java代码 --> 45 <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/> 46 <!-- 格式化XML代码 --> 47 <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/> 48 49 50 <!-- 必须标签，使用这个配置数据库信息--> 51 <!--这里可以直接填写数据库相关信息，但推荐使用配置文件的形式，便于管理--> 52 <jdbcConnection driverClass="${jdbc.driver}" 53 connectionURL="${jdbc.url}" 54 userId="${jdbc.username}" 55 password="${jdbc.password}"/> 56 57 <!-- java类型处理器 58 用于处理DB中的类型到Java中的类型，默认使用JavaTypeResolverDefaultImpl； 59 注意一点，默认会先尝试使用Integer，Long，Short等来对应DECIMAL和 NUMERIC数据类型； 60 --> 61 <javaTypeResolver type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl"> 62 <!-- 63 true：使用BigDecimal对应DECIMAL和 NUMERIC数据类型 64 false：默认, 65 scale>0;length>18：使用BigDecimal; 66 scale=0;length[10,18]：使用Long； 67 scale=0;length[5,9]：使用Integer； 68 scale=0;length<5：使用Short； 69 --> 70 <property name="forceBigDecimals" value="false"/> 71 </javaTypeResolver> 72 73 <!-- java模型创建器，生成实体类（必须） 74 targetPackage：实体类放置的包名 75 targetProject：目标项目，指定实体类放置包名的位置，注意这里的写法，不然很容易出现错误 76 --> 77 <javaModelGenerator targetPackage="com.mybatisstudy.domain" targetProject="src/main/java"> 78 <!-- for MyBatis3/MyBatis3Simple 79 自动为每一个生成的类创建一个构造方法，构造方法包含了所有的field；而不是使用setter； 80 --> 81 <property name="constructorBased" value="false"/> 82 83 <!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false --> 84 <property name="enableSubPackages" value="false"/> 85 86 <!-- for MyBatis3 / MyBatis3Simple 87 是否创建一个不可变的类，如果为true， 88 那么MBG会创建一个没有setter方法的类，取而代之的是类似constructorBased的类 89 --> 90 <property name="immutable" value="false"/> 91 92 <!-- 设置是否在getter方法中，对String类型字段调用trim()方法 --> 93 <property name="trimStrings" value="true"/> 94 </javaModelGenerator> 95 96 97 <!-- 生成SQL map的XML文件生成器， 98 注意，在Mybatis3之后，我们可以使用mapper.xml文件+Mapper接口（或者不用mapper接口），或者只使用Mapper接口+Annotation。所以，如果 javaClientGenerator配置中配置了需要生成XML的话，这个元素就必须配置 99 targetPackage/targetProject:同javaModelGenerator 100 --> 101 <sqlMapGenerator targetPackage="com.mybatisstudy.mapper" targetProject="src/main/config"><!--注意这里的位置，用于管理所有xml文件--> 102 <!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false --> 103 <property name="enableSubPackages" value="false"/> 104 </sqlMapGenerator> 105 106 <!-- 对于mybatis来说，即生成Mapper接口，注意，如果没有配置该元素，那么默认不会生成Mapper接口 107 targetPackage/targetProject:同javaModelGenerator 108 109 type：选择怎么生成mapper接口 110 1.ANNOTATEDMAPPER：会生成使用Mapper接口+Annotation的方式创建（SQL生成在annotation中），不会生成对应的XML； 111 2.MIXEDMAPPER：使用混合配置，会生成Mapper接口，并适当添加合适的Annotation，但是XML会生成在XML中； 112 3.XMLMAPPER：会生成Mapper接口，接口完全依赖XML； 113 注意，如果context是MyBatis3Simple：只支持ANNOTATEDMAPPER和XMLMAPPER 114 --> 115 <javaClientGenerator targetPackage="com.mybatisstudy.mapper" type="XMLMAPPER" targetProject="src/main/java"> 116 <!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false --> 117 <property name="enableSubPackages" value="false"/> 118 </javaClientGenerator> 119 120 <!-- 选择一个table来生成相关文件，可以有一个或多个table，必须要有table元素 121 选择的table会生成一下文件： 122 1，SQL map文件 123 2，生成一个主键类； 124 3，除了BLOB和主键的其他字段的类； 125 4，包含BLOB的类； 126 5，一个用户生成动态查询的条件类（selectByExample, deleteByExample），可选； 127 6，Mapper接口（可选） 128 129 tableName（必要）：要生成对象的表名； 130 注意：大小写敏感问题。正常情况下，MBG会自动的去识别数据库标识符的大小写敏感度，在一般情况下，MBG会 131 根据设置的schema，catalog或tablename去查询数据表，按照下面的流程： 132 1，如果schema，catalog或tablename中有空格，那么设置的是什么格式，就精确的使用指定的大小写格式去查询； 133 2，否则，如果数据库的标识符使用大写的，那么MBG自动把表名变成大写再查找； 134 3，否则，如果数据库的标识符使用小写的，那么MBG自动把表名变成小写再查找； 135 4，否则，使用指定的大小写格式查询； 136 另外的，如果在创建表的时候，使用的""把数据库对象规定大小写，就算数据库标识符是使用的大写，在这种情况下也会使用给定的大小写来创建表名； 137 这个时候，请设置delimitIdentifiers="true"即可保留大小写格式； 138 139 可选： 140 1，schema：数据库的schema； 141 2，catalog：数据库的catalog； 142 3，alias：为数据表设置的别名，如果设置了alias，那么生成的所有的SELECT SQL语句中，列名会变成：alias_actualColumnName 143 4，domainObjectName：生成的domain类的名字，如果不设置，直接使用表名作为domain类的名字；可以设置为somepck.domainName，那么会自动把domainName类再放到somepck包里面； 144 5，enableInsert（默认true）：指定是否生成insert语句； 145 6，enableSelectByPrimaryKey（默认true）：指定是否生成按照主键查询对象的语句（就是getById或get）； 146 7，enableSelectByExample（默认true）：MyBatis3Simple为false，指定是否生成动态查询语句； 147 8，enableUpdateByPrimaryKey（默认true）：指定是否生成按照主键修改对象的语句（即update)； 148 9，enableDeleteByPrimaryKey（默认true）：指定是否生成按照主键删除对象的语句（即delete）； 149 10，enableDeleteByExample（默认true）：MyBatis3Simple为false，指定是否生成动态删除语句； 150 11，enableCountByExample（默认true）：MyBatis3Simple为false，指定是否生成动态查询总条数语句（用于分页的总条数查询）； 151 12，enableUpdateByExample（默认true）：MyBatis3Simple为false，指定是否生成动态修改语句（只修改对象中不为空的属性）； 152 13，modelType：参考context元素的defaultModelType，相当于覆盖； 153 14，delimitIdentifiers：参考tableName的解释，注意，默认的delimitIdentifiers是双引号，如果类似MYSQL这样的数据库，使用的是`（反引号，那么还需要设置context的beginningDelimiter和endingDelimiter属性） 154 15，delimitAllColumns：设置是否所有生成的SQL中的列名都使用标识符引起来。默认为false，delimitIdentifiers参考context的属性 155 156 注意，table里面很多参数都是对javaModelGenerator，context等元素的默认属性的一个复写； 157 --> 158 <table tableName="t_user" domainObjectName="User"/> 159 160 </context> 161 162 </generatorConfiguration>
注：上面的配置文件讲解得非常的详细，下面给出一个简易的版本。
1 <?xml version="1.0" encoding="UTF-8" ?> 2 <!DOCTYPE generatorConfiguration 3 PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" 4 "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd" > 5 <generatorConfiguration> 6 <properties resource="DataBaseConfig/db.properties"/> 7 <!--数据库驱动，必须--> 8 <classPathEntry location="E:/IdeaProject/mbgmysqlconnectionjar/mysql-connector-java-5.1.20.jar"/> 9 <context id="mysql" targetRuntime="MyBatis3" defaultModelType="flat"> 10 <commentGenerator> 11 <property name="suppressAllComments" value="false"/> 12 <property name="suppressDate" value="true"/> 13 </commentGenerator> 14 15 <!-- 数据库的相关配置 --> 16 <jdbcConnection driverClass="${jdbc.driver}" 17 connectionURL="${jdbc.url}" 18 userId="${jdbc.username}" 19 password="${jdbc.password}"/> 20 21 <javaTypeResolver> 22 <property name="forceBigDecimals" value="false"/> 23 </javaTypeResolver> 24 25 <!-- 实体类生成的位置 --> 26 <!-- 27 targetPackage:目标包位置 28 targetProject：目标工程，注意这里的写法，不然很容易搞错 29 --> 30 <javaModelGenerator targetPackage="com.mybatisstudy.domain" targetProject="src/main/java"> 31 <property name="enableSubPackages" value="false"/> 32 <property name="trimStrings" value="true"/> 33 </javaModelGenerator> 34 35 <!-- *Mapper.xml 文件的位置 --> 36 <sqlMapGenerator targetPackage="com.mybatisstudy.mapper" targetProject="src/main/config"> 37 <property name="enableSubPackages" value="false"/> 38 </sqlMapGenerator> 39 40 <!-- Mapper 接口文件的位置 --> 41 <javaClientGenerator targetPackage="com.mybatisstudy.mapper" targetProject="src/main/java" type="XMLMAPPER"> 42 <property name="enableSubPackages" value="false"/> 43 </javaClientGenerator> 44 45 <!-- 相关表的配置 --> 46 <table tableName="t_user" domainObjectName="User"/> 47 <table tableName="department" domainObjectName="Department"/> 48 </context> 49 </generatorConfiguration>
4.利用MBG插件生成相关文件。
在Maven Projects窗口中，可以看到已经拥有了mybatis-generator插件，右键如图所示的选项，即可生成相关文件。
至此，关于如何使用MBG进行操作的相关要点已经介绍完，通过本篇文章，就可以对实体类等相关文件进行逆向生成。
by Shawn Chen，2018.3.18日，晚。
