第三章 mybatis-generator，mybatis-generator
用了mybatis-generator，我就不再想用注解了，這與我之前說的注解與XML並用是矛盾的，知識嘛，本來就是多元化的，今天喜歡這個，明天喜歡那個，哈哈，看了mybatis-generator下邊的作用，再決定用哪個。
mybatis-generator的作用：
- 生成model、mapper接口、mapper對應的xml文件（包含基本的增刪該查與條件不定式的插入、更新和查詢）
- 在項目的設計初期，數據庫往往會發生微小的變動，比如添加或者修改一個字段，但是此時我們還沒有修改多少mapper和xml，這個時候可以直接使用mybatis-generator重新生成以上三個東西，不需要自己手動去動那三個類（方便數據庫的修改）
- 如果model有很多屬性（十個以上），自己親手去寫就有點麻煩了，自動生成會比較快
- 自己手寫的話，一些jdbcType和javaType的對應可能忘記，例如，jdbcType是TIMESTAMP，那麼javaType就是Date，如果設置成java8的LocalDateTime就會出錯，sqlSessionFactory就無法實例化了
一、轉自
http://www.cnblogs.com/smileberry/p/4145872.html 描述了怎樣使用mybatis-generator
http://www.jianshu.com/p/e09d2370b796 mybatis-generator配置文件詳解
二、使用mybatis-generator
2.1、下載
https://github.com/mybatis/generator/releases
2.2、准備目錄結構與jar包
- 配置文件generatorConfig.xml見2.3
- src目錄，建立該目錄主要是與generatorConfig.xml的targetProject配置有關
- 兩個jar包
- mybatis-generator-core-1.3.2.jar（2.1下載的）
- mysql-connector-java-5.1.37.jar
2.3、編寫配置文件generatorConfig.xml
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 <!--數據庫驅動-->
7 <classPathEntry location="mysql-connector-java-5.1.37.jar"/>
8 <context id="mysql">
9 <commentGenerator>
10 <property name="suppressDate" value="true"/>
11 <property name="suppressAllComments" value="true"/>
12 </commentGenerator>
13 <!--數據庫鏈接地址賬號密碼-->
14 <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://ip:3306/dbname" userId="root" password="xxx">
15 </jdbcConnection>
16 <javaTypeResolver>
17 <property name="forceBigDecimals" value="false"/>
18 </javaTypeResolver>
19 <!--生成Model類存放位置-->
20 <javaModelGenerator targetPackage="com.xxx.model" targetProject="src">
21 <property name="enableSubPackages" value="true"/>
22 <property name="trimStrings" value="true"/>
23 </javaModelGenerator>
24 <!--生成映射文件存放位置-->
25 <sqlMapGenerator targetPackage="lcw.mapping" targetProject="src">
26 <property name="enableSubPackages" value="true"/>
27 </sqlMapGenerator>
28 <!--生成mapper類存放位置-->
29 <javaClientGenerator type="XMLMAPPER" targetPackage="com.xxx.mapper" targetProject="src">
30 <property name="enableSubPackages" value="true"/>
31 </javaClientGenerator>
32 <!--生成對應表及類名-->
33
34 <table tableName="T_USER" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table>
35
36 </context>
37 </generatorConfiguration>
注意點：
- model和mapper的targetPackage屬性要設置成正確的目錄（即項目中的真實目錄），否則可能將這些東西拷貝到項目裡之後，還需要手動去改xml的配置。
2.4、生成model、mapper和項xml
- java -jar mybatis-generator-core-1.3.2.jar -configfile generatorConfig.xml -overwrite
2.5、將生成的文件導入項目中相應的位置即可
三、配置文件詳解
![]()
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 <!-- 可以用於加載配置項或者配置文件，在整個配置文件中就可以使用${propertyKey}的方式來引用配置項
8 resource：配置資源加載地址，使用resource，MBG從classpath開始找，比如com/myproject/generatorConfig.properties
9 url：配置資源加載地質，使用URL的方式，比如file:///C:/myfolder/generatorConfig.properties.
10 注意，兩個屬性只能選址一個;
11
12 另外，如果使用了mybatis-generator-maven-plugin，那麼在pom.xml中定義的properties都可以直接在generatorConfig.xml中使用
13 <properties resource="" url="" />
14 -->
15
16 <!-- 在MBG工作的時候，需要額外加載的依賴包
17 location屬性指明加載jar/zip包的全路徑
18 <classPathEntry location="/Program Files/IBM/SQLLIB/java/db2java.zip" />
19 -->
20
21 <!--
22 context:生成一組對象的環境
23 id:必選，上下文id，用於在生成錯誤時提示
24 defaultModelType:指定生成對象的樣式
25 1，conditional：類似hierarchical；
26 2，flat：所有內容（主鍵，blob）等全部生成在一個對象中；
27 3，hierarchical：主鍵生成一個XXKey對象(key class)，Blob等單獨生成一個對象，其他簡單屬性在一個對象中(record class)
28 targetRuntime:
29 1，MyBatis3：默認的值，生成基於MyBatis3.x以上版本的內容，包括XXXBySample；
30 2，MyBatis3Simple：類似MyBatis3，只是不生成XXXBySample；
31 introspectedColumnImpl：類全限定名，用於擴展MBG
32 -->
33 <context id="mysql" defaultModelType="hierarchical" targetRuntime="MyBatis3Simple" >
34
35 <!-- 自動識別數據庫關鍵字，默認false，如果設置為true，根據SqlReservedWords中定義的關鍵字列表；
36 一般保留默認值，遇到數據庫關鍵字（Java關鍵字），使用columnOverride覆蓋
37 -->
38 <property name="autoDelimitKeywords" value="false"/>
39 <!-- 生成的Java文件的編碼 -->
40 <property name="javaFileEncoding" value="UTF-8"/>
41 <!-- 格式化java代碼 -->
42 <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
43 <!-- 格式化XML代碼 -->
44 <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
45
46 <!-- beginningDelimiter和endingDelimiter：指明數據庫的用於標記數據庫對象名的符號，比如ORACLE就是雙引號，MYSQL默認是`反引號； -->
47 <property name="beginningDelimiter" value="`"/>
48 <property name="endingDelimiter" value="`"/>
49
50 <!-- 必須要有的，使用這個配置鏈接數據庫
51 @TODO:是否可以擴展
52 -->
53 <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql:///pss" userId="root" password="admin">
54 <!-- 這裡面可以設置property屬性，每一個property屬性都設置到配置的Driver上 -->
55 </jdbcConnection>
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
74 <!-- java模型創建器，是必須要的元素
75 負責：1，key類（見context的defaultModelType）；2，java類；3，查詢類
76 targetPackage：生成的類要放的包，真實的包受enableSubPackages屬性控制；
77 targetProject：目標項目，指定一個存在的目錄下，生成的內容會放到指定目錄中，如果目錄不存在，MBG不會自動建目錄
78 -->
79 <javaModelGenerator targetPackage="com._520it.mybatis.domain" targetProject="src/main/java">
80 <!-- for MyBatis3/MyBatis3Simple
81 自動為每一個生成的類創建一個構造方法，構造方法包含了所有的field；而不是使用setter；
82 -->
83 <property name="constructorBased" value="false"/>
84
85 <!-- 在targetPackage的基礎上，根據數據庫的schema再生成一層package，最終生成的類放在這個package下，默認為false -->
86 <property name="enableSubPackages" value="true"/>
87
88 <!-- for MyBatis3 / MyBatis3Simple
89 是否創建一個不可變的類，如果為true，
90 那麼MBG會創建一個沒有setter方法的類，取而代之的是類似constructorBased的類
91 -->
92 <property name="immutable" value="false"/>
93
94 <!-- 設置一個根對象，
95 如果設置了這個根對象，那麼生成的keyClass或者recordClass會繼承這個類；在Table的rootClass屬性中可以覆蓋該選項
96 注意：如果在key class或者record class中有root class相同的屬性，MBG就不會重新生成這些屬性了，包括：
97 1，屬性名相同，類型相同，有相同的getter/setter方法；
98 -->
99 <property name="rootClass" value="com._520it.mybatis.domain.BaseDomain"/>
100
101 <!-- 設置是否在getter方法中，對String類型字段調用trim()方法 -->
102 <property name="trimStrings" value="true"/>
103 </javaModelGenerator>
104
105
106 <!-- 生成SQL map的XML文件生成器，
107 注意，在Mybatis3之後，我們可以使用mapper.xml文件+Mapper接口（或者不用mapper接口），
108 或者只使用Mapper接口+Annotation，所以，如果 javaClientGenerator配置中配置了需要生成XML的話，這個元素就必須配置
109 targetPackage/targetProject:同javaModelGenerator
110 -->
111 <sqlMapGenerator targetPackage="com._520it.mybatis.mapper" targetProject="src/main/resources">
112 <!-- 在targetPackage的基礎上，根據數據庫的schema再生成一層package，最終生成的類放在這個package下，默認為false -->
113 <property name="enableSubPackages" value="true"/>
114 </sqlMapGenerator>
115
116
117 <!-- 對於mybatis來說，即生成Mapper接口，注意，如果沒有配置該元素，那麼默認不會生成Mapper接口
118 targetPackage/targetProject:同javaModelGenerator
119 type：選擇怎麼生成mapper接口（在MyBatis3/MyBatis3Simple下）：
120 1，ANNOTATEDMAPPER：會生成使用Mapper接口+Annotation的方式創建（SQL生成在annotation中），不會生成對應的XML；
121 2，MIXEDMAPPER：使用混合配置，會生成Mapper接口，並適當添加合適的Annotation，但是XML會生成在XML中；
122 3，XMLMAPPER：會生成Mapper接口，接口完全依賴XML；
123 注意，如果context是MyBatis3Simple：只支持ANNOTATEDMAPPER和XMLMAPPER
124 -->
125 <javaClientGenerator targetPackage="com._520it.mybatis.mapper" type="ANNOTATEDMAPPER" targetProject="src/main/java">
126 <!-- 在targetPackage的基礎上，根據數據庫的schema再生成一層package，最終生成的類放在這個package下，默認為false -->
127 <property name="enableSubPackages" value="true"/>
128
129 <!-- 可以為所有生成的接口添加一個父接口，但是MBG只負責生成，不負責檢查
130 <property name="rootInterface" value=""/>
131 -->
132 </javaClientGenerator>
133
134 <!-- 選擇一個table來生成相關文件，可以有一個或多個table，必須要有table元素
135 選擇的table會生成一下文件：
136 1，SQL map文件
137 2，生成一個主鍵類；
138 3，除了BLOB和主鍵的其他字段的類；
139 4，包含BLOB的類；
140 5，一個用戶生成動態查詢的條件類（selectByExample, deleteByExample），可選；
141 6，Mapper接口（可選）
142
143 tableName（必要）：要生成對象的表名；
144 注意：大小寫敏感問題。正常情況下，MBG會自動的去識別數據庫標識符的大小寫敏感度，在一般情況下，MBG會
145 根據設置的schema，catalog或tablename去查詢數據表，按照下面的流程：
146 1，如果schema，catalog或tablename中有空格，那麼設置的是什麼格式，就精確的使用指定的大小寫格式去查詢；
147 2，否則，如果數據庫的標識符使用大寫的，那麼MBG自動把表名變成大寫再查找；
148 3，否則，如果數據庫的標識符使用小寫的，那麼MBG自動把表名變成小寫再查找；
149 4，否則，使用指定的大小寫格式查詢；
150 另外的，如果在創建表的時候，使用的""把數據庫對象規定大小寫，就算數據庫標識符是使用的大寫，在這種情況下也會使用給定的大小寫來創建表名；
151 這個時候，請設置delimitIdentifiers="true"即可保留大小寫格式；
152
153 可選：
154 1，schema：數據庫的schema；
155 2，catalog：數據庫的catalog；
156 3，alias：為數據表設置的別名，如果設置了alias，那麼生成的所有的SELECT SQL語句中，列名會變成：alias_actualColumnName
157 4，domainObjectName：生成的domain類的名字，如果不設置，直接使用表名作為domain類的名字；可以設置為somepck.domainName，那麼會自動把domainName類再放到somepck包裡面；
158 5，enableInsert（默認true）：指定是否生成insert語句；
159 6，enableSelectByPrimaryKey（默認true）：指定是否生成按照主鍵查詢對象的語句（就是getById或get）；
160 7，enableSelectByExample（默認true）：MyBatis3Simple為false，指定是否生成動態查詢語句；
161 8，enableUpdateByPrimaryKey（默認true）：指定是否生成按照主鍵修改對象的語句（即update)；
162 9，enableDeleteByPrimaryKey（默認true）：指定是否生成按照主鍵刪除對象的語句（即delete）；
163 10，enableDeleteByExample（默認true）：MyBatis3Simple為false，指定是否生成動態刪除語句；
164 11，enableCountByExample（默認true）：MyBatis3Simple為false，指定是否生成動態查詢總條數語句（用於分頁的總條數查詢）；
165 12，enableUpdateByExample（默認true）：MyBatis3Simple為false，指定是否生成動態修改語句（只修改對象中不為空的屬性）；
166 13，modelType：參考context元素的defaultModelType，相當於覆蓋；
167 14，delimitIdentifiers：參考tableName的解釋，注意，默認的delimitIdentifiers是雙引號，如果類似MYSQL這樣的數據庫，使用的是`（反引號，那麼還需要設置context的beginningDelimiter和endingDelimiter屬性）
168 15，delimitAllColumns：設置是否所有生成的SQL中的列名都使用標識符引起來。默認為false，delimitIdentifiers參考context的屬性
169
170 注意，table裡面很多參數都是對javaModelGenerator，context等元素的默認屬性的一個復寫；
171 -->
172 <table tableName="userinfo" >
173
174 <!-- 參考 javaModelGenerator 的 constructorBased屬性-->
175 <property name="constructorBased" value="false"/>
176
177 <!-- 默認為false，如果設置為true，在生成的SQL中，table名字不會加上catalog或schema； -->
178 <property name="ignoreQualifiersAtRuntime" value="false"/>
179
180 <!-- 參考 javaModelGenerator 的 immutable 屬性 -->
181 <property name="immutable" value="false"/>
182
183 <!-- 指定是否只生成domain類，如果設置為true，只生成domain類，如果還配置了sqlMapGenerator，那麼在mapper XML文件中，只生成resultMap元素 -->
184 <property name="modelOnly" value="false"/>
185
186 <!-- 參考 javaModelGenerator 的 rootClass 屬性
187 <property name="rootClass" value=""/>
188 -->
189
190 <!-- 參考javaClientGenerator 的 rootInterface 屬性
191 <property name="rootInterface" value=""/>
192 -->
193
194 <!-- 如果設置了runtimeCatalog，那麼在生成的SQL中，使用該指定的catalog，而不是table元素上的catalog
195 <property name="runtimeCatalog" value=""/>
196 -->
197
198 <!-- 如果設置了runtimeSchema，那麼在生成的SQL中，使用該指定的schema，而不是table元素上的schema
199 <property name="runtimeSchema" value=""/>
200 -->
201
202 <!-- 如果設置了runtimeTableName，那麼在生成的SQL中，使用該指定的tablename，而不是table元素上的tablename
203 <property name="runtimeTableName" value=""/>
204 -->
205
206 <!-- 注意，該屬性只針對MyBatis3Simple有用；
207 如果選擇的runtime是MyBatis3Simple，那麼會生成一個SelectAll方法，如果指定了selectAllOrderByClause，那麼會在該SQL中添加指定的這個order條件；
208 -->
209 <property name="selectAllOrderByClause" value="age desc,username asc"/>
210
211 <!-- 如果設置為true，生成的model類會直接使用column本身的名字，而不會再使用駝峰命名方法，比如BORN_DATE，生成的屬性名字就是BORN_DATE,而不會是bornDate -->
212 <property name="useActualColumnNames" value="false"/>
213
214
215 <!-- generatedKey用於生成生成主鍵的方法，
216 如果設置了該元素，MBG會在生成的<insert>元素中生成一條正確的<selectKey>元素，該元素可選
217 column:主鍵的列名；
218 sqlStatement：要生成的selectKey語句，有以下可選項：
219 Cloudscape:相當於selectKey的SQL為： VALUES IDENTITY_VAL_LOCAL()
220 DB2 :相當於selectKey的SQL為： VALUES IDENTITY_VAL_LOCAL()
221 DB2_MF :相當於selectKey的SQL為：SELECT IDENTITY_VAL_LOCAL() FROM SYSIBM.SYSDUMMY1
222 Derby :相當於selectKey的SQL為：VALUES IDENTITY_VAL_LOCAL()
223 HSQLDB :相當於selectKey的SQL為：CALL IDENTITY()
224 Informix :相當於selectKey的SQL為：select dbinfo('sqlca.sqlerrd1') from systables where tabid=1
225 MySql :相當於selectKey的SQL為：SELECT LAST_INSERT_ID()
226 SqlServer :相當於selectKey的SQL為：SELECT SCOPE_IDENTITY()
227 SYBASE :相當於selectKey的SQL為：SELECT @@IDENTITY
228 JDBC :相當於在生成的insert元素上添加useGeneratedKeys="true"和keyProperty屬性
229 <generatedKey column="" sqlStatement=""/>
230 -->
231
232 <!--
233 該元素會在根據表中列名計算對象屬性名之前先重命名列名，非常適合用於表中的列都有公用的前綴字符串的時候，
234 比如列名為：CUST_ID,CUST_NAME,CUST_EMAIL,CUST_ADDRESS等；
235 那麼就可以設置searchString為"^CUST_"，並使用空白替換，那麼生成的Customer對象中的屬性名稱就不是
236 custId,custName等，而是先被替換為ID,NAME,EMAIL,然後變成屬性：id，name，email；
237
238 注意，MBG是使用java.util.regex.Matcher.replaceAll來替換searchString和replaceString的，
239 如果使用了columnOverride元素，該屬性無效；
240
241 <columnRenamingRule searchString="" replaceString=""/>
242 -->
243
244
245 <!-- 用來修改表中某個列的屬性，MBG會使用修改後的列來生成domain的屬性；
246 column:要重新設置的列名；
247 注意，一個table元素中可以有多個columnOverride元素哈~
248 -->
249 <columnOverride column="username">
250 <!-- 使用property屬性來指定列要生成的屬性名稱 -->
251 <property name="property" value="userName"/>
252
253 <!-- javaType用於指定生成的domain的屬性類型，使用類型的全限定名
254 <property name="javaType" value=""/>
255 -->
256
257 <!-- jdbcType用於指定該列的JDBC類型
258 <property name="jdbcType" value=""/>
259 -->
260
261 <!-- typeHandler 用於指定該列使用到的TypeHandler，如果要指定，配置類型處理器的全限定名
262 注意，mybatis中，不會生成到mybatis-config.xml中的typeHandler
263 只會生成類似：where id = #{id,jdbcType=BIGINT,typeHandler=com._520it.mybatis.MyTypeHandler}的參數描述
264 <property name="jdbcType" value=""/>
265 -->
266
267 <!-- 參考table元素的delimitAllColumns配置，默認為false
268 <property name="delimitedColumnName" value=""/>
269 -->
270 </columnOverride>
271
272 <!-- ignoreColumn設置一個MGB忽略的列，如果設置了改列，那麼在生成的domain中，生成的SQL中，都不會有該列出現
273 column:指定要忽略的列的名字；
274 delimitedColumnName：參考table元素的delimitAllColumns配置，默認為false
275
276 注意，一個table元素中可以有多個ignoreColumn元素
277 <ignoreColumn column="deptId" delimitedColumnName=""/>
278 -->
279 </table>
280
281 </context>
282
283 </generatorConfiguration>
View Code
