MyBatis Generator 學習說明配置

時間 2019-11-10

標籤 mybatis generator 學習說明配置欄目 MyBatis 简体版

原文原文鏈接

eclipse 裏面使用maven 生成，命令： 工程右鍵 Debug As -> maven build... -> mybatis-generator:generatehtml

http://blog.csdn.net/u011310774/article/details/48269031java

使用這個能夠快速自動生成 model和xml 文件的和接口類，方便而又快速。mysql

官方中文文檔：sql

http://mbg.cndocs.tk/quickstart.html 數據庫

http://www.cnblogs.com/GaiDynasty/p/4088531.htmlapi

MyBatis Generator最佳實踐

本節內容針對MyBatis3，使用iBATIS的不必定適用。mybatis

如下根據我的經驗（對此有意見的能夠留言）對一些配置見解列出以下幾點：app

關於實體類的modelType，建議使用defaultModelType="flat"，只有一個對象的狀況下管理畢竟方便，使用也簡單。dom
關於註釋<commentGenerator>，無論你是否要重寫本身的註釋生成器，有一點不能忘記，那就是註釋中必定要保留@mbggenerated,MBG經過該字符串來判斷代碼是否爲代碼生成器生成的代碼，有該標記的的代碼在從新生成的時候會被刪除，不會重複。不會在XML中出現重複元素。eclipse
使用MBG生成的代碼時，建議儘量不要去修改自動生成的代碼，並且要生成帶有@mbggenerated，這樣纔不會在每次從新生成代碼的時候須要手動修改好多內容。
仍然是註釋相關，在<commentGenerator>中，建議必定要保留suppressAllComments屬性(使用默認值false)，必定要取消(設爲true)時間戳suppressDate，避免重複提交SVN。
<jdbcConnection>建議將JDBC驅動放到項目的**classpath**下，而不是使用<classPathEntry>來引入jar包，主要考慮到全部開發人員的統一性。
當數據庫字段使用CHAR時，建議在<javaModelGenerator>中設置<property name="trimStrings" value="true" />，能夠自動去掉沒必要要的空格。
在<javaClientGenerator>中，建議設置type="XMLMAPPER",不建議使用註解或混合模式，比較代碼和SQL徹底分離易於維護。
建議儘量在<table>中配置<generatedKey>，避免手工操做，以便於MBG重複執行代碼生成。

這裏用的通配符匹配所有的表，另外全部表都有自動增加的id字段。若是不是全部表的配置都同樣，能夠作針對性的配置。

Mybatis generator 自動生成代碼時，insert如何返回主鍵值

地址： http://blog.csdn.net/xyw591238/article/details/51588630

和地址： http://blog.csdn.net/s1146896025/article/details/50434578

若是要讓generator自動添加該功能，能夠以下配置：


<table schema="" tableName="ACT_SecurityBlockLog" domainObjectName="BlockLog"
enableCountByExample="false" enableUpdateByExample="false"
enableDeleteByExample="false" enableSelectByExample="false"
selectByExampleQueryId="false">
<property name="useActualColumnNames" value="true"/>
<generatedKey column="id" sqlStatement="MySql" identity="true"/>

</table>

或者手動增長：

主鍵值有對象.getId()得到

方法只返回成功影響的行數：1

在insert裏面加入selectKey標籤就能夠了. 通常都是返回的int類型.對應數據庫是自增加字段.

要注意的是: ibatis會直接返回int值. Mybatis則把int值包裝在參數對象裏面.

public int insert(User user) {

//ibatis方式.

int result = UserMapper.insert(user);

return result;

//Mybatis方式

user = UserMapper.insert(user);

return user.getId();

}

還要注意的是數據庫類型不同,生成ID的策略也不同. 能夠對selectKey添加屬性(名字忘記了), pre---先生成ID. post---後生成ID. default是post.

MyBatis Generator配置文件context元素的defaultModelType屬性

December 30, 2013 Database Java openwares

MyBatis Generator配置文件context元素有一個defaultModelType屬性,這個屬性的值會影響實體類(或叫domain類,model類)的生成。

這個屬性用於設置產生的模型類型。模型類型定義了MBG如何去產生模型類。對於一些模型類型,MBG會爲每一張表產生單獨的實體類,而其餘的模型類型,MBG會依據表的結構產生一些不一樣的實體類。
這個屬性支持如下三個值:

這是默認值
這個模型與hierarchical模型類似,除了若是一個實體類只包含一個字段,則不會單獨生成此實體類。所以,若是一個表的主鍵只有一個字段,那麼不會爲該字段生成單獨的實體類,會將該字段合併到基本實體類中。

該模型爲每一張表只生成一個實體類。這個實體類包含表中的全部字段。通常使用這個模型就夠了。

若是表有主鍵,那麼該模型會產生一個單獨的主鍵實體類,若是表還有BLOB字段，則會爲表生成一個包含全部BLOB字段的單獨的實體類,而後爲全部其餘的字段生成一個單獨的實體類。MBG會在全部生成的實體類之間維護一個繼承關係。
顯然這個模型比較複雜。

conditional
這是默認值
這個模型與hierarchical模型類似,除了若是一個實體類只包含一個字段,則不會單獨生成此實體類。所以,若是一個表的主鍵只有一個字段,那麼不會爲該字段生成單獨的實體類,會將該字段合併到基本實體類中
flat
該模型爲每一張表只生成一個實體類。這個實體類包含表中的全部字段。通常使用這個模型就夠了。
hierarchical
若是表有主鍵,那麼該模型會產生一個單獨的主鍵實體類,若是表還有BLOB字段，則會爲表生成一個包含全部BLOB字段的單獨的實體類,而後爲全部其餘的字段生成一個單獨的實體類。MBG會在全部生成的實體類之間維護一個繼承關係。
顯然這個模型比較複雜。

更加詳細的說明： http://blog.csdn.net/zsq520520/article/details/50952830

<!-- 能夠用於加載配置項或者配置文件，在整個配置文件中就可使用${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中使用

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

<contextid="mysql" defaultModelType="hierarchical" targetRuntime="MyBatis3Simple" >
    
    <propertyname="autoDelimitKeywords" value="false"/>


<propertyname="javaFileEncoding" value="UTF-8"/>


<propertyname="javaFormatter"value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>


<propertyname="xmlFormatter"value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>


<propertyname="beginningDelimiter" value="`"/>

<propertyname="endingDelimiter" value="`"/>

<javaTypeResolvertype="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl">
        
        <propertyname="forceBigDecimals" value="false"/>
    </javaTypeResolver>

<javaModelGeneratortargetPackage="com._520it.mybatis.domain"targetProject="src/main/java">
        
        <propertyname="constructorBased" value="false"/>
        

<propertyname="enableSubPackages" value="true"/>

<propertyname="immutable" value="false"/>

<propertyname="rootClass" value="com._520it.mybatis.domain.BaseDomain"/>


        <propertyname="trimStrings" value="true"/>
    </javaModelGenerator>


<propertyname="trimStrings" value="true"/>
</javaModelGenerator>

<sqlMapGeneratortargetPackage="com._520it.mybatis.mapper"targetProject="src/main/resources">
        
        <propertyname="enableSubPackages" value="true"/>
    </sqlMapGenerator>

<javaClientGeneratortargetPackage="com._520it.mybatis.mapper"type="ANNOTATEDMAPPER" targetProject="src/main/java">
        
        <propertyname="enableSubPackages" value="true"/>
        <!-- 能夠爲全部生成的接口添加一個父接口，可是MBG只負責生成，不負責檢查
        <propertyname="rootInterface" value=""/>

<!-- 選擇一個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等元素的默認屬性的一個複寫；
-->

<tabletableName="userinfo" >
        
        <propertyname="constructorBased" value="false"/>
        
        <propertyname="ignoreQualifiersAtRuntime" value="false"/>
        
        <propertyname="immutable" value="false"/>
        
        <propertyname="modelOnly" value="false"/>
        <!-- 參考 javaModelGenerator 的 rootClass 屬性
        <propertyname="rootClass" value=""/>