提供的插件 · Java 開源項目中文文檔

# 提供的插件隨著MyBatis生成器（MBG）的使用量的增加，我們發現越來越有用以通過插件增加功能，而不是添加到基本代碼發生器的復雜性。插件是一個模塊化的，易于理解的機制，繼承MBG。有關編寫一個插件的更多信息，請參閱[實現插件](pluggingIn.html) 。有關配置插件的信息，請參閱[<plugin>](../configreference/plugin.html) 所提供的插件都在`org.mybatis.generator.plugins` 包。所提供的插件展示不同類型的可以完成與MBG插件任務。插件的源代碼可以和MBG一起下載，也可以在線瀏覽[這里](https://github.com/mybatis/generator/tree/master/core/mybatis-generator-core/src/main/java/org/mybatis/generator/plugins) 。 ## org.mybatis.generator.plugins.CachePlugin 這個插件在生成的SQL映射中增加了一個<cache>元素。這個插件僅用于MyBatis3目標運行時環境。這個插件接受下列屬性。都是可選的，并且，如果指定，則值將被直接傳遞到相應的屬性生成的<cache>元素。 * cache_eviction * cache_flushInterval * cache_readOnly * cache_size * cache_type 所有屬性都可以通過指定<table>元素的屬性來覆蓋。 ## org.mybatis.generator.plugins.CaseInsensitiveLikePlugin 該插件給Example類添加方法（實際上是給Criteria內部類）來支持不區分大小寫的LIKE搜索。這表明通過插件給Example類添加功能，而不是擴展這個類。 ## org.mybatis.generator.plugins.EqualsHashCodePlugin 這個插件給由MBG生成的Java模型對象增加了`equals`和`hashCode`方法。通過這個類生成的`equals`方法，在大多數情況下是正確的，但如果您已經指定了rootClass可能是不正確的 - 因為我們的equals方法只檢查它知道的字段。 ## org.mybatis.generator.plugins.MapperConfigPlugin 這個插件生成包含對MBG所生成的XML映射文件的框架MapperConfig.xml文件。此文件可用于配置的MyBatis 3.X環境。這個插件接受三個屬性： * `fileName` ??（可選的）生成的文件的名稱。如果沒有指定，默認為“MapperConfig.xml”。 * `targetPackage`（必須的）生成文件放置的包名。指定像“com.mycompany.sql”這樣的值。 * `targetProject`（必須的）該文件應放置在的項目名稱。注： `targetPackage`和`targetProject`遵循sqlMapGenerator配置元素上`targetPackage`和`targetProject`的相同的規則。 ## org.mybatis.generator.plugins.RenameExampleClassPlugin 這個插件通過重命名由MBG生成的Example類的方法演示`initialized`方法的用法。這個插件接受兩個屬性： * `searchString`（必須的），用于搜索默認生成的Example的名稱的正則表達式。 * `replaceString`（必須的）插在匹配`searchString`位置的字符串。例如，從xxxExample重命名生成的例子類xxxCriteria，指定`實例美元searchString`和`標準replaceString` ## org.mybatis.generator.plugins.RowBoundsPlugin 這個插件將添加一個新版本`selectByExample`方法接受`RowBounds`參數。這支持的MyBatis RowBounds函數，其中一個返回的結果列表可以在長度受到限制，并且開始位置可以被指定。這可以是在分頁應用中是有用的。這個插件僅適用于MyBatis3目標運行時環境。 ## org.mybatis.generator.plugins.SerializablePlugin 這個插件給由MBG生成的Javas添加了`java.io.Serializable`標記接口。這個插件給實體類增加了`serialVersionUID`字段。重要提示：這是一個簡單的實現java.io.Serializable并且不會嘗試做任何版本的類。這個插件接受兩個屬性： * `addGWTInterface`（可選的）True/False.。如果為true，插件將給實體對象增加谷歌Web工具包（GWT）的 `IsSerializable`接口。默認值是false。 * `suppressJavaInterface`（必須的）True/False。如果為true，插件將不添加`java.io.Serializable`接口。這是對于其中對象應該是可序列化的GWT，但不是嚴格意義上的Java的場景。默認值是false。 ## org.mybatis.generator.plugins.SqlMapConfigPlugin 這個插件生成包含對MBG所產生的SqlMap.xml文件的SqlMapConfig.xml框架文件。此文件可用于配置的iBATIS 2.x的環境。這個插件接受三個屬性： * `fileName` ??（可選的）所產生的文件的名稱。如果沒有指定，默認值是“SqlMapConfig.xml”。 * `targetPackage`（必須的）放置該文件的包名。指定像“com.mycompany.sql”這樣的值。 * `targetProject（`必須的）放置該文件的項目的名稱。注： `targetPackage`和`targetProject`遵循和sqlMapGenerator配置元素上的`targetPackage`和`targetProject`相同的規則。 ## org.mybatis.generator.plugins.ToStringPlugin 該插件給實體類添加`toString()`方法。 ## org.mybatis.generator.plugins.VirtualPrimaryKeyPlugin 這個插件可用于指定作為主鍵的列，即使它們沒有在數據庫中被定義為主鍵列。這是在數據庫表沒有定義主的情況下非常有用。通常情況下，如果沒有主鍵，MBG將產生一組非常有限的方法。這個插件可以用來啟用生成的完整的MBG方法。要使用該插件，添加屬性“virtualKeyColumns”到您的<table>配置，設置值為應被視做主鍵的用逗號或空格分隔的列名列表。列名必須和數據庫（通常全部大寫）返回的列名完全匹配。例如： ``` <table tableName="foo"> <property name="virtualKeyColumns" value="ID1, ID2" /> </table> ```