轉(zhuǎn):Mybatis Generator配置文件完整配置詳解

原文:https://blog.csdn.net/leoe_/article/details/71194991



?PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"

"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

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中使用

-->


? ? location屬性指明加載jar/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ì)象呻顽,其他簡(jiǎn)單屬性在一個(gè)對(duì)象中(record class)

? ? targetRuntime:

? ? ? ? 1嬉愧,MyBatis3:默認(rèn)的值没酣,生成基于MyBatis3.x以上版本的內(nèi)容,包括XXXBySample偿衰;

? ? ? ? 2,MyBatis3Simple:類似MyBatis3漏设,只是不生成XXXBySample;

? ? introspectedColumnImpl:類全限定名盾鳞,用于擴(kuò)展MBG

-->? ?

? ? ? ? 一般保留默認(rèn)值,遇到數(shù)據(jù)庫關(guān)鍵字(Java關(guān)鍵字)推励,使用columnOverride覆蓋

? ? -->? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?

? ? ? ? @TODO:是否可以擴(kuò)展

? ? -->? ? ? ? ? ? ? ? ? ?

? ? ? ? 用于處理DB中的類型到Java中的類型稿黄,默認(rèn)使用JavaTypeResolverDefaultImpl杆怕;

? ? ? ? 注意一點(diǎn)陵珍,默認(rèn)會(huì)先嘗試使用Integer,Long留潦,Short等來對(duì)應(yīng)DECIMAL和 NUMERIC數(shù)據(jù)類型愤兵;

? ? -->? ? ? ? ? ?

? ? ? ? ? ? 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扯键;

? ? ? ? -->? ? ? ? ? ? ? ?

? ? ? ? 負(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)建目錄

? ? -->? ? ? ? ? ?

? ? ? ? ? ? 自動(dòng)為每一個(gè)生成的類創(chuàng)建一個(gè)構(gòu)造方法闸翅,構(gòu)造方法包含了所有的field;而不是使用setter记某;

? ? ? ? -->? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?

? ? ? ? ? ? 是否創(chuàng)建一個(gè)不可變的類液南,如果為true蓖谢,

? ? ? ? ? ? 那么MBG會(huì)創(chuàng)建一個(gè)沒有setter方法的類,取而代之的是類似constructorBased的類

? ? ? ? -->? ? ? ? ? ? ? ?

? ? ? ? ? ? 如果設(shè)置了這個(gè)根對(duì)象,那么生成的keyClass或者recordClass會(huì)繼承這個(gè)類陨瘩;在Table的rootClass屬性中可以覆蓋該選項(xiàng)

? ? ? ? ? ? 注意:如果在key class或者record class中有root class相同的屬性舌劳,MBG就不會(huì)重新生成這些屬性了,包括:

? ? ? ? ? ? ? ? 1贯卦,屬性名相同,類型相同啡彬,有相同的getter/setter方法外遇;

? ? ? ? -->? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?

? ? ? ? 注意,在Mybatis3之后菲语,我們可以使用mapper.xml文件+Mapper接口(或者不用mapper接口),

? ? ? ? ? ? 或者只使用Mapper接口+Annotation佩憾,所以楞黄,如果 javaClientGenerator配置中配置了需要生成XML的話,這個(gè)元素就必須配置

? ? ? ? targetPackage/targetProject:同javaModelGenerator

? ? -->? ? ? ? ? ? ? ? ? ? ? ? ? ?

? ? ? ? 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

? ? -->? ? ? ? ? ? ? ? ? ? ? ? ? ?

? ? ? ?

? ? ? ? -->? ? ? ?

? ? ? ? 選擇的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ù)寫探赫;

? ? -->? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?

? ? ? ?

? ? ? ? -->? ? ? ?

? ? ? ?

? ? ? ? -->? ? ? ?

? ? ? ?

? ? ? ? -->? ? ? ?

? ? ? ?

? ? ? ? -->? ? ? ?

? ? ? ?

? ? ? ? -->? ? ? ?

? ? ? ? ? ? 如果選擇的runtime是MyBatis3Simple坤检,那么會(huì)生成一個(gè)SelectAll方法,如果指定了selectAllOrderByClause期吓,那么會(huì)在該SQL中添加指定的這個(gè)order條件早歇;

? ? ? ? -->? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?

? ? ? ? ? ? 如果設(shè)置了該元素,MBG會(huì)在生成的元素中生成一條正確的元素讨勤,該元素可選

? ? ? ? ? ? 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屬性

? ? ? ?

? ? ? ? -->? ? ? ?

? ? ? ? ? ? 該元素會(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元素掉冶,該屬性無效;

? ? ? ?

? ? ? ? -->? ? ? ?

? ? ? ? ? ? column:要重新設(shè)置的列名脐雪;

? ? ? ? ? ? 注意厌小,一個(gè)table元素中可以有多個(gè)columnOverride元素哈~

? ? ? ? ? -->? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?

? ? ? ? ? ?

? ? ? ? ? ? ? -->? ? ? ? ? ?

? ? ? ? ? ?

? ? ? ? ? ? ? -->? ? ? ? ? ?

? ? ? ? ? ? ? ? 注意,mybatis中战秋,不會(huì)生成到mybatis-config.xml中的typeHandler

? ? ? ? ? ? ? ? 只會(huì)生成類似:where id = #{id,jdbcType=BIGINT,typeHandler=com._520it.mybatis.MyTypeHandler}的參數(shù)描述

? ? ? ? ? ?

? ? ? ? ? ? -->? ? ? ? ? ?

? ? ? ? ? ?

? ? ? ? ? ? ? -->? ? ? ? ? ? ? ?

? ? ? ? ? ? column:指定要忽略的列的名字璧亚;

? ? ? ? ? ? delimitedColumnName:參考table元素的delimitAllColumns配置,默認(rèn)為false

? ? ? ? ? ? 注意脂信,一個(gè)table元素中可以有多個(gè)ignoreColumn元素

? ? ? ?

? ? ? ? -->? ?

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末癣蟋,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子吉嚣,更是在濱河造成了極大的恐慌,老刑警劉巖蹬铺,帶你破解...
    沈念sama閱讀 216,372評(píng)論 6 498
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件尝哆,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡甜攀,警方通過查閱死者的電腦和手機(jī)秋泄,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,368評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來规阀,“玉大人恒序,你說我怎么就攤上這事∷常” “怎么了歧胁?”我有些...
    開封第一講書人閱讀 162,415評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)厉碟。 經(jīng)常有香客問我喊巍,道長(zhǎng),這世上最難降的妖魔是什么箍鼓? 我笑而不...
    開封第一講書人閱讀 58,157評(píng)論 1 292
  • 正文 為了忘掉前任崭参,我火速辦了婚禮,結(jié)果婚禮上款咖,老公的妹妹穿的比我還像新娘何暮。我一直安慰自己奄喂,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,171評(píng)論 6 388
  • 文/花漫 我一把揭開白布海洼。 她就那樣靜靜地躺著跨新,像睡著了一般。 火紅的嫁衣襯著肌膚如雪贰军。 梳的紋絲不亂的頭發(fā)上玻蝌,一...
    開封第一講書人閱讀 51,125評(píng)論 1 297
  • 那天,我揣著相機(jī)與錄音词疼,去河邊找鬼俯树。 笑死,一個(gè)胖子當(dāng)著我的面吹牛贰盗,可吹牛的內(nèi)容都是我干的许饿。 我是一名探鬼主播,決...
    沈念sama閱讀 40,028評(píng)論 3 417
  • 文/蒼蘭香墨 我猛地睜開眼舵盈,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼陋率!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起秽晚,我...
    開封第一講書人閱讀 38,887評(píng)論 0 274
  • 序言:老撾萬榮一對(duì)情侶失蹤瓦糟,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后赴蝇,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體菩浙,經(jīng)...
    沈念sama閱讀 45,310評(píng)論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,533評(píng)論 2 332
  • 正文 我和宋清朗相戀三年句伶,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了劲蜻。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,690評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡考余,死狀恐怖先嬉,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情楚堤,我是刑警寧澤疫蔓,帶...
    沈念sama閱讀 35,411評(píng)論 5 343
  • 正文 年R本政府宣布,位于F島的核電站身冬,受9級(jí)特大地震影響鳄袍,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜吏恭,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,004評(píng)論 3 325
  • 文/蒙蒙 一拗小、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧樱哼,春花似錦哀九、人聲如沸剿配。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,659評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽呼胚。三九已至,卻和暖如春息裸,著一層夾襖步出監(jiān)牢的瞬間蝇更,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,812評(píng)論 1 268
  • 我被黑心中介騙來泰國(guó)打工呼盆, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留年扩,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 47,693評(píng)論 2 368
  • 正文 我出身青樓访圃,卻偏偏與公主長(zhǎng)得像厨幻,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子腿时,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,577評(píng)論 2 353

推薦閱讀更多精彩內(nèi)容