使用eclipse mybatis generator外掛在maven 專案中自動構建程式碼
本文是參考的別人的文章,因為他的引數說明還算詳細,但是有些是不對的,本人實踐中完善了一下,僅作為本人記錄之用,感謝原作者。
原文地址:http://cqh520llr.iteye.com/blog/2262812
首先說清楚這個工具到底能達到什麼效果:
使用mybatis的時候,專案中我們一般會寫Dao介面,以及Dao介面對用的Mapper檔案這裡面是sql語句,還有可能會建個表對應的實體類(pojo類),而這個工具就是配置好後全部定製化生成出來,可以指定生成的位置,生成的註釋,生成的類名,是否忽略部分欄位等等。。。。。,方便,只是剛開始配置的時候比較麻煩。
有幾個問題可能會出現。
1、找不到驅動類:如果你的倉庫有多個,在驅動jar的地址的時候一定不能指定到另一個倉庫裡面的jar包,雖然他確實存在但還是不會去找的
2、檔案中可以有自己的註釋,但是內容中不要出現‘-’這種橫槓,影響檔案解析
3、生成的類存放的位置路徑targetProject的值應該以專案名開始,比如可以填寫:myproject/src/main/java
4、不要隨意更改元素的順序,有些是有順序要求的,比如context元素的子標籤commentGenerator標籤是在所有property標籤後面的,否則會報錯,本人就犯了這個錯
當然這些錯可以根據錯誤提示進行排除解決。
具體看下面。
1、從eclipse市場搜尋下載mybatis generator
2、新建maven專案
3、src/main/resource下面新建generator.xml檔案,我的內容如下,用到的用不到的都給出了所以比較多,還有說明:
generatorConfig.xml:可以把紅色部分改為自己的先執行起來,然後再仔細看說明
<?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">
<!-- 配置簡單介紹 -->
<!--
properties 可以用來存放一些配置資訊,這樣可以不在這個config檔案裡面存放資料庫的資訊
classPathEntr 用於指明進行資料庫連線所需要使用的jar包的地址,按照jar包的位置填寫就可以
jdbcConnection 用於指明資料庫的配置資訊,我在上面xml的配置裡是使用的property裡的資訊,所有不用寫出來
javaTypeResolver 進行型別轉換的一些資訊forceBigDecimals為false則JDBC DECIMAL、NUMERIC型別解析為Integer,若為true則解析為java.math.BigDecimal,一般我們都會把這個設為false
javaModelGenerator 生成的資料表對應的類存放的位置以及一些轉換資訊enableSubPackages意思是是不是要在你給定的路徑下再生成一級物件名的資料夾一般會設為false。 trimStrings意思是是不是要把資料庫裡返回的資料trim一下去除空格。
sqlMapGenerator 生成的mapper檔案存放的位置資訊等,與上一個類似
javaClientGenerator 生成的DAO檔案的存放位置資訊等,與上一個類似
table 這個是需要轉換的表的資訊,enableDeleteByExample這一類的意思是是不是要生成例子,如果需要可以設定為true。ignoreColumn是需要忽略掉的列名,這一列不要出現在生成的檔案中。columnOverride意思是無論資料庫欄位是何型別,生成的類屬性都是varchar
以上就是最有用的配置資訊,有了這些就可以簡單的生成程式碼了。
生成只要一行程式碼
java -jar mybatis-generator-core-1.3.2.jar -configfile testproject/src/main/resources/generatorConfig.xml -overwrite
//根據自己的配置情況來更改資訊,大概就是這麼個意思。
現在去檢查下,是不是你指定的資料夾裡面有所有的需要的java檔案? -->
<!-- 配置生成器 -->
<generatorConfiguration>
<!--可以用於載入配置項或者配置檔案,在本檔案中就可以使用${propertyKey}的方式來引用所載入的檔案的配置資料
屬性resource:配置資源載入地址,使用resource,MBG從classpath開始找,比如com/myproject/generatorConfig.properties
屬性url: 配置資源載入地質,使用URL的方式,比如file:///C:/myfolder/generatorConfig.properties.
注意:兩個屬性只能使用一個
另外,如果使用了mybatis-generator-maven-plugin,那麼在pom.xml中定義的properties都可以直接在generatorConfig.xml中使用 -->
<properties resource="jdbc.properties "/>
<!-- 在MBG工作的時候,需要額外載入的依賴包,比如連線資料庫的jar包 ,location屬性指明載入jar/zip包的全路徑 -->
<classPathEntry location="D:\maven_space\mysql\mysql-connector-java\5.1.35\mysql-connector-java-5.1.35.jar" />
<!--
context:生成一組物件的環境
****id:必選,上下文id,用於在生成錯誤時提示
****defaultModelType:指定生成物件的樣式
****1,conditional:類似hierarchical;
****2,flat:所有內容(主鍵,blob)等全部生成在一個物件中;
****3,hierarchical:主鍵生成一個XXKey物件(key class),Blob等單獨生成一個物件,其他簡單屬性在一個物件中(record class)
****targetRuntime:
****1,MyBatis3:預設的值,生成基於MyBatis3.x以上版本的內容,包括XXXBySample;
****2,MyBatis3Simple:類似MyBatis3,只是不生成XXXBySample;
****introspectedColumnImpl:類全限定名,用於擴充套件MBG
-->
<context id="mysql" defaultModelType="hierarchical" targetRuntime="MyBatis3Simple" >
<!-- 自動識別資料庫關鍵字,預設false,如果設定為true,根據SqlReservedWords中定義的關鍵字列表;
一般保留預設值,遇到資料庫關鍵字(Java關鍵字),使用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:指明資料庫的用於標記資料庫物件名的符號,比如ORACLE就是雙引號,MYSQL預設是`反引號; -->
<property name="beginningDelimiter" value="`"/>
<property name="endingDelimiter" value="`"/>
<!-- 註釋生成器-->
<commentGenerator >
<property name="suppressAllComments" value="true"/> <!-- 取消註釋 -->
<property name="suppressDate" value="true" /> <!-- 取消註釋時間戳-->
</commentGenerator>
<!-- jdbcConnection是必須要有的,使用這個配置連結資料庫 @TODO:是否可以擴充套件 -->
<jdbcConnection driverClass="${jdbc.driverClassName}"
connectionURL="${jdbc.url}"
userId="${jdbc.username}"
password="${jdbc.password}">
<!-- 這裡面可以設定property屬性,每一個property屬性都設定到配置的Driver上 -->
</jdbcConnection>
<!-- java型別處理器
用於處理DB中的型別到Java中的型別,預設使用JavaTypeResolverDefaultImpl;
注意一點,預設會先嚐試使用Integer,Long,Short等來對應DECIMAL和 NUMERIC資料型別;
-->
<javaTypeResolver type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl">
<!--
true:使用BigDecimal對應DECIMAL和 NUMERIC資料型別
false:預設,
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模型建立器,是必須要的元素
負責:1,key類(見context的defaultModelType);2,java類;3,查詢類
targetPackage:生成的類要放的包,真實的包受enableSubPackages屬性控制;
targetProject:目標專案,指定一個存在的目錄下,生成的內容會放到指定目錄中,如果目錄不存在,MBG不會自動建目錄
-->
<javaModelGenerator targetPackage="com.weixin.pojo" targetProject="weixin/src/main/java">
<!-- for MyBatis3/MyBatis3Simple
自動為每一個生成的類建立一個構造方法,構造方法包含了所有的field;而不是使用setter;
-->
<property name="constructorBased" value="false"/>
<!-- 在targetPackage的基礎上,根據資料庫的schema再生成一層package,最終生成的類放在這個package下,預設為false -->
<property name="enableSubPackages" value="false"/>
<!-- for MyBatis3 / MyBatis3Simple
是否建立一個不可變的類,如果為true,
那麼MBG會建立一個沒有setter方法的類,取而代之的是類似constructorBased的類-->
<property name="immutable" value="false"/>
<!-- 設定一個根物件,
如果設定了這個根物件,那麼生成的keyClass或者recordClass會繼承這個類;在Table的rootClass屬性中可以覆蓋該選項
注意:如果在key class或者record class中有root class相同的屬性,MBG就不會重新生成這些屬性了,包括:
1,屬性名相同,型別相同,有相同的getter/setter方法;
<property name="rootClass" value="com._520it.mybatis.domain.BaseDomain"/>
-->
<!-- 設定是否在getter方法中,對String型別欄位呼叫trim()方法 -->
<property name="trimStrings" value="true"/>
</javaModelGenerator>
<!-- XML檔案生成器,生成SQL map
注意,在Mybatis3之後,我們可以使用mapper.xml檔案+Mapper介面(或者不用mapper介面),
或者只使用Mapper介面+Annotation,所以,如果 javaClientGenerator配置中配置了需要生成XML的話,這個元素就必須配置
-->
<sqlMapGenerator targetPackage="com.weixin.dao.mapper" targetProject="weixin/src/main/java">
<!-- 在targetPackage的基礎上,根據資料庫的schema再生成一層package,最終生成的類放在這個package下,預設為false -->
<property name="enableSubPackages" value="false"/>
</sqlMapGenerator>
<!-- 對於mybatis來說,即生成Mapper(Dao)介面,注意,如果沒有配置該元素,那麼預設不會生成Mapper介面
targetPackage/targetProject:同javaModelGenerator
type:選擇怎麼生成mapper介面(在MyBatis3/MyBatis3Simple下):
1,ANNOTATEDMAPPER:會生成使用Mapper介面+Annotation的方式建立(SQL生成在annotation中),不會生成對應的XML;
2,MIXEDMAPPER:使用混合配置,會生成Mapper介面,並適當新增合適的Annotation,但是XML會生成在XML中;
3,XMLMAPPER:會生成Mapper介面,介面完全依賴XML;
注意,如果context是MyBatis3Simple:只支援ANNOTATEDMAPPER和XMLMAPPER
-->
<javaClientGenerator targetPackage="com.weixin.dao" type="XMLMAPPER" targetProject="weixin/src/main/java">
<!-- 在targetPackage的基礎上,根據資料庫的schema再生成一層package,最終生成的類放在這個package下,預設為false -->
<property name="enableSubPackages" value="false"/>
<!-- 可以為所有生成的介面新增一個父介面,但是MBG只負責生成,不負責檢查
<property name="rootInterface" value=""/>
-->
</javaClientGenerator>
<!-- 選擇一個table來生成相關檔案,可以有一個或多個table,必須要有table元素
選擇的table會生成一下檔案:
1,SQL map檔案
2,生成一個主鍵類;
3,除了BLOB和主鍵的其他欄位的類;
4,包含BLOB的類;
5,一個使用者生成動態查詢的條件類(selectByExample, deleteByExample),可選;
6,Mapper介面(可選)
tableName(必要):要生成物件的表名;
注意:大小寫敏感問題。正常情況下,MBG會自動的去識別資料庫識別符號的大小寫敏感度,在一般情況下,MBG會
根據設定的schema,catalog或tablename去查詢資料表,按照下面的流程:
1,如果schema,catalog或tablename中有空格,那麼設定的是什麼格式,就精確的使用指定的大小寫格式去查詢;
2,否則,如果資料庫的識別符號使用大寫的,那麼MBG自動把表名變成大寫再查詢;
3,否則,如果資料庫的識別符號使用小寫的,那麼MBG自動把表名變成小寫再查詢;
4,否則,使用指定的大小寫格式查詢;
另外的,如果在建立表的時候,使用的""把資料庫物件規定大小寫,就算資料庫識別符號是使用的大寫,在這種情況下也會使用給定的大小寫來建立表名;
這個時候,請設定delimitIdentifiers="true",即可保留大小寫格式;
可選:
1,schema:資料庫的schema;
2,catalog:資料庫的catalog;
3,alias:為資料表設定的別名,如果設定了alias,那麼生成的所有的SELECT SQL語句中,列名會變成:alias_actualColumnName
4,domainObjectName:生成的domain類的名字,如果不設定,直接使用表名作為domain類的名字;可以設定為somepck.domainName,那麼會自動把domainName類再放到somepck包裡面;
5,enableInsert(預設true):指定是否生成insert語句;
6,enableSelectByPrimaryKey(預設true):指定是否生成按照主鍵查詢物件的語句(就是getById或get);
7,enableSelectByExample(預設true):MyBatis3Simple為false,指定是否生成動態查詢語句;
8,enableUpdateByPrimaryKey(預設true):指定是否生成按照主鍵修改物件的語句(即update);
9,enableDeleteByPrimaryKey(預設true):指定是否生成按照主鍵刪除物件的語句(即delete);
10,enableDeleteByExample(預設true):MyBatis3Simple為false,指定是否生成動態刪除語句;
11,enableCountByExample(預設true):MyBatis3Simple為false,指定是否生成動態查詢總條數語句(用於分頁的總條數查詢);
12,enableUpdateByExample(預設true):MyBatis3Simple為false,指定是否生成動態修改語句(只修改物件中不為空的屬性);
13,modelType:參考context元素的defaultModelType,相當於覆蓋;
14,delimitIdentifiers:參考tableName的解釋,注意,預設的delimitIdentifiers是雙引號,如果類似MYSQL這樣的資料庫,使用的是`(反引號,那麼還需要設定context的beginningDelimiter和endingDelimiter屬性)
15,delimitAllColumns:設定是否所有生成的SQL中的列名都使用識別符號引起來。預設為false,delimitIdentifiers參考context的屬性
注意,table裡面很多引數都是對javaModelGenerator,context等元素的預設屬性的一個複寫;domainObjectName是生成的實體類使用的名稱
-->
<table tableName="user_t" domainObjectName="TestUser">
<!-- 參考 javaModelGenerator 的 constructorBased屬性-->
<property name="constructorBased" value="false"/>
<!-- 預設為false,如果設定為true,在生成的SQL中,table名字不會加上catalog或schema; -->
<property name="ignoreQualifiersAtRuntime" value="false"/>
<!-- 參考 javaModelGenerator 的 immutable 屬性 -->
<property name="immutable" value="false"/>
<!-- 指定是否只生成domain類,如果設定為true,只生成domain類,如果還配置了sqlMapGenerator,那麼在mapper XML檔案中,只生成resultMap元素 -->
<property name="modelOnly" value="false"/>
<!-- 參考 javaModelGenerator 的 rootClass 屬性
<property name="rootClass" value=""/>
-->
<!-- 參考javaClientGenerator 的 rootInterface 屬性
<property name="rootInterface" value=""/>
-->
<!-- 如果設定了runtimeCatalog,那麼在生成的SQL中,使用該指定的catalog,而不是table元素上的catalog
<property name="runtimeCatalog" value=""/>
-->
<!-- 如果設定了runtimeSchema,那麼在生成的SQL中,使用該指定的schema,而不是table元素上的schema
<property name="runtimeSchema" value=""/>
-->
<!-- 如果設定了runtimeTableName,那麼在生成的SQL中,使用該指定的tablename,而不是table元素上的tablename
<property name="runtimeTableName" value=""/>
-->
<!-- 注意,該屬性只針對MyBatis3Simple有用;
如果選擇的runtime是MyBatis3Simple,那麼會生成一個SelectAll方法,如果指定了selectAllOrderByClause,那麼會在該SQL中新增指定的這個order條件;
-->
<property name="selectAllOrderByClause" value="age desc,username asc"/>
<!-- 如果設定為true,生成的model類會直接使用column本身的名字,而不會再使用駝峰命名方法,比如BORN_DATE,生成的屬性名字就是BORN_DATE,而不會是bornDate -->
<property name="useActualColumnNames" value="false"/>
<!-- generatedKey用於生成生成主鍵的方法,
如果設定了該元素,MBG會在生成的<insert>元素中生成一條正確的<selectKey>元素,該元素可選
column:主鍵的列名;
sqlStatement:要生成的selectKey語句,有以下可選項:
Cloudscape:相當於selectKey的SQL為: VALUES IDENTITY_VAL_LOCAL()
DB2 :相當於selectKey的SQL為: VALUES IDENTITY_VAL_LOCAL()
DB2_MF :相當於selectKey的SQL為:SELECT IDENTITY_VAL_LOCAL() FROM SYSIBM.SYSDUMMY1
Derby :相當於selectKey的SQL為:VALUES IDENTITY_VAL_LOCAL()
HSQLDB :相當於selectKey的SQL為:CALL IDENTITY()
Informix :相當於selectKey的SQL為:select dbinfo('sqlca.sqlerrd1') from systables where tabid=1
MySql :相當於selectKey的SQL為:SELECT LAST_INSERT_ID()
SqlServer :相當於selectKey的SQL為:SELECT SCOPE_IDENTITY()
SYBASE :相當於selectKey的SQL為:SELECT @@IDENTITY
JDBC :相當於在生成的insert元素上新增useGeneratedKeys="true"和keyProperty屬性
<generatedKey column="" sqlStatement=""/>
-->
<!--
該元素會在根據表中列名計算物件屬性名之前先重新命名列名,非常適合用於表中的列都有公用的字首字串的時候,
比如列名為:CUST_ID,CUST_NAME,CUST_EMAIL,CUST_ADDRESS等;
那麼就可以設定searchString為"^CUST_",並使用空白替換,那麼生成的Customer物件中的屬性名稱就不是
custId,custName等,而是先被替換為ID,NAME,EMAIL,然後變成屬性:id,name,email;
注意,MBG是使用java.util.regex.Matcher.replaceAll來替換searchString和replaceString的,
如果使用了columnOverride元素,該屬性無效;
<columnRenamingRule searchString="" replaceString=""/>
-->
<!-- 用來修改表中某個列的屬性,MBG會使用修改後的列來生成domain的屬性;
column:要重新設定的列名;
注意,一個table元素中可以有多個columnOverride元素哈~
-->
<columnOverride column="user_name">
<!-- 使用property屬性來指定列要生成的屬性名稱 -->
<property name="property" value="userName"/>
<!-- javaType用於指定生成的domain的屬性型別,使用型別的全限定名
<property name="javaType" value=""/>
-->
<!-- jdbcType用於指定該列的JDBC型別
<property name="jdbcType" value=""/>
-->
<!-- typeHandler 用於指定該列使用到的TypeHandler,如果要指定,配置型別處理器的全限定名
注意,mybatis中,不會生成到mybatis-config.xml中的typeHandler
只會生成類似:where id = #{id,jdbcType=BIGINT,typeHandler=com._520it.mybatis.MyTypeHandler}的引數描述
<property name="jdbcType" value=""/>
-->
<!-- 參考table元素的delimitAllColumns配置,預設為false
<property name="delimitedColumnName" value=""/>
-->
</columnOverride>
<!--ignoreColumn設定一個MGB忽略的列,如果設定了改列,那麼在生成的domain中,生成的SQL中,都不會有該列出現
column:指定要忽略的列的名字;
delimitedColumnName:參考table元素的delimitAllColumns配置,預設為false
注意,一個table元素中可以有多個ignoreColumn元素
<ignoreColumn column="deptId" delimitedColumnName=""/>
-->
</table>
</context>
</generatorConfiguration>
pom.xml 引入工具使用的jar包
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.2</version>
</dependency>
執行:有兩種方式
方式1、選中generatorConfig.xml,右鍵,點選‘Generate Mybatis/iBATIS Artifacts’ ,點選OK,即運行了,看對應的包下面是不是生成了響應的檔案,重複執行會對檔案內容不會覆蓋,只會追加,不知道是不是還有那個地方沒配置好。
方式2、點選頂部工具欄的run as 下三角,選中有Mybatis 圖示的那個(一看就知道),這個沒有確認視窗,會直接執行,但是有可能需要一個地方(點選run as裡面的Run Configurations...,然後如下圖)。
把專案新增進去,然後再使用這種執行方式。