mybatis-generator自動(dòng)生成dao、mapping、bean配置操作
我就廢話不多說了,大家還是直接看代碼吧~
<?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}的方式來(lái)引用配置項(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ì)象,其他簡(jiǎn)單屬性在一個(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ù)庫(kù)關(guān)鍵字,默認(rèn)false,如果設(shè)置為true,根據(jù)SqlReservedWords中定義的關(guān)鍵字列表; 一般保留默認(rèn)值,遇到數(shù)據(jù)庫(kù)關(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ù)庫(kù)的用于標(biāo)記數(shù)據(jù)庫(kù)對(duì)象名的符號(hào),比如ORACLE就是雙引號(hào),MYSQL默認(rèn)是`反引號(hào); --> <property name="beginningDelimiter" value="`"/> <property name="endingDelimiter" value="`"/> <!-- 必須要有的,使用這個(gè)配置鏈接數(shù)據(jù)庫(kù) @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等來(lái)對(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ù)庫(kù)的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ù)庫(kù)的schema再生成一層package,最終生成的類放在這個(gè)package下,默認(rèn)為false --> <property name="enableSubPackages" value="true"/> </sqlMapGenerator> <!-- 對(duì)于mybatis來(lái)說,即生成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ù)庫(kù)的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來(lái)生成相關(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ù)庫(kù)標(biāo)識(shí)符的大小寫敏感度,在一般情況下,MBG會(huì) 根據(jù)設(shè)置的schema,catalog或tablename去查詢數(shù)據(jù)表,按照下面的流程: 1,如果schema,catalog或tablename中有空格,那么設(shè)置的是什么格式,就精確的使用指定的大小寫格式去查詢; 2,否則,如果數(shù)據(jù)庫(kù)的標(biāo)識(shí)符使用大寫的,那么MBG自動(dòng)把表名變成大寫再查找; 3,否則,如果數(shù)據(jù)庫(kù)的標(biāo)識(shí)符使用小寫的,那么MBG自動(dòng)把表名變成小寫再查找; 4,否則,使用指定的大小寫格式查詢; 另外的,如果在創(chuàng)建表的時(shí)候,使用的""把數(shù)據(jù)庫(kù)對(duì)象規(guī)定大小寫,就算數(shù)據(jù)庫(kù)標(biāo)識(shí)符是使用的大寫,在這種情況下也會(huì)使用給定的大小寫來(lái)創(chuàng)建表名; 這個(gè)時(shí)候,請(qǐng)?jiān)O(shè)置delimitIdentifiers="true"即可保留大小寫格式; 可選: 1,schema:數(shù)據(jù)庫(kù)的schema; 2,catalog:數(shù)據(jù)庫(kù)的catalog; 3,alias:為數(shù)據(jù)表設(shè)置的別名,如果設(shè)置了alias,那么生成的所有的SELECT SQL語(yǔ)句中,列名會(huì)變成:alias_actualColumnName 4,domainObjectName:生成的domain類的名字,如果不設(shè)置,直接使用表名作為domain類的名字;可以設(shè)置為somepck.domainName,那么會(huì)自動(dòng)把domainName類再放到somepck包里面; 5,enableInsert(默認(rèn)true):指定是否生成insert語(yǔ)句; 6,enableSelectByPrimaryKey(默認(rèn)true):指定是否生成按照主鍵查詢對(duì)象的語(yǔ)句(就是getById或get); 7,enableSelectByExample(默認(rèn)true):MyBatis3Simple為false,指定是否生成動(dòng)態(tài)查詢語(yǔ)句; 8,enableUpdateByPrimaryKey(默認(rèn)true):指定是否生成按照主鍵修改對(duì)象的語(yǔ)句(即update); 9,enableDeleteByPrimaryKey(默認(rèn)true):指定是否生成按照主鍵刪除對(duì)象的語(yǔ)句(即delete); 10,enableDeleteByExample(默認(rèn)true):MyBatis3Simple為false,指定是否生成動(dòng)態(tài)刪除語(yǔ)句; 11,enableCountByExample(默認(rèn)true):MyBatis3Simple為false,指定是否生成動(dòng)態(tài)查詢總條數(shù)語(yǔ)句(用于分頁(yè)的總條數(shù)查詢); 12,enableUpdateByExample(默認(rèn)true):MyBatis3Simple為false,指定是否生成動(dòng)態(tài)修改語(yǔ)句(只修改對(duì)象中不為空的屬性); 13,modelType:參考context元素的defaultModelType,相當(dāng)于覆蓋; 14,delimitIdentifiers:參考tableName的解釋,注意,默認(rèn)的delimitIdentifiers是雙引號(hào),如果類似MYSQL這樣的數(shù)據(jù)庫(kù),使用的是`(反引號(hào),那么還需要設(shè)置context的beginningDelimiter和endingDelimiter屬性) 15,delimitAllColumns:設(shè)置是否所有生成的SQL中的列名都使用標(biāo)識(shí)符引起來(lái)。默認(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語(yǔ)句,有以下可選項(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來(lái)替換searchString和replaceString的, 如果使用了columnOverride元素,該屬性無(wú)效; <columnRenamingRule searchString="" replaceString=""/> --> <!-- 用來(lái)修改表中某個(gè)列的屬性,MBG會(huì)使用修改后的列來(lái)生成domain的屬性; column:要重新設(shè)置的列名; 注意,一個(gè)table元素中可以有多個(gè)columnOverride元素哈~ --> <columnOverride column="username"> <!-- 使用property屬性來(lái)指定列要生成的屬性名稱 --> <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>
補(bǔ)充知識(shí):Springboot整合mybatis繼承mapper接口,擴(kuò)展自己的dao接口
這里主要介紹Mybatis-Generator自動(dòng)生成model、mapper后,如何在已有的基礎(chǔ)上去擴(kuò)展,寫一些比較復(fù)雜的接口以及我自己遇到的坑。
前景
依靠自己在項(xiàng)目上的經(jīng)驗(yàn)和網(wǎng)上查找的資料,自己搭建了springboot項(xiàng)目,集成mybatis后,通過測(cè)試,發(fā)現(xiàn)一切OK。但是mybatis自動(dòng)生成的mapper里面的接口只是一些基礎(chǔ)的接口,所以需要去擴(kuò)展它。為防止下次表如果有變動(dòng)再重新生成mapper文件會(huì)造成原有的接口被覆蓋,只能自己另寫一個(gè)文件,**dao。
準(zhǔn)備
mybatis自動(dòng)生成的mapper文件我放在了com.example.mapper包底下,然后另外新建一個(gè)包c(diǎn)om.example.dao里面放繼承mapper的文件。
然后在里面寫自己需要的接口
接下來(lái)就是我遇到的坑。
在resources文件夾下,找不到新建包的按鈕。所以我拷貝了別的文件夾下面的包,然后修改了一下包名(mybatis自動(dòng)生成的mapper.xml的包也是拷貝的,一開始沒有任何異常)
自動(dòng)生成的包名叫mybatis.mapping,相對(duì)應(yīng)userDao的包名叫mybatis.mapping.dao,寫好查詢語(yǔ)句后,準(zhǔn)備測(cè)試。
測(cè)試之前我還專門檢查了一遍,確認(rèn)沒有問題。
結(jié)果報(bào)了org.apache.ibatis.binding.BindingException: Invalid bound statement (not found)
百度了一下,解決方法無(wú)非檢查命名是否有誤和一致。確認(rèn)真的無(wú)誤后,還是一樣報(bào)錯(cuò)。
這時(shí)候無(wú)意打開resources所在的文件夾,發(fā)現(xiàn),另一個(gè)包出現(xiàn)問題,原本mybatis.mapping.dao應(yīng)該是mybatis/mapping/dao,然后卻是有一個(gè)叫mybatis.mapping.dao的文件夾
把它刪掉,重新在mybatis/mapping/dao下新建userDao.xml文件就可以運(yùn)行了。
以上這篇mybatis-generator自動(dòng)生成dao、mapping、bean配置操作就是小編分享給大家的全部?jī)?nèi)容了,希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
相關(guān)文章
java實(shí)現(xiàn)文件讀寫與壓縮實(shí)例
這篇文章主要介紹了java實(shí)現(xiàn)文件讀寫與壓縮實(shí)例,有助于讀者加深對(duì)文件操作的理解,需要的朋友可以參考下2014-07-07java 實(shí)現(xiàn)將Object類型轉(zhuǎn)換為int類型
這篇文章主要介紹了java 實(shí)現(xiàn)將Object類型轉(zhuǎn)換為int類型的操作,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-07-07Spring WebSocket 404錯(cuò)誤的解決方法
這篇文章主要為大家詳細(xì)介紹了Spring WebSocket 404錯(cuò)誤的解決方法,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2017-12-12SpringBoot使用Sa-Token實(shí)現(xiàn)權(quán)限認(rèn)證
本文主要介紹了SpringBoot使用Sa-Token實(shí)現(xiàn)權(quán)限認(rèn)證,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2023-04-04Spring的BeanFactoryPostProcessor接口示例代碼詳解
這篇文章主要介紹了Spring的BeanFactoryPostProcessor接口,本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2021-02-02idea 普通文件夾 轉(zhuǎn)換成 module操作
這篇文章主要介紹了idea 普通文件夾 轉(zhuǎn)換成 module操作,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過來(lái)看看吧2020-08-08