原文: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元素
? ? ? ?
? ? ? ? -->? ?