MyBatis Generator中文文檔

MyBatis Generator中文文檔

MyBatis Generator中文文檔地址：

http://mbg.cndocs.tk/

該中文文檔由於儘量和原文內容一致，因此有些地方假設不熟悉，看中文版的文檔的也會有必定的障礙。因此本章依據該中文文檔以及實際應用，使用通俗的語言來解說具體的配置。

本文中所有節點的連接都是相應的中文文檔地址，可以點擊查看具體信息。

下載本文檔的PDF版本號

注:本文後面提到的MBG全部指代MyBatis Generator。

執行MyBatis Generator

有4種執行MBG的方法，詳細請看文檔 執行 MyBatis Generator

MBG下載地址:http://repo1.maven.org/maven2/org/mybatis/generator/mybatis-generator-core/

XML配置具體解釋

在MBG中，最主要也最重要的就是XML配置文件，所以本篇文章基本的內容就是XML配置。

這裏依照配置的順序對配置逐個解說。更細的內容可以配合中文文檔參照。

1. 配置文件頭

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

使用最新版的MBG需要使用上面的xml頭，配置文件必須包括上面的DOCTYPE。

2. 根節點<generatorConfiguration>

generatorConfiguration節點沒有不論什麼屬性。直接寫節點就能夠。例如如下：

<generatorConfiguration>
    <!-- 詳細配置內容 -->
</generatorConfiguration>  

3. <generatorConfiguration>子元素

從這段開始，就是配置的主要內容，這些配置都是generatorConfiguration元素的子元素。

包括下面子元素（有嚴格的順序）：

1. <properties> (0個或1個)

2. <classPathEntry> (0個或多個)

3. <context> (1個或多個)

3.1 <properties> 元素

這個元素用來指定外部的屬性元素。不是必須的元素。

元素用於指定一個需要在配置中解析使用的外部屬性文件，引入屬性文件後，可以在配置中使用 ${property}這樣的形式的引用，經過這樣的方式引用屬性文件裏的屬性值。 對於後面需要配置的**jdbc信息**和targetProject屬性會很是實用。

這個屬性可以經過resource或者url來指定屬性文件的位置，這兩個屬性僅僅能使用當中一個來指定，同一時候出現會報錯。

• resource：指定**classpath**下的屬性文件，使用相似com/myproject/generatorConfig.properties這種屬性值。

• url：可以指定文件系統上的特定位置。好比file:///C:/myfolder/generatorConfig.properties

3.2 <classPathEntry> 元素

這個元素可以0或多個。不受限制。

最多見的使用方法是經過這個屬性指定驅動的路徑，好比：

<classPathEntry location="E:\mysql\mysql-connector-java-5.1.29.jar"/>

重點提醒：本文以前在這裏有誤導。特別強調。

注意，classPathEntry僅僅在如下這兩種狀況下才有效：

• 當載入 JDBC 驅動內省數據庫時
• 當載入根類中的 JavaModelGenerator 檢查重寫的方法時

所以，假設你需要載入其它用途的jar包，classPathEntry起不到做用。不能這麼寫，解決的辦法就是將你用的jar包加入到類路徑中，在Eclipse等IDE中執行的時候，加入jar包比較easy。

當從命令行執行的時候，需要用java -cp xx.jar,xx2.jar xxxMainClass這樣的方式在-cp後面指定來使用(注意-jar會致使-cp無效)。

3.3 <context> 元素

在MBG的配置中，至少需要有一個<context>元素。

<context>元素用於指定生成一組對象的環境。好比指定要鏈接的數據庫，要生成對象的類型和要處理的數據庫中的表。執行MBG的時候還可以指定要執行的<context>。

該元素僅僅有一個**必選屬性**id，用來惟一肯定一個<context>元素，該id屬性可以在執行MBG的使用。

此外還有幾個**可選屬性**：

• defaultModelType:**這個屬性很是重要**。這個屬性定義了MBG怎樣生成**實體類**。

  
  這個屬性有下面可選值：

  • conditional:*這是默認值*,這個模型和如下的hierarchical相似，除了假設那個單獨的類將僅僅包括一個字段，將不會生成一個單獨的類。 所以,假設一個表的主鍵僅僅有一個字段,那麼不會爲該字段生成單獨的實體類,會將該字段合併到基本實體類中。
  • flat:該模型爲每一張表僅僅生成一個實體類。

    這個實體類包括表中的所有字段。

    **這樣的模型最簡單，推薦使用。

    **

  • hierarchical:假設表有主鍵,那麼該模型會產生一個單獨的主鍵實體類,假設表還有BLOB字段。 則會爲表生成一個包括所有BLOB字段的單獨的實體類,而後爲所有其它的字段生成一個單獨的實體類。

    MBG會在所有生成的實體類之間維護一個繼承關係。

• targetRuntime:此屬性用於指定生成的代碼的執行時環境。該屬性支持下面可選值：

  • MyBatis3:*這是默認值*
  • MyBatis3Simple
  • Ibatis2Java2
  • Ibatis2Java5 普通狀況下使用默認值就能夠，有關這些值的具體做用以及差異請查看中文文檔的具體內容。

    
    

• introspectedColumnImpl:該參數可以指定擴展org.mybatis.generator.api.IntrospectedColumn該類的實現類。該屬性的做用可以查看擴展MyBatis Generator。

普通狀況下，咱們使用例如如下的配置就能夠：

<context id="Mysql" defaultModelType="flat">

假設你但願不生成和Example查詢有關的內容，那麼可以依照例如如下進行配置:

<context id="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">

使用MyBatis3Simple可以避免在後面的<table>中逐個進行配置（後面會提到）。

MBG配置中的其它幾個元素，基本上都是<context>的子元素，這些子元素（有嚴格的配置順序）包含：

• <property> (0個或多個)
• <plugin> (0個或多個)
• <commentGenerator> (0個或1個)
• <jdbcConnection> (1個)
• <javaTypeResolver> (0個或1個)
• <javaModelGenerator> (1個)
• <sqlMapGenerator> (0個或1個)
• <javaClientGenerator> (0個或1個)
• <table> (1個或多個)

當中<property>屬性比較特殊，後面解說的時候都會和父元素一塊兒進行解說。在解說<property>屬性前，咱們先看看**什麼是分隔符？**。

這裏經過一個樣例說明。若是在Mysql數據庫中有一個表名爲user info，你沒有看錯，中間是一個空格，這樣的狀況下假設寫出select * from user info這種語句，確定是要報錯的。在Mysql中的時候咱們一般會寫成例如如下的樣子:

select * from `user info`

這裏的使用的**反單引號(`)**就是**分隔符**，**分隔符**可以用於**表名**或者**列名**。

如下繼續看<property>支持的屬性：

• autoDelimitKeywords
• beginningDelimiter
• endingDelimiter
• javaFileEncoding
• javaFormatter
• xmlFormatter

由於這些屬性比較重要，這裏一一解說。

首先是autoDelimitKeywords，當表名或者字段名爲SQLkeyword的時候，可以設置該屬性爲true。MBG會本身主動給表名或字段名加入**分隔符**。

而後這裏繼續上面的樣例來說beginningDelimiter和endingDelimiter屬性。

由於beginningDelimiter和endingDelimiter的默認值爲雙引號(")，在Mysql中不能這麼寫，因此還要將這兩個默認值改成**反單引號(`)**，配置例如如下：

<property name="beginningDelimiter" value="`"/>
<property name="endingDelimiter" value="`"/>  

屬性javaFileEncoding設置要使用的Java文件的編碼，默認使用當前平臺的編碼。僅僅有當生產的編碼需要特殊指定時才需要使用。通常用不到。

最後兩個javaFormatter和xmlFormatter屬性**可能會**很是實用，假設你想使用模板來定製生成的java文件和xml文件的樣式。你可以經過指定這兩個屬性的值來實現。

接下來分節對其它的子元素逐個進行介紹。

3.3.1 <plugin> 元素

該元素可以配置0個或者多個，不受限制。

<plugin>元素用來定義一個插件。

插件用於擴展或改動經過MyBatis Generator (MBG)代碼生成器生成的代碼。

插件將按在配置中配置的順序運行。

有關插件的具體信息可以參考開發插件和提供的插件瞭解不少其它。

3.3.2 <commentGenerator> 元素

該元素最多可以配置1個。

這個元素很是實用。相信很是多人都有過這種需求。就是但願MBG生成的代碼中可以包括**凝視信息**，詳細就是生成表或字段的備註信息。

使用這個元素就能很是easy的實現咱們想要的功能。這裏先介紹該元素，介紹完後會舉例怎樣擴展實現該功能。

該元素有一個可選屬性type,可以指定用戶的實現類，該類需要實現org.mybatis.generator.api.CommentGenerator接口。而且必有一個默認的構造方法。這個屬性接收默認的特殊值DEFAULT，會使用默認的實現類org.mybatis.generator.internal.DefaultCommentGenerator。

默認的實現類中提供了兩個可選屬性。需要經過<property>屬性進行配置。

• suppressAllComments:**阻止**生成凝視，默以爲false
• suppressDate:**阻止**生成的凝視包括時間戳，默以爲false

普通狀況下由於MBG生成的凝視信息沒有不論什麼價值，而且有時間戳的狀況下每次生成的凝視都不同，使用**版本號控制**的時候每次都會提交。於是普通狀況下咱們都會屏蔽凝視信息。可以例如如下配置：

<commentGenerator>
    <property name="suppressAllComments" value="true"/>
    <property name="suppressDate" value="true"/>
</commentGenerator>

接下來咱們簡單舉例實現生成包括表字段凝視信息的凝視

因爲系統提供了一個默認的實現類，因此對咱們來講，本身實現一個會很是easy。最簡單的方法就是複製默認實現類代碼到一個新的文件裏，改動類名如MyCommentGenerator，在你本身的實現類中。你可以選擇是否繼續支持上面的兩個屬性，你還可以添加對其它屬性的支持。

咱們經過如下一個方法的改動來了解，其它幾個方法請自行改動(寫本章的時候我也沒有全然實現該類，因此不提供完整源代碼了):

@Override
public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
    if (introspectedColumn.getRemarks() != null && !introspectedColumn.getRemarks().equals("")) {
        field.addJavaDocLine("/**");
        field.addJavaDocLine(" * " + introspectedColumn.getRemarks());
        addJavadocTag(field, false);
        field.addJavaDocLine(" */");
    }
}

這種方法是給字段加入凝視信息的，當中IntrospectedColumn包括了字段的完整信息，經過getRemarks方法可以獲取字段的凝視信息。

上面這種方法改動起來仍是很是easy的。

除了字段的凝視外還有Getter和Setter，以及類的凝視。此外還有生成XML的凝視，你們可以依據默認的實現進行改動。

完畢咱們本身的實現類後。咱們還需要作例如如下配置：

<commentGenerator type="com.github.abel533.mybatis.generator.MyCommentGenerator"/>

3.3.3 <jdbcConnection> 元素

<jdbcConnection>用於指定數據庫鏈接信息，該元素必選，並且僅僅能有一個。

配置該元素僅僅需要注意假設JDBC驅動不在**classpath**下，就需要經過<classPathEntry>元素引入jar包。這裏**推薦**將jar包放到**classpath**下。

該元素有兩個必選屬性:

• driverClass:訪問數據庫的JDBC驅動程序的全然限定類名
• connectionURL:訪問數據庫的JDBC鏈接URL

該元素還有兩個可選屬性:

• userId:訪問數據庫的用戶ID
• password:訪問數據庫的密碼

此外該元素還可以接受多個<property>子元素，這裏配置的<property>屬性都會加入到JDBC驅動的屬性中。

這個元素配置起來最easy，這裏舉個簡單樣例：

<jdbcConnection driverClass="com.mysql.jdbc.Driver"
                connectionURL="jdbc:mysql://localhost:3306/test"
                userId="root"
                password="">
</jdbcConnection>

3.3.4 <javaTypeResolver> 元素

該元素最多可以配置一個。

這個元素的配置用來指定JDBC類型和Java類型怎樣轉換。

該元素提供了一個可選的屬性type，和<commentGenerator>比較類型。提供了默認的實現DEFAULT，普通狀況下使用默認就能夠。需要特殊處理的狀況可以經過其它元素配置來解決。不建議改動該屬性。

該屬性另外一個可以配置的<property>元素。

可以配置的屬性爲forceBigDecimals，該屬性可以控制是否強制DECIMAL和NUMERIC類型的字段轉換爲Java類型的java.math.BigDecimal,默認值爲false。通常不需要配置。

默認狀況下的轉換規則爲：

1. 假設精度>0或者長度>18。就會使用java.math.BigDecimal
2. 假設精度=0並且10<=長度<=18，就會使用java.lang.Long
3. 假設精度=0並且5<=長度<=9，就會使用java.lang.Integer
4. 假設精度=0並且長度<5，就會使用java.lang.Short

假設設置爲true，那麼必定會使用java.math.BigDecimal，配置示比例如如下：

<javaTypeResolver >
    <property name="forceBigDecimals" value="true" />
</javaTypeResolver>

3.3.5 <javaModelGenerator> 元素

該元素必須配置一個，並且最多一個。

該元素用來控制生成的實體類，依據<context>中配置的defaultModelType，一個表可能會相應生成多個不一樣的實體類。

一個表相應多個類實際上並不方便，所曾經面也推薦使用flat。這樣的狀況下一個表相應一個實體類。

該元素僅僅有兩個屬性，都是必選的。

• targetPackage:生成實體類存放的包名，通常就是放在該包下。實際還會受到其它配置的影響(<table>中會提到)。
• targetProject:指定目標項目路徑。使用的是文件系統的絕對路徑。

該元素支持下面幾個<property>子元素屬性：

• constructorBased:該屬性僅僅對MyBatis3有效，假設true就會使用構造方法入參，假設false就會使用setter方式。

  默以爲false。

• enableSubPackages:假設true，MBG會依據catalog和schema來生成子包。假設false就會直接用targetPackage屬性。

  默以爲false。

• immutable:該屬性用來配置實體類屬性是否可變。假設設置爲true，那麼constructorBased不管設置成什麼，都會使用構造方法入參，並且不會生成setter方法。

  假設爲false，實體類屬性就可以改變。

  默以爲false。

• rootClass:設置所有實體類的基類。假設設置，需要使用類的全限定名稱。並且假設MBG能夠載入rootClass。那麼MBG不會覆蓋和父類中全然匹配的屬性。匹配規則：

  • 屬性名全然一樣
  • 屬性類型一樣
  • 屬性有getter方法
  • 屬性有setter方法

• trimStrings:是否對數據庫查詢結果進行trim操做，假設設置爲true就會生成相似這樣public void setUsername(String username) {this.username = username == null ?

  null : username.trim();}的setter方法。默認值爲false。

配置示比例如如下：

<javaModelGenerator targetPackage="test.model" targetProject="E:\MyProject\src\main\java">
    <property name="enableSubPackages" value="true" />
    <property name="trimStrings" value="true" />
</javaModelGenerator>

3.3.6 <sqlMapGenerator> 元素

該元素可選。最多配置一個。但是有例如如下兩種必選的特殊狀況：

• 假設targetRuntime目標是**iBATIS2**。該元素必須配置一個。

  
  

• 假設targetRuntime目標是**MyBatis3**，僅僅有當<javaClientGenerator>需要XML時，該元素必須配置一個。 假設沒有配置<javaClientGenerator>。則使用下面的規則：
  
  • 假設指定了一個<sqlMapGenerator>，那麼MBG將僅僅生成XML的SQL映射文件和實體類。
  • 假設沒有指定<sqlMapGenerator>，那麼MBG將僅僅生成實體類。

    
    

該元素僅僅有兩個屬性（和前面提過的<javaModelGenerator>的屬性含義同樣），都是必選的。

• targetPackage:生成實體類存放的包名，通常就是放在該包下。實際還會受到其它配置的影響(<table>中會提到)。
• targetProject:指定目標項目路徑。使用的是文件系統的絕對路徑。

該元素支持<property>子元素，僅僅有一個可以配置的屬性：

• enableSubPackages:假設true。MBG會依據catalog和schema來生成子包。

  假設false就會直接用targetPackage屬性。

  默以爲false。

配置演示樣例：

<sqlMapGenerator targetPackage="test.xml"  targetProject="E:\MyProject\src\main\resources">
    <property name="enableSubPackages" value="true" />
</sqlMapGenerator>

3.3.7 <javaClientGenerator> 元素

該元素可選。最多配置一個。

假設不配置該元素，就不會生成Mapper接口。

該元素有3個必選屬性：

• type:該屬性用於選擇一個提早定義的client代碼（可以理解爲Mapper接口）生成器，用戶可以本身定義實現，需要繼承org.mybatis.generator.codegen.AbstractJavaClientGenerator類。必選有一個默認的構造方法。

  該屬性提供了下面預約的代碼生成器，首先依據<context>的targetRuntime分紅三類：
  

  • MyBatis3:
    • ANNOTATEDMAPPER:基於註解的Mapper接口，不會有相應的XML映射文件
    • MIXEDMAPPER:XML和註解的混合形式，(上面這樣的狀況中的)SqlProvider註解方法會被XML替代。
    • XMLMAPPER:所有的方法都在XML中，接口調用依賴XML文件。
      
  • MyBatis3Simple:
    • ANNOTATEDMAPPER:基於註解的Mapper接口，不會有相應的XML映射文件
    • XMLMAPPER:所有的方法都在XML中，接口調用依賴XML文件。

  • Ibatis2Java2或**Ibatis2Java5**:
    • IBATIS:生成的對象符合iBATIS的DAO框架（不建議使用）。

    • GENERIC-CI:生成的對象將僅僅依賴於SqlMapClient，經過構造方法注入。
    • GENERIC-SI:生成的對象將僅僅依賴於SqlMapClient，經過setter方法注入。
    • SPRING:生成的對象符合Spring的DAO接口
• targetPackage:生成實體類存放的包名，通常就是放在該包下。

  實際還會受到其它配置的影響(<table>中會提到)。

• targetProject:指定目標項目路徑，使用的是文件系統的絕對路徑。

該元素另外一個可選屬性：

• implementationPackage:假設指定了該屬性，實現類就會生成在這個包中。

該元素支持<property>子元素設置的屬性：

• enableSubPackages
• exampleMethodVisibility
• methodNameCalculator
• rootInterface
• useLegacyBuilder

這幾個屬性不太常用，詳細做用請看完整的文檔，這裏對rootInterface作個簡介。

rootInterface用於指定一個所有生成的接口都繼承的父接口。

這個值可以經過<table>配置的rootInterface屬性覆蓋。

這個屬性對於通用Mapper來講，可以讓生成的所有接口都繼承該接口。

配置演示樣例：

<javaClientGenerator type="XMLMAPPER" targetPackage="test.dao"
              targetProject="E:\MyProject\src\main\java"/>

3.3.8 <table> 元素

該元素至少要配置一個，可以配置多個。

該元素用來配置要經過內省的表。僅僅有配置的纔會生成實體類和其它文件。

該元素有一個必選屬性：

• tableName：指定要生成的表名，可以使用SQL通配符匹配多個表。

  
  

好比要生成全部的表。可以按例如如下配置：

<table tableName="%" />

該元素包括多個可選屬性：

• schema:數據庫的schema,可以使用SQL通配符匹配。假設設置了該值，生成SQL的表名會變成如schema.tableName的形式。
• catalog:數據庫的catalog，假設設置了該值，生成SQL的表名會變成如catalog.tableName的形式。
• alias:假設指定。這個值會用在生成的select查詢SQL的表的別名和列名上。 列名會被別名爲 alias_actualColumnName(別名_實際列名) 這樣的模式。

• domainObjectName:生成對象的基本名稱。假設沒有指定，MBG會本身主動依據表名來生成名稱。

• enableXXX:XXX表明多種SQL方法，該屬性用來指定是否生成相應的XXX語句。
• selectByPrimaryKeyQueryId:DBA跟蹤工具會用到，具體請看具體文檔。
• selectByExampleQueryId:DBA跟蹤工具會用到，具體請看具體文檔。

• modelType:和<context>的defaultModelType含義同樣。這裏可以針對表進行配置，這裏的配置會覆蓋<context>的defaultModelType配置。
• escapeWildcards:這個屬性表示當查詢列，是否對schema和表名中的SQL通配符 ('_' and '%') 進行轉義。

  對於某些驅動當schema或表名中包括SQL通配符時（好比，一個表名是MY_TABLE，有一些驅動需要將下劃線進行轉義）是必須的。默認值是false。

• delimitIdentifiers:是否給標識符添加**分隔符**。

  默認false。

  當catalog,schema或tableName中包括空白時，默以爲true。

• delimitAllColumns:是否對所有列加入**分隔符**。

  默認false。

該元素包括多個可用的<property>子元素。可選屬性爲：

• constructorBased:和<javaModelGenerator>中的屬性含義同樣。
• ignoreQualifiersAtRuntime:生成的SQL中的表名將不會包括schema和catalog前綴。
• immutable:和<javaModelGenerator>中的屬性含義同樣。
• modelOnly:此屬性用於配置是否爲表僅僅生成實體類。假設設置爲true就不會有Mapper接口。假設配置了<sqlMapGenerator>。並且modelOnly爲true。那麼XML映射文件裏僅僅有實體對象的映射元素(<resultMap>)。

  假設爲true還會覆蓋屬性中的enableXXX方法。將不會生成不論什麼CRUD方法。

• rootClass:和<javaModelGenerator>中的屬性含義同樣。

• rootInterface:和<javaClientGenerator>中的屬性含義同樣。

• runtimeCatalog:執行時的catalog，當生成表和執行環境的表的catalog不同的時候可以使用該屬性進行配置。

• runtimeSchema:執行時的schema。當生成表和執行環境的表的schema不同的時候可以使用該屬性進行配置。
• runtimeTableName:執行時的tableName，當生成表和執行環境的表的tableName不同的時候可以使用該屬性進行配置。
• selectAllOrderByClause:該屬性值會追加到selectAll方法後的SQL中。會直接跟order by拼接後加入到SQL末尾。
• useActualColumnNames:假設設置爲true,那麼MBG會使用從數據庫元數據獲取的列名做爲生成的實體對象的屬性。

  假設爲false(默認值)。MGB將會嘗試將返回的名稱轉換爲駝峯形式。 在這兩種狀況下，可以經過 元素顯示指定。在這樣的狀況下將會忽略這個（useActualColumnNames）屬性。

• useColumnIndexes:假設是true,MBG生成resultMaps的時候會使用列的索引,而不是結果中列名的順序。
• useCompoundPropertyNames:假設是true,那麼MBG生成屬性名的時候會將列名和列備註接起來. 這對於那些經過第四代語言本身主動生成列(好比:FLD22237),但是備註包括實用信息(好比:"customer id")的數據庫來講很是實用. 在這樣的狀況下,MBG會生成屬性名FLD2237_CustomerId。

除了<property>子元素外，<table>還包括下面子元素：

• <generatedKey> (0個或1個)
• <columnRenamingRule> (0個或1個)
• <columnOverride> (0個或多個)
• <ignoreColumn> (0個或多個)

如下對這4個元素進行具體解說。

1. <generatedKey> 元素

這個元素最多可以配置一個。
這個元素用來指定本身主動生成主鍵的屬性（identity字段或者sequences序列）。

假設指定這個元素。MBG在生成insert的SQL映射文件裏插入一個<selectKey>元素。 這個元素**很重要**，這個元素包括如下兩個必選屬性：

• column:生成列的列名。
• sqlStatement:將返回新值的 SQL 語句。假設這是一個identity列。您可以使用當中一個提早定義的的特殊值。

  提早定義值例如如下：
  

  • Cloudscape
  • DB2
  • DB2_MF
  • Derby
  • HSQLDB
  • Informix
  • MySql
  • SqlServer
  • SYBASE
  • JDBC:這會配置MBG使用MyBatis3支持的JDBC標準的生成key來生成代碼。 這是一個獨立於數據庫獲取標識列中的值的方法。 重要: 僅僅有當目標執行爲MyBatis3時纔會產生正確的代碼。 假設與iBATIS2一塊兒使用目標執行時會產生執行時錯誤的代碼。

    
    

這個元素還包括兩個可選屬性：

• identity:當設置爲true時,該列會被標記爲identity列， 並且<selectKey>元素會被插入在insert後面。

  當設置爲false時，<selectKey>會插入到insert以前（通常是序列）。

  **重要**: 即便您type屬性指定爲post，您仍然需要爲identity列將該參數設置爲true。 這將標誌MBG從插入列表中刪除該列。默認值是false。

• type:type=post and identity=true的時候生成的<selectKey>中的order=AFTER,當type=pre的時候。identity僅僅能爲false，生成的<selectKey>中的order=BEFORE。可以這麼理解。本身主動增加的列僅僅有插入到數據庫後才幹獲得ID，因此是AFTER,使用序列時，僅僅有先獲取序列以後。才幹插入數據庫，因此是BEFORE。

配置演示樣例一：

<table tableName="user login info" domainObjectName="UserLoginInfo">
    <generatedKey column="id" sqlStatement="Mysql"/>
</table>

相應的生成的結果：

<insert id="insert" parameterType="test.model.UserLoginInfo">
    <selectKey keyProperty="id" order="BEFORE" resultType="java.lang.Integer">
        SELECT LAST_INSERT_ID()
    </selectKey>
    insert into `user login info` (Id, username, logindate, loginip)
    values (#{id,jdbcType=INTEGER}, #{username,jdbcType=VARCHAR}, #{logindate,jdbcType=TIMESTAMP}, #{loginip,jdbcType=VARCHAR})
</insert>

配置演示樣例二：

<table tableName="user login info" domainObjectName="UserLoginInfo">
    <generatedKey column="id" sqlStatement="select SEQ_ID.nextval from dual"/>
</table>

相應的生成結果：

<insert id="insert" parameterType="test.model.UserLoginInfo">
    <selectKey keyProperty="id" order="BEFORE" resultType="java.lang.Integer">
        select SEQ_ID.nextval from dual
    </selectKey>
    insert into `user login info` (Id, username, logindate, loginip)
    values (#{id,jdbcType=INTEGER}, #{username,jdbcType=VARCHAR}, #{logindate,jdbcType=TIMESTAMP},#{loginip,jdbcType=VARCHAR})
</insert>

2. <columnRenamingRule> 元素

該元素最多可以配置一個，使用該元素可以在生成列以前。對列進行重命名。這對那些存在同一前綴的字段想在生成屬性名時去除前綴的表很實用。 好比若是一個表包括下面的列：

• CUST_BUSINESS_NAME
• CUST_STREET_ADDRESS
• CUST_CITY
• CUST_STATE

生成的所有屬性名中假設都包括CUST的前綴可能會讓人不爽。

這些前綴可以經過例如如下方式定義重命名規則:

<columnRenamingRule searchString="^CUST_" replaceString="" />

注意，在內部，MBG使用java.util.regex.Matcher.replaceAll方法實現這個功能。

請參閱有關該方法的文檔和在Java中使用正則表達式的樣例。

當<columnOverride>匹配一列時。這個元素（<columnRenamingRule>）會被忽略。<columnOverride>優先於重命名的規則。

該元素有一個必選屬性：

• searchString:定義將被替換的字符串的正則表達式。

該元素有一個可選屬性：

• replaceString:這是一個用來替換搜索字符串列每一個匹配項的字符串。假設沒有指定，就會使用空字符串。
  

關於<table>的<property>屬性useActualColumnNames對此的影響可以查看完整文檔。

3. <columnOverride> 元素

該元素可選。可以配置多個。

該元素從將某些屬性默認計算的值更改成指定的值。

該元素有一個必選屬性:

• column:要重寫的列名。

  
  

該元素有多個可選屬性：

• property:要使用的Java屬性的名稱。假設沒有指定，MBG會依據列名生成。

  好比，假設一個表的一列名爲STRT_DTE。MBG會依據<table>的useActualColumnNames屬性生成STRT_DTE或strtDte。

• javaType:該列屬性值爲全然限定的Java類型。

  假設需要，這可以覆蓋由JavaTypeResolver計算出的類型。 對某些數據庫來講。這是必要的用來處理**「奇怪的」**數據庫類型（好比MySql的unsigned bigint類型需要映射爲java.lang.Object)。

• jdbcType:該列的JDBC類型(INTEGER, DECIMAL, NUMERIC, VARCHAR等等)。 假設需要，這可以覆蓋由JavaTypeResolver計算出的類型。

  對某些數據庫來講。這是必要的用來處理怪異的JDBC驅動 (好比DB2的LONGVARCHAR類型需要爲iBATIS 映射爲VARCHAR)。

• typeHandler:用戶定義的需要用來處理這列的類型處理器。它必須是一個繼承iBATIS的TypeHandler類或TypeHandlerCallback接口（該接口很是easy繼承）的全限定的類名。

  假設沒有指定或者是空白。iBATIS會用默認的類型處理器來處理類型。**重要**:MBG不會校驗這個類型處理器是否存在或者可用。 MGB僅僅是簡單的將這個值插入到生成的SQL映射的配置文件裏。

• delimitedColumnName:指定是否應在生成的SQL的列名稱上添加**分隔符**。

  假設列的名稱中包括空格。MGB會本身主動加入**分隔符**， 因此這個重寫僅僅有當列名需要強制爲一個合適的名字或者列名是數據庫中的保留字時是必要的。

配置演示樣例：

<table schema="DB2ADMIN" tableName="ALLTYPES" >
    <columnOverride column="LONG_VARCHAR_FIELD" javaType="java.lang.String" jdbcType="VARCHAR" />
</table>

4. <ignoreColumn> 元素

該元素可選，可以配置多個。

該元素可以用來屏蔽不需要生成的列。

該元素有一個必選屬性：

• column:要忽略的列名。
  

該元素另外一個可選屬性：

• delimitedColumnName:匹配列名的時候是否區分大寫和小寫。假設爲true則區分。默認值爲false。不區分大寫和小寫。
  

MyBatis Generator最佳實踐

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

下面依據我的經驗（對此有意見的可以留言）對一些配置見解列出例如如下幾點：

1. 關於實體類的modelType。建議使用defaultModelType="flat"。僅僅有一個對象的狀況下管理畢竟方便。使用也簡單。

2. 關於凝視<commentGenerator>，不管你是否要重寫本身的凝視生成器，有一點不能忘記。那就是凝視中必定要保留@mbggenerated,MBG經過該字符串來推斷代碼是否爲代碼生成器生成的代碼。有該標記的的代碼在又一次生成的時候會被刪除，不會反覆。

   不會在XML中出現反覆元素。

3. 使用MBG生成的代碼時。建議儘量不要去改動本身主動生成的代碼。而且要生成帶有@mbggenerated。這樣纔不會在每次又一次生成代碼的時候需要手動改動好多內容。

4. 仍然是凝視相關。在<commentGenerator>中。建議必定要保留suppressAllComments屬性(使用默認值false)，必定要取消(設爲true)時間戳suppressDate，避免反覆提交SVN。

5. <jdbcConnection>建議將JDBC驅動放到項目的**classpath**下。而不是使用<classPathEntry>來引入jar包，主要考慮到所有開發者的統一性。

6. 當數據庫字段使用CHAR時，建議在<javaModelGenerator>中設置<property name="trimStrings" value="true" />。可以本身主動去掉沒必要要的空格。

7. 在<javaClientGenerator>中。建議設置type="XMLMAPPER",不建議使用註解或混合模式，比較代碼和SQL全然分離易於維護。

8. 建議儘量在<table>中配置<generatedKey>，避免手工操做，以便於MBG反覆運行代碼生成。

假設有其它有價值的經驗，會繼續補充。

綜合以上信息，這裏給出一個Mysql的簡單配置：

<?
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> <context id="MysqlContext" targetRuntime="MyBatis3" defaultModelType="flat"> <property name="beginningDelimiter" value="`"/> <property name="endingDelimiter" value="`"/> <commentGenerator> <property name="suppressDate" value="true"/> </commentGenerator> <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/test" userId="root" password=""> </jdbcConnection> <javaModelGenerator targetPackage="test.model" targetProject="G:\MyProject\src\main\java"> <property name="trimStrings" value="true" /> </javaModelGenerator> <sqlMapGenerator targetPackage="test.xml" targetProject="G:\MyProject\src\main\resources"/> <javaClientGenerator type="XMLMAPPER" targetPackage="test.dao" targetProject="G:\MyProject\src\main\java"/> <table tableName="%"> <generatedKey column="id" sqlStatement="Mysql"/> </table> </context> </generatorConfiguration> 

<table>這裏用的通配符匹配所有的表，另外所有表都有本身主動增加的id字段。

假設不是所有表的配置都同樣，可以作針對性的配置。

修改：去掉來不建議使用Example查詢的建議，Example在單表操做上優點明顯，可以看我的狀況使用。