同學(xué)們有福了,花了一些時(shí)間冷冗,重新整理了一個(gè)最完整的Mybatis Generator(簡稱MBG)的最完整配置文件守屉,帶詳解,再也不用去看EN的User Guide了蒿辙;
<?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><!-- 可以用于加載配置項(xiàng)或者配置文件拇泛,在整個(gè)配置文件中就可以使用${propertyKey}的方式來引用配置項(xiàng)
resource:配置資源加載地址,使用resource思灌,MBG從classpath開始找俺叭,比如com/myproject/generatorConfig.properties
url:配置資源加載地質(zhì),使用URL的方式泰偿,比如file:///C:/myfolder/generatorConfig.properties.
注意熄守,兩個(gè)屬性只能選址一個(gè);
另外,如果使用了mybatis-generator-maven-plugin耗跛,那么在pom.xml中定義的properties都可以直接在generatorConfig.xml中使用
<properties resource="" url="" />
-->
<!-- 在MBG工作的時(shí)候裕照,需要額外加載的依賴包
location屬性指明加載jar/zip包的全路徑
<classPathEntry location="/Program Files/IBM/SQLLIB/java/db2java.zip" />
--><!--
context:生成一組對(duì)象的環(huán)境
id:必選,上下文id调塌,用于在生成錯(cuò)誤時(shí)提示
defaultModelType:指定生成對(duì)象的樣式
1晋南,conditional:類似hierarchical;
2羔砾,flat:所有內(nèi)容(主鍵负间,blob)等全部生成在一個(gè)對(duì)象中;
3蜒茄,hierarchical:主鍵生成一個(gè)XXKey對(duì)象(key class)唉擂,Blob等單獨(dú)生成一個(gè)對(duì)象,其他簡單屬性在一個(gè)對(duì)象中(record class)
targetRuntime:
1檀葛,MyBatis3:默認(rèn)的值玩祟,生成基于MyBatis3.x以上版本的內(nèi)容,包括XXXBySample屿聋;
2空扎,MyBatis3Simple:類似MyBatis3藏鹊,只是不生成XXXBySample;
introspectedColumnImpl:類全限定名转锈,用于擴(kuò)展MBG
--><context id="mysql" defaultModelType="hierarchical" targetRuntime="MyBatis3Simple" >
<!-- 自動(dòng)識(shí)別數(shù)據(jù)庫關(guān)鍵字盘寡,默認(rèn)false,如果設(shè)置為true撮慨,根據(jù)SqlReservedWords中定義的關(guān)鍵字列表竿痰;
一般保留默認(rèn)值,遇到數(shù)據(jù)庫關(guān)鍵字(Java關(guān)鍵字)砌溺,使用columnOverride覆蓋
-->
<property name="autoDelimitKeywords" value="false"/>
<!-- 生成的Java文件的編碼 -->
<property name="javaFileEncoding" value="UTF-8"/>
<!-- 格式化java代碼 -->
<property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
<!-- 格式化XML代碼 -->
<property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
<!-- beginningDelimiter和endingDelimiter:指明數(shù)據(jù)庫的用于標(biāo)記數(shù)據(jù)庫對(duì)象名的符號(hào)影涉,比如ORACLE就是雙引號(hào),MYSQL默認(rèn)是`反引號(hào)规伐; -->
<property name="beginningDelimiter" value="`"/>
<property name="endingDelimiter" value="`"/>
<!-- 必須要有的蟹倾,使用這個(gè)配置鏈接數(shù)據(jù)庫
@TODO:是否可以擴(kuò)展
-->
<jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql:///pss" userId="root" password="admin">
<!-- 這里面可以設(shè)置property屬性,每一個(gè)property屬性都設(shè)置到配置的Driver上 -->
</jdbcConnection>
<!-- java類型處理器
用于處理DB中的類型到Java中的類型猖闪,默認(rèn)使用JavaTypeResolverDefaultImpl鲜棠;
注意一點(diǎn),默認(rèn)會(huì)先嘗試使用Integer培慌,Long豁陆,Short等來對(duì)應(yīng)DECIMAL和 NUMERIC數(shù)據(jù)類型;
-->
<javaTypeResolver type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl">
<!--
true:使用BigDecimal對(duì)應(yīng)DECIMAL和 NUMERIC數(shù)據(jù)類型
false:默認(rèn),
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模型創(chuàng)建器何址,是必須要的元素
負(fù)責(zé):1里逆,key類(見context的defaultModelType);2用爪,java類原押;3,查詢類
targetPackage:生成的類要放的包偎血,真實(shí)的包受enableSubPackages屬性控制诸衔;
targetProject:目標(biāo)項(xiàng)目,指定一個(gè)存在的目錄下颇玷,生成的內(nèi)容會(huì)放到指定目錄中笨农,如果目錄不存在,MBG不會(huì)自動(dòng)建目錄
-->
<javaModelGenerator targetPackage="com._520it.mybatis.domain" targetProject="src/main/java">
<!-- for MyBatis3/MyBatis3Simple
自動(dòng)為每一個(gè)生成的類創(chuàng)建一個(gè)構(gòu)造方法帖渠,構(gòu)造方法包含了所有的field谒亦;而不是使用setter;
-->
<property name="constructorBased" value="false"/>
<!-- 在targetPackage的基礎(chǔ)上,根據(jù)數(shù)據(jù)庫的schema再生成一層package份招,最終生成的類放在這個(gè)package下切揭,默認(rèn)為false -->
<property name="enableSubPackages" value="true"/>
<!-- for MyBatis3 / MyBatis3Simple
是否創(chuàng)建一個(gè)不可變的類,如果為true锁摔,
那么MBG會(huì)創(chuàng)建一個(gè)沒有setter方法的類廓旬,取而代之的是類似constructorBased的類
-->
<property name="immutable" value="false"/>
<!-- 設(shè)置一個(gè)根對(duì)象,
如果設(shè)置了這個(gè)根對(duì)象谐腰,那么生成的keyClass或者recordClass會(huì)繼承這個(gè)類孕豹;在Table的rootClass屬性中可以覆蓋該選項(xiàng)
注意:如果在key class或者record class中有root class相同的屬性,MBG就不會(huì)重新生成這些屬性了怔蚌,包括:
1巩步,屬性名相同,類型相同桦踊,有相同的getter/setter方法;
-->
<property name="rootClass" value="com._520it.mybatis.domain.BaseDomain"/>
<!-- 設(shè)置是否在getter方法中终畅,對(duì)String類型字段調(diào)用trim()方法 -->
<property name="trimStrings" value="true"/>
</javaModelGenerator>
<!-- 生成SQL map的XML文件生成器籍胯,
注意,在Mybatis3之后离福,我們可以使用mapper.xml文件+Mapper接口(或者不用mapper接口)杖狼,
或者只使用Mapper接口+Annotation,所以妖爷,如果 javaClientGenerator配置中配置了需要生成XML的話蝶涩,這個(gè)元素就必須配置
targetPackage/targetProject:同javaModelGenerator
-->
<sqlMapGenerator targetPackage="com._520it.mybatis.mapper" targetProject="src/main/resources">
<!-- 在targetPackage的基礎(chǔ)上,根據(jù)數(shù)據(jù)庫的schema再生成一層package絮识,最終生成的類放在這個(gè)package下绿聘,默認(rèn)為false -->
<property name="enableSubPackages" value="true"/>
</sqlMapGenerator>
<!-- 對(duì)于mybatis來說,即生成Mapper接口次舌,注意熄攘,如果沒有配置該元素,那么默認(rèn)不會(huì)生成Mapper接口
targetPackage/targetProject:同javaModelGenerator
type:選擇怎么生成mapper接口(在MyBatis3/MyBatis3Simple下):
1彼念,ANNOTATEDMAPPER:會(huì)生成使用Mapper接口+Annotation的方式創(chuàng)建(SQL生成在annotation中)挪圾,不會(huì)生成對(duì)應(yīng)的XML;
2逐沙,MIXEDMAPPER:使用混合配置哲思,會(huì)生成Mapper接口,并適當(dāng)添加合適的Annotation吩案,但是XML會(huì)生成在XML中棚赔;
3,XMLMAPPER:會(huì)生成Mapper接口,接口完全依賴XML忆嗜;
注意己儒,如果context是MyBatis3Simple:只支持ANNOTATEDMAPPER和XMLMAPPER
-->
<javaClientGenerator targetPackage="com._520it.mybatis.mapper" type="ANNOTATEDMAPPER" targetProject="src/main/java">
<!-- 在targetPackage的基礎(chǔ)上,根據(jù)數(shù)據(jù)庫的schema再生成一層package捆毫,最終生成的類放在這個(gè)package下闪湾,默認(rèn)為false -->
<property name="enableSubPackages" value="true"/>
<!-- 可以為所有生成的接口添加一個(gè)父接口,但是MBG只負(fù)責(zé)生成绩卤,不負(fù)責(zé)檢查
<property name="rootInterface" value=""/>
-->
</javaClientGenerator>
<!-- 選擇一個(gè)table來生成相關(guān)文件途样,可以有一個(gè)或多個(gè)table,必須要有table元素
選擇的table會(huì)生成一下文件:
1濒憋,SQL map文件
2何暇,生成一個(gè)主鍵類;
3凛驮,除了BLOB和主鍵的其他字段的類煞肾;
4,包含BLOB的類媒熊;
5溯祸,一個(gè)用戶生成動(dòng)態(tài)查詢的條件類(selectByExample, deleteByExample),可選本姥;
6肩袍,Mapper接口(可選)
tableName(必要):要生成對(duì)象的表名;
注意:大小寫敏感問題婚惫。正常情況下氛赐,MBG會(huì)自動(dòng)的去識(shí)別數(shù)據(jù)庫標(biāo)識(shí)符的大小寫敏感度,在一般情況下先舷,MBG會(huì)
根據(jù)設(shè)置的schema艰管,catalog或tablename去查詢數(shù)據(jù)表,按照下面的流程:
1密浑,如果schema蛙婴,catalog或tablename中有空格,那么設(shè)置的是什么格式尔破,就精確的使用指定的大小寫格式去查詢街图;
2,否則懒构,如果數(shù)據(jù)庫的標(biāo)識(shí)符使用大寫的餐济,那么MBG自動(dòng)把表名變成大寫再查找;
3胆剧,否則絮姆,如果數(shù)據(jù)庫的標(biāo)識(shí)符使用小寫的醉冤,那么MBG自動(dòng)把表名變成小寫再查找;
4篙悯,否則蚁阳,使用指定的大小寫格式查詢;
另外的鸽照,如果在創(chuàng)建表的時(shí)候螺捐,使用的""把數(shù)據(jù)庫對(duì)象規(guī)定大小寫,就算數(shù)據(jù)庫標(biāo)識(shí)符是使用的大寫矮燎,在這種情況下也會(huì)使用給定的大小寫來創(chuàng)建表名定血;
這個(gè)時(shí)候,請(qǐng)?jiān)O(shè)置delimitIdentifiers="true"即可保留大小寫格式诞外;
可選:
1澜沟,schema:數(shù)據(jù)庫的schema;
2峡谊,catalog:數(shù)據(jù)庫的catalog茫虽;
3,alias:為數(shù)據(jù)表設(shè)置的別名靖苇,如果設(shè)置了alias席噩,那么生成的所有的SELECT SQL語句中,列名會(huì)變成:alias_actualColumnName
4贤壁,domainObjectName:生成的domain類的名字,如果不設(shè)置埠忘,直接使用表名作為domain類的名字脾拆;可以設(shè)置為somepck.domainName,那么會(huì)自動(dòng)把domainName類再放到somepck包里面莹妒;
5名船,enableInsert(默認(rèn)true):指定是否生成insert語句;
6旨怠,enableSelectByPrimaryKey(默認(rèn)true):指定是否生成按照主鍵查詢對(duì)象的語句(就是getById或get)渠驼;
7,enableSelectByExample(默認(rèn)true):MyBatis3Simple為false鉴腻,指定是否生成動(dòng)態(tài)查詢語句迷扇;
8,enableUpdateByPrimaryKey(默認(rèn)true):指定是否生成按照主鍵修改對(duì)象的語句(即update)爽哎;
9蜓席,enableDeleteByPrimaryKey(默認(rèn)true):指定是否生成按照主鍵刪除對(duì)象的語句(即delete);
10课锌,enableDeleteByExample(默認(rèn)true):MyBatis3Simple為false厨内,指定是否生成動(dòng)態(tài)刪除語句;
11,enableCountByExample(默認(rèn)true):MyBatis3Simple為false雏胃,指定是否生成動(dòng)態(tài)查詢總條數(shù)語句(用于分頁的總條數(shù)查詢)请毛;
12,enableUpdateByExample(默認(rèn)true):MyBatis3Simple為false瞭亮,指定是否生成動(dòng)態(tài)修改語句(只修改對(duì)象中不為空的屬性)方仿;
13,modelType:參考context元素的defaultModelType街州,相當(dāng)于覆蓋兼丰;
14,delimitIdentifiers:參考tableName的解釋唆缴,注意鳍征,默認(rèn)的delimitIdentifiers是雙引號(hào),如果類似MYSQL這樣的數(shù)據(jù)庫面徽,使用的是`(反引號(hào)艳丛,那么還需要設(shè)置context的beginningDelimiter和endingDelimiter屬性)
15,delimitAllColumns:設(shè)置是否所有生成的SQL中的列名都使用標(biāo)識(shí)符引起來趟紊。默認(rèn)為false氮双,delimitIdentifiers參考context的屬性
注意,table里面很多參數(shù)都是對(duì)javaModelGenerator霎匈,context等元素的默認(rèn)屬性的一個(gè)復(fù)寫戴差;
-->
<table tableName="userinfo" >
<!-- 參考 javaModelGenerator 的 constructorBased屬性-->
<property name="constructorBased" value="false"/>
<!-- 默認(rèn)為false,如果設(shè)置為true铛嘱,在生成的SQL中暖释,table名字不會(huì)加上catalog或schema; -->
<property name="ignoreQualifiersAtRuntime" value="false"/>
<!-- 參考 javaModelGenerator 的 immutable 屬性 -->
<property name="immutable" value="false"/>
<!-- 指定是否只生成domain類墨吓,如果設(shè)置為true球匕,只生成domain類,如果還配置了sqlMapGenerator帖烘,那么在mapper XML文件中亮曹,只生成resultMap元素 -->
<property name="modelOnly" value="false"/>
<!-- 參考 javaModelGenerator 的 rootClass 屬性
<property name="rootClass" value=""/>
-->
<!-- 參考javaClientGenerator 的 rootInterface 屬性
<property name="rootInterface" value=""/>
-->
<!-- 如果設(shè)置了runtimeCatalog,那么在生成的SQL中秘症,使用該指定的catalog照卦,而不是table元素上的catalog
<property name="runtimeCatalog" value=""/>
-->
<!-- 如果設(shè)置了runtimeSchema,那么在生成的SQL中历极,使用該指定的schema窄瘟,而不是table元素上的schema
<property name="runtimeSchema" value=""/>
-->
<!-- 如果設(shè)置了runtimeTableName,那么在生成的SQL中趟卸,使用該指定的tablename蹄葱,而不是table元素上的tablename
<property name="runtimeTableName" value=""/>
-->
<!-- 注意氏义,該屬性只針對(duì)MyBatis3Simple有用;
如果選擇的runtime是MyBatis3Simple图云,那么會(huì)生成一個(gè)SelectAll方法惯悠,如果指定了selectAllOrderByClause,那么會(huì)在該SQL中添加指定的這個(gè)order條件竣况;
-->
<property name="selectAllOrderByClause" value="age desc,username asc"/>
<!-- 如果設(shè)置為true克婶,生成的model類會(huì)直接使用column本身的名字,而不會(huì)再使用駝峰命名方法丹泉,比如BORN_DATE情萤,生成的屬性名字就是BORN_DATE,而不會(huì)是bornDate -->
<property name="useActualColumnNames" value="false"/>
<!-- generatedKey用于生成生成主鍵的方法,
如果設(shè)置了該元素摹恨,MBG會(huì)在生成的<insert>元素中生成一條正確的<selectKey>元素筋岛,該元素可選
column:主鍵的列名;
sqlStatement:要生成的selectKey語句晒哄,有以下可選項(xiàng):
Cloudscape:相當(dāng)于selectKey的SQL為: VALUES IDENTITY_VAL_LOCAL()
DB2 :相當(dāng)于selectKey的SQL為: VALUES IDENTITY_VAL_LOCAL()
DB2_MF :相當(dāng)于selectKey的SQL為:SELECT IDENTITY_VAL_LOCAL() FROM SYSIBM.SYSDUMMY1
Derby :相當(dāng)于selectKey的SQL為:VALUES IDENTITY_VAL_LOCAL()
HSQLDB :相當(dāng)于selectKey的SQL為:CALL IDENTITY()
Informix :相當(dāng)于selectKey的SQL為:select dbinfo('sqlca.sqlerrd1') from systables where tabid=1
MySql :相當(dāng)于selectKey的SQL為:SELECT LAST_INSERT_ID()
SqlServer :相當(dāng)于selectKey的SQL為:SELECT SCOPE_IDENTITY()
SYBASE :相當(dāng)于selectKey的SQL為:SELECT @@IDENTITY
JDBC :相當(dāng)于在生成的insert元素上添加useGeneratedKeys="true"和keyProperty屬性
<generatedKey column="" sqlStatement=""/>
-->
<!--
該元素會(huì)在根據(jù)表中列名計(jì)算對(duì)象屬性名之前先重命名列名睁宰,非常適合用于表中的列都有公用的前綴字符串的時(shí)候,
比如列名為:CUST_ID,CUST_NAME,CUST_EMAIL,CUST_ADDRESS等寝凌;
那么就可以設(shè)置searchString為"^CUST_"柒傻,并使用空白替換,那么生成的Customer對(duì)象中的屬性名稱就不是
custId,custName等较木,而是先被替換為ID,NAME,EMAIL,然后變成屬性:id红符,name,email伐债;
注意违孝,MBG是使用java.util.regex.Matcher.replaceAll來替換searchString和replaceString的,
如果使用了columnOverride元素泳赋,該屬性無效;
<columnRenamingRule searchString="" replaceString=""/>
-->
<!-- 用來修改表中某個(gè)列的屬性喇喉,MBG會(huì)使用修改后的列來生成domain的屬性祖今;
column:要重新設(shè)置的列名;
注意拣技,一個(gè)table元素中可以有多個(gè)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中,不會(huì)生成到mybatis-config.xml中的typeHandler
只會(huì)生成類似:where id = #{id,jdbcType=BIGINT,typeHandler=com._520it.mybatis.MyTypeHandler}的參數(shù)描述
<property name="jdbcType" value=""/>
-->
<!-- 參考table元素的delimitAllColumns配置莫辨,默認(rèn)為false
<property name="delimitedColumnName" value=""/>
-->
</columnOverride>
<!-- ignoreColumn設(shè)置一個(gè)MGB忽略的列傲茄,如果設(shè)置了改列毅访,那么在生成的domain中,生成的SQL中盘榨,都不會(huì)有該列出現(xiàn)
column:指定要忽略的列的名字喻粹;
delimitedColumnName:參考table元素的delimitAllColumns配置,默認(rèn)為false
注意草巡,一個(gè)table元素中可以有多個(gè)ignoreColumn元素
<ignoreColumn column="deptId" delimitedColumnName=""/>
-->
</table></context></generatorConfiguration>
好了守呜,就到這里了,可以作為一個(gè)工具文檔查看山憨。
來源:
http://bbs.520it.com/forum.php?mod=viewthread&tid=265&extra=page%3D4