&lt;context&gt; 元素 · Java 開源項目中文文檔

# <context> 元素 <context> 元素用于指定生成一組對象的環境。子元素用于指定要連接到的數據庫、要生成對象的類型和要內省的表。多個 <context> 元素可以在 [<generatorConfiguration>](generatorConfiguration.html) 元素中列出來，這樣可以在同一個MyBatis Generator (MBG)從不同的數據庫或者使用不同的生成生成器參數生成對象。 ## 必選屬性 | 屬性 | 描述 | | --- | --- | | id | context唯一的標識符。此值將用于某些錯誤消息。 | ## 可選屬性 | 屬性 | 描述 | | --- | --- | | defaultModelType | 這個屬性用來設置生成對象類型的默認值。對象類型定義了MBG如何生成實體類。對某些對象類型，MBG會給每一個表生成一個單獨的實體類。對另外一些對象類型，MBG會根據表結構生成不同的類。這個屬性有以下可選值： | | | conditional _這是默認值_ 這個模型和hierarchical類似，除了如果那個單獨的類將只包含一個字段，將不會生成一個單獨的類。因此,如果一個表的主鍵只有一個字段,那么不會為該字段生成單獨的實體類,會將該字段合并到基本實體類中。 | | | flat 該模型為每一張表只生成一個實體類。這個實體類包含表中的所有字段。 | | | hierarchical 如果表有主鍵,那么該模型會產生一個單獨的主鍵實體類,如果表還有BLOB字段，則會為表生成一個包含所有BLOB字段的單獨的實體類,然后為所有其他的字段生成一個單獨的實體類。 MBG會在所有生成的實體類之間維護一個繼承關系（注：BLOB類繼承其他字段類繼承主鍵類）。 | | targetRuntime | 此屬性用于指定生成的代碼的運行時目標。該屬性支持這些特殊的值： | | | MyBatis3 _這是默認值_ 使用這值的時候，MBG會生成兼容MyBatis 3.0或更高版本，兼容JSE 5.0或更高版本的對象（例如Java模型類和Mapper接口會使用泛型）。這些生成對象中的"by example"方法將支持幾乎不受限制的動態的where子句。另外，這些生成器生成的Java對象支持JSE 5.0特性，包含泛型和注解。 | | | MyBatis3Simple _這是默認值_ 使用這值的時候，和上面的MyBatis3類似，但是不會有"by example"一類的方法，只有少量的動態SQL。 Ibatis2Java2 使用這值的時候，MBG會生成兼容iBATIS 2.2.0或更高版本（除了iBATIS 3），還有Java2的所有層次。這些生成對象中的"by example"方法將支持幾乎不受限制的動態的where子句。這些生成的對象不能100%和原生的Abator或其他的代碼生成器兼容。 | | | Ibatis2Java5 使用這值的時候，MBG會生成兼容iBATIS 2.2.0或更高版本（除了iBATIS 3），兼容JSE 5.0或更高版本的對象（例如Java模型類和Dao類會使用泛型）。這些生成對象中的"by example"方法將支持幾乎不受限制的動態的where子句。另外，這些生成器生成的Java對象支持JSE 5.0特性，包含泛型和注解。這些生成的對象不能100%和原生的Abator或其他的代碼生成器兼容。 | | | 如果您想創建一個完全不同的代碼生成器，使用一個繼承了`org.mybatis.generator.api.IntrospectedTable`類的權限定類名替換該值。通過這個值，您可以創建您自己的代碼生成器，然后插入到代碼生成器引擎中。查閱 [擴展 MyBatis Generator](../reference/extending.html) 頁面獲取更多信息。 | | introspectedColumnImpl | 使用這個值去指定一個繼承了`org.mybatis.generator.api.IntrospectedColumn`類的權限定名稱。這可以修改代碼生成器計算列信息時候的行為。查閱 [擴展 MyBatis Generator](../reference/extending.html) 頁面獲取更多信息。 | ## 子元素 * [<property>](property.html) (0..N) * [<plugin>](plugin.html) (0..N) * [<commentGenerator>](commentGenerator.html) (0 or 1) * [<jdbcConnection>](jdbcConnection.html) (1 Required) * [<javaTypeResolver>](javaTypeResolver.html) (0 or 1) * [<javaModelGenerator>](javaModelGenerator.html) (1 Required) * [<sqlMapGenerator>](sqlMapGenerator.html) (0 or 1) * [<javaClientGenerator>](javaClientGenerator.html) (0 or 1) * [<table>](table.html) (1..N) ## 支持的屬性下面的表格列出了所有可用的 [<property>](property.html) 子元素: | 屬性名 | 屬性值 | | --- | --- | | autoDelimitKeywords | 如果是true，那么MGB會分隔SQL關鍵字，如果他們被用作表中的列名。 MBG維護了許多不同數據庫的SQL關鍵字列表。然而，列表可能不是非常的全面。如果一個特殊的關鍵字沒有在MBG的關鍵字列表中，您需要通過`<columnOverride>`強制分隔列。查看 `org.mybatis.generator.internal.db.SqlReservedWords` 這個類的源碼查看MGB包含的關鍵字列表。_默認值是false。_ | | beginningDelimiter | 要用作需要分隔符的 SQL 標識符開頭的標識符分隔符的值。 MBG會自動分割包含空格的SQL標識符。 MGB還會自動分隔在 <table> 或 <columnOverride>中配置了具體要求的標識符。_默認值是雙引號 (")。_ | | endingDelimiter | 要使用作為結束的標識符分隔符需要分隔符的 SQL 標識符的值。 MBG會自動分割包含空格的SQL標識符。 MGB還會分隔在 <table> 或 <columnOverride>中配置了具體要求的標識符。_默認值是雙引號 (")。_ | | javaFileEncoding | 通過這個屬性設置要使用的Java文件的編碼。新生成的Java文件會用這個編碼寫入到文件系統。如果Java文件已經存在并且可以使用這個編碼進行讀取，就會執行合并操作。如果沒有指定，就會使用平臺的默認編碼。查閱 `java.nio.charset.Charset` 獲取可以選擇的編碼的信息。 | | javaFormatter | 使用此屬性來指定生成的 Java 文件的用戶提供 formater 的完整的類名稱。這個類必須繼承 `org.mybatis.generator.api.JavaFormatter` 而且必須有一個默認（不含參數）的構造方法。每一個context都持有一個單獨的javaFormatter的實例。默認的javaFormatter是 `org.mybatis.generator.api.dom.DefaultJavaFormatter`。默認的格式使用內置到Java DOM類的格式。 | | xmlFormatter | 使用此屬性來指定生成的 XML 文件的用戶提供 formater 的完整的類名稱。這個類必須繼承 `org.mybatis.generator.api.XmlFormatter` 而且必須有一個默認（不含參數）的構造方法。每一個context都持有一個單獨的xmlFormatter的實例。默認的xmlFormatter是 `org.mybatis.generator.api.dom.DefaultXmlFormatter`。默認的格式使用內置到Java DOM類的格式。 |