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

# <javaClientGenerator> 元素 <javaClientGenerator> 元素用于定義 Java 客戶端代碼生成器的屬性。 Java客戶端生成器生成Java接口和類，它可以簡單地使用生成的Java模型和XML映射文件。在iBATIS2目標環境中，這些對象可以生成DAO接口和實現類形式的代碼。對Mybatis來說，會生成Mapper接口形式的代碼。這個元素是 [<context>](context.html) 元素的一個可選的子元素。如果不指定此元素，然后代碼生成器(MBG)將不會生成Java客戶端接口和類 ## 必選屬性 | 屬性 | 描述 | | --- | --- | | type | 此屬性用于選擇一個預定義的Java客戶端的生成器，或指定用戶提供的Java客戶端生成器。任何用戶提供的DAO生成器必須繼承 `org.mybatis.generator.codegen.AbstractJavaClientGenerator` 類, 必須有一個公開默認的構造函數。該屬性接收下列預定義的代碼生成器之一: | | | 如果<context> targetRuntime 是 **MyBatis3**: | | | ANNOTATEDMAPPER 生成的對象是 MyBatis 3.x 映射器基礎結構的 Java接口。這些接口將會基于注解和 MyBatis 3.x SqlProviders。不會有XML文件生成。（注：就是純接口使用注解的形式，不會有XML文件）ANNOTATEDMAPPER 依賴 MyBatis 3.0.4 或更高版本。 | | | MIXEDMAPPER 生成的對象是 MyBatis 3.x 映射器基礎結構的 Java接口。這些接口將基于注解和XML的混合形式。注解將會用在簡單注解可以實現的地方。此客戶端不會生成SqlProvider，所有復雜的動態SQL都會生成在XML中。The MIXEDMAPPER 依賴 MyBatis 3.0.4 或更高版本。 | | | XMLMAPPER 生成的對象是 MyBatis 3.x 映射器基礎結構的 Java接口。這些接口將會依賴于生成的XML文件。 | | | 如果 <context> targetRuntime 是 **MyBatis3Simple**: | | | ANNOTATEDMAPPER 生成的對象是 MyBatis 3.x 映射器基礎結構的 Java接口。這些接口將會基于注解和 MyBatis 3.x SqlProviders。不會有XML文件生成。（注：就是純接口使用注解的形式，不會有XML文件）The ANNOTATEDMAPPER 依賴 MyBatis 3.0.4 或更高版本。 | | | XMLMAPPER 生成的對象是 MyBatis 3.x 映射器基礎結構的 Java接口。這些接口將會依賴于生成的XML文件。 | | | 如果 <context> targetRuntime 是 **Ibatis2Java2** or **Ibatis2Java5**: | | | IBATIS 生成的對象將符合（不建議使用）iBATIS的DAO框架。 | | | GENERIC-CI 生成的對象將只依賴于SqlMapClient。SqlMapClient將會通過構造參數依賴注入提供。生成的對象將是DAO接口和實現類的形式。 | | | GENERIC-SI 生成的對象將只依賴于SqlMapClient。SqlMapClient將會通過setter方法依賴注入提供。生成的對象將是DAO接口和實現類的形式。 | | | SPRING 生成的對象將符合Spring的DAO框架。 | | targetPackage | 這個包用于放置生成的接口和實現類。在默認的生成器中，屬性"enableSubPackages"用來控制如何計算實際的包。如果是true，如果表的catalog和schema存在，就將他們作為子包加起來。如果"enableSubPackages"是false（默認值），計算的package將是targetPackage屬性指定的值。 MBG 將創建所需的生成包的文件夾。**注:** 實現類的包可以通過指定下面會提到的可選的 `implementationPackage` 屬性。 | | targetProject | 這用來指定生成接口和類的目標項目。當在Eclipse環境中運行時，此選項指定保存對象的位置的項目和源文件夾。在其他環境中，此值應為本地文件系統上的現有目錄。如果它不存在，MBG不會創建它。 | ## 可選屬性 | 屬性 | 描述 | | --- | --- | | implementationPackage | 如果指定了該屬性，實現類就會生成在這個包中。在默認的生成器中，屬性"enableSubPackages"用來控制如何計算實際的包。如果是true，如果表的catalog和schema存在，就將他們作為子包加起來。如果"enableSubPackages"是false（默認值），計算的package將是targetPackage屬性指定的值。 MBG 將創建所需的生成包的文件夾。 | ## 子元素 * [<property>](property.html) (0..N) ## 支持的屬性這個表格列出了所有可以通過[<property>](property.html)子元素進行設置的屬性： | 屬性名 | 屬性值 | | --- | --- | | enableSubPackages | 這個屬性用來選擇MGB是否根據基于目錄和內省表來生成不同的Java包。例如，假設某個表MYTABLE在MYSCHMA的schema中，也假設targetPackage屬性的值設置為"com.mycompany"。如果此屬性為true，為這個表生成的DAO接口和類將被放置在包"com.mycompany.myschema"中。如果此屬性是false，生成的SQL映射將被放在"com.mycompany" schema中。_默認值是 false_ | | exampleMethodVisibility | 此屬性用來設置不同"ByExample"方法的可見性 - selectByExample, deleteByExample等等。如果沒有指定，這些方法將會是公開的的，并將在接口中聲明。此屬性使您可以隱藏這些方法如果您只想使用它們來執行其他專門的方法。 | | | public _這是默認值_ 生成實現類中的方法將是公開的，并將該接口中聲明的方法。 | | | private 生成實現類中的方法將是private的，也不會在接口中聲明。 | | | protected 生成實現類中的方法將是protected的，也不會在接口中聲明。 | | | default 生成實現類中的方法將是包內可見的，也不會在接口中聲明。 | | | **重要提示:** 如果目標運行時是MyBatis3，則將忽略此屬性。 | | methodNameCalculator | 此屬性用于選擇一個方法名稱計算器。方法名稱計算器可以用來為DAO方法提供不同的名稱。您可以選擇一個預定義的值。如果提供的選項都適合您的環境，也可以指定一個實現了`org.mybatis.generator.api.DAOMethodNameCalculator`接口的完全限定名稱。 | | | default _這是默認值_ 生成的方法名稱會很簡單("insert", "updateByPrimaryKey"等等)。 | | | extended 生成的方法名稱將包括與方法關聯的實體對象的名稱("insertWidget", "updateWidgetByPrimaryKey"等等)。 | | | **重要提示:** this property is ignored if the target runtime is MyBatis3. | | rootInterface | 此屬性用于指定一個所有生成的接口都繼承的父接口。這個值可以通過表配置的 `rootInterface` 屬性覆蓋。**重要:** MBG 不驗證接口是否存在或者是否是一個有效的接口。如果指定，這個屬性值應該是一個全限定接口名稱(例如 com.github.abel533.mapper.Mapper)。 | | useLegacyBuilder | 如果為true，那么客戶端將使用SqlBuilder為MyBatis生成動態SQL。在MyBatis 3.2或以后版本，這個SqlBuilder廢棄了，用了一個新的SQL類替代。如果是false，MBG會使用新的SQL生成器生成客戶端代碼。_默認值是 false_ | ## 示例此元素指定我們總希望生成的接口和對象在"text.model'包中，并且我們希望使用基于schema和catalog的子包。它還指定了我們想使用為MyBatis3的XML配置文件的mapper接口。 ``` <javaClientGenerator targetPackage="test.model" targetProject="\MyProject\src" type="XMLMAPPER"> <property name="enableSubPackages" value="true" /> </javaClientGenerator> ```