Intellij IDEA 中使用MyBatis-generator 自動生成MyBatis代

ntellij IDEA 14 做爲Java IDE 神器，接觸後發現，很是好用，對它愛不釋手，打算離開eclipse和myeclipse，投入Intellij IDEA的懷抱。

     然而在使用的過程當中會發現Intellij IDEA也有一些不盡如意的地方，不免會有些不爽：Intellij IDEA 的插件庫遠不及eclipse的豐富。 mybatis-generator在eclipse中有專門的插件，而沒有開發出Intellij IDEA可以使用的插件。

    不過不用灰心，若是你的項目是使用maven組織的，那麼咱們能夠在Intellij IDEA中使用 mybatis-generator-maven-plugin插件來完成MyBatis model 和Mapper文件的自動生成。

STEP 0.在Intellij IDEA建立maven項目（本過程比較簡單，略）

STEP 1. 在maven項目的pom.xml 添加mybatis-generator-maven-plugin 插件

[html] view plaincopy

1. <build>  

2.   <finalName>xxx</finalName>  

3.   <plugins>  

4.     <plugin>  

5.       <groupId>org.mybatis.generator</groupId>  

6.       <artifactId>mybatis-generator-maven-plugin</artifactId>  

7.       <version>1.3.2</version>  

8.       <configuration>  

9.         <verbose>true</verbose>  

10.         <overwrite>true</overwrite>  

11.       </configuration>  

12.     </plugin>  

13.   </plugins>  

14. </build>  

STEP 2. 在maven項目下的src/main/resources 目錄下創建名爲 generatorConfig.xml的配置文件，做爲mybatis-generator-maven-plugin 插件的執行目標，模板以下：

[html] view plaincopy

1. <?xml version="1.0" encoding="UTF-8"?>  

2. <!DOCTYPE generatorConfiguration  

3.         PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"  

4.         "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">  

5. <generatorConfiguration>  

6.     <!--導入屬性配置 -->  

7.     <properties resource="generator.properties"></properties>  

8.   

9.     <!--指定特定數據庫的jdbc驅動jar包的位置 -->  

10.     <classPathEntry location="${jdbc.driverLocation}"/>  

11.   

12.     <context id="default" targetRuntime="MyBatis3">  

13.   

14.   

15.         <!-- optional，旨在建立class時，對註釋進行控制 -->  

16.         <commentGenerator>  

17.             <property name="suppressDate" value="true" />  

18.         </commentGenerator>  

19.   

20.   

21.         <!--jdbc的數據庫鏈接 -->  

22.         <jdbcConnection driverClass="${jdbc.driverClass}" connectionURL="${jdbc.connectionURL}" userId="${jdbc.userId}" password="${jdbc.password}">  

23.         </jdbcConnection>  

24.   

25.   

26.   

27.         <!-- 非必需，類型處理器，在數據庫類型和java類型之間的轉換控制-->  

28.         <javaTypeResolver >  

29.             <property name="forceBigDecimals" value="false" />  

30.         </javaTypeResolver>  

31.   

32.         <!-- Model模型生成器,用來生成含有主鍵key的類，記錄類 以及查詢Example類  

33.             targetPackage     指定生成的model生成所在的包名  

34.             targetProject     指定在該項目下所在的路徑  

35.         -->  

36.         <javaModelGenerator targetPackage="org.louis.hometutor.po" targetProject="src/main/java">  

37.             <!-- 是否對model添加 構造函數 -->  

38.             <property name="constructorBased" value="true"/>  

39.   

40.             <!-- 是否容許子包，即targetPackage.schemaName.tableName -->  

41.             <property name="enableSubPackages" value="false"/>  

42.   

43.             <!-- 創建的Model對象是否 不可改變  即生成的Model對象不會有 setter方法，只有構造方法 -->  

44.             <property name="immutable" value="true"/>  

45.   

46.             <!-- 給Model添加一個父類 -->  

47.             <property name="rootClass" value="com.foo.louis.Hello"/>  

48.   

49.             <!-- 是否對類CHAR類型的列的數據進行trim操做 -->  

50.             <property name="trimStrings" value="true"/>  

51.         </javaModelGenerator>  

52.   

53.         <!--Mapper映射文件生成所在的目錄 爲每個數據庫的表生成對應的SqlMap文件 -->  

54.         <sqlMapGenerator targetPackage="org.louis.hometutor.domain" targetProject="src/main/java">  

55.             <property name="enableSubPackages" value="false"/>  

56.         </sqlMapGenerator>  

57.   

58.   

59.         <!-- 客戶端代碼，生成易於使用的針對Model對象和XML配置文件 的代碼  

60.                 type="ANNOTATEDMAPPER",生成Java Model 和基於註解的Mapper對象  

61.                 type="MIXEDMAPPER",生成基於註解的Java Model 和相應的Mapper對象  

62.                 type="XMLMAPPER",生成SQLMap XML文件和獨立的Mapper接口  

63.         -->  

64.         <javaClientGenerator targetPackage="com.foo.tourist.dao" targetProject="src/main/java" type="MIXEDMAPPER">  

65.             <property name="enableSubPackages" value=""/>  

66.             <!--  

67.                     定義Maper.java 源代碼中的ByExample() 方法的可視性，可選的值有：  

68.                     public;  

69.                     private;  

70.                     protected;  

71.                     default  

72.                     注意：若是 targetRuntime="MyBatis3",此參數被忽略  

73.              -->  

74.             <property name="exampleMethodVisibility" value=""/>  

75.             <!--  

76.                                            方法名計數器  

77.               Important note: this property is ignored if the target runtime is MyBatis3.  

78.              -->  

79.             <property name="methodNameCalculator" value=""/>  

80.   

81.             <!-- 

82.                                                 爲生成的接口添加父接口 

83.              -->  

84.             <property name="rootInterface" value=""/>  

85.   

86.         </javaClientGenerator>  

87.   

88.   

89.   

90.         <table tableName="lession" schema="louis">  

91.   

92.             <!-- optional   , only for mybatis3 runtime  

93.                  自動生成的鍵值（identity,或者序列值）  

94.                若是指定此元素，MBG將會生成<selectKey>元素，而後將此元素插入到SQL Map的<insert> 元素之中  

95.                sqlStatement 的語句將會返回新的值  

96.                若是是一個自增主鍵的話，你可使用預約義的語句,或者添加自定義的SQL語句. 預約義的值以下:  

97.                   Cloudscape    This will translate to: VALUES IDENTITY_VAL_LOCAL()  

98.                   DB2:      VALUES IDENTITY_VAL_LOCAL()  

99.                   DB2_MF:       SELECT IDENTITY_VAL_LOCAL() FROM SYSIBM.SYSDUMMY1  

100.                   Derby:        VALUES IDENTITY_VAL_LOCAL()  

101.                   HSQLDB:   CALL IDENTITY()  

102.                   Informix:     select dbinfo('sqlca.sqlerrd1') from systables where tabid=1  

103.                   MySql:        SELECT LAST_INSERT_ID()  

104.                   SqlServer:    SELECT SCOPE_IDENTITY()  

105.                   SYBASE:   SELECT @@IDENTITY  

106.                   JDBC:     This will configure MBG to generate code for MyBatis3 suport of JDBC standard generated keys. This is a database independent method of obtaining the value from identity columns.  

107.                   identity: 自增主鍵  If true, then the column is flagged as an identity column and the generated <selectKey> element will be placed after the insert (for an identity column). If false, then the generated <selectKey> will be placed before the insert (typically for a sequence).  

108.   

109.             -->  

110.             <generatedKey column="" sqlStatement="" identity="" type=""/>  

111.   

112.   

113.             <!-- optional.  

114.                     列的命名規則：  

115.                     MBG使用 <columnRenamingRule> 元素在計算列名的對應 名稱以前，先對列名進行重命名，  

116.                     做用：通常須要對BUSI_CLIENT_NO 前的BUSI_進行過濾  

117.                     支持正在表達式  

118.                      searchString 表示要被換掉的字符串  

119.                      replaceString 則是要換成的字符串，默認狀況下爲空字符串，可選  

120.             -->  

121.             <columnRenamingRule searchString="" replaceString=""/>  

122.   

123.   

124.   

125.             <!-- optional.告訴 MBG 忽略某一列  

126.                     column，須要忽略的列  

127.                     delimitedColumnName:true ,匹配column的值和數據庫列的名稱 大小寫徹底匹配，false 忽略大小寫匹配  

128.                     是否限定表的列名，即固定表列在Model中的名稱  

129.             -->  

130.             <ignoreColumn column="PLAN_ID"  delimitedColumnName="true" />  

131.   

132.   

133.             <!--optional.覆蓋MBG對Model 的生成規則  

134.                  column: 數據庫的列名  

135.                  javaType: 對應的Java數據類型的徹底限定名  

136.                  在 必要的時候能夠覆蓋由JavaTypeResolver計算獲得的java數據類 型. For some databases, this is necessary to handle "odd" database types (e.g. MySql's unsigned bigint type should be mapped to java.lang.Object).  

137.                  jdbcType: 該列的JDBC數據類型(INTEGER, DECIMAL, NUMERIC, VARCHAR, etc.)，該列能夠覆蓋由 JavaTypeResolver計算獲得的Jdbc類型，對某些數據庫而言，對於處理特定的JDBC 驅動癖好 頗有必要 (e.g. DB2's LONGVARCHAR type should be mapped to VARCHAR for iBATIS).  

138.                  typeHandler:  

139.   

140.             -->  

141.             <columnOverride column="" javaType=""    jdbcType="" typeHandler=""  delimitedColumnName="" />  

142.   

143.         </table>  

144.     </context>  

145. </generatorConfiguration>  

這裏使用了外置的配置文件generator.properties，能夠將一下屬性配置到properties文件之中，增長配置的靈活性：

[plain] view plaincopy

1. jdbc.driverLocation=D:\\maven\\com\\oracle\\ojdbc14\\10.2.0.4.0\\ojdbc14-10.2.0.4.0.jar  

2. jdbc.driverClass=oracle.jdbc.driver.OracleDriver  

3. jdbc.connectionURL=jdbc:oracle:thin:@//localhost:1521/XE  

4. jdbc.userId=LOUIS  

5. jdbc.password=123456  

項目目錄以下：

STEP 3. 在Intellij IDEA添加一個「Run運行」選項，使用maven運行mybatis-generator-maven-plugin插件 ：

以後彈出運行配置框，爲當前配置配置一個名稱，這裏其名爲"generator",而後在 「Command line」 選項中輸入「mybatis-generator:generate  -e」

這裏加了「-e 」選項是爲了讓該插件輸出詳細信息，這樣能夠幫助咱們定位問題。

若是添加成功，則會在run 選項中有「generator」 選項，以下：

點擊運行，而後不出意外的話，會在控制檯輸出：

[plain] view plaincopy

1. C:\Java\jdk1.7.0_71\bin\java -Dmaven.home=D:\software\apache-maven-3.0.5-bin -Dclassworlds.conf=D:\software\apache-maven-3.0.5-bin\bin\m2.conf -Didea.launcher.port=7533 "-Didea.launcher.bin.path=D:\applications\JetBrains\IntelliJ IDEA 14.0.2\bin" -Dfile.encoding=UTF-8 -classpath "D:\software\apache-maven-3.0.5-bin\boot\plexus-classworlds-2.4.jar;D:\applications\JetBrains\IntelliJ IDEA 14.0.2\lib\idea_rt.jar" com.intellij.rt.execution.application.AppMain org.codehaus.classworlds.Launcher -Didea.version=14.0.2 -s D:\software\apache-maven-3.0.5-bin\conf\settings.xml mybatis-generator:generate -e  

2. [INFO] Error stacktraces are turned on.  

3. [INFO] Scanning for projects...  

4. [INFO]                                                                           

5. [INFO] ------------------------------------------------------------------------  

6. [INFO] Building hometutor Maven Webapp 1.0-SNAPSHOT  

7. [INFO] ------------------------------------------------------------------------  

8. [INFO]   

9. [INFO] --- mybatis-generator-maven-plugin:1.3.2:generate (default-cli) @ hometutor ---  

10. [INFO] Connecting to the Database  

11. [INFO] Introspecting table louis.lession  

12. log4j:WARN No appenders could be found for logger (org.mybatis.generator.internal.db.DatabaseIntrospector).  

13. log4j:WARN Please initialize the log4j system properly.  

14. log4j:WARN See http://logging.apache.org/log4j/1.2/faq.html#noconfig for more info.  

15. [INFO] Generating Example class for table LOUIS.LESSION  

16. [INFO] Generating Record class for table LOUIS.LESSION  

17. [INFO] Generating Mapper Interface for table LOUIS.LESSION  

18. [INFO] Generating SQL Map for table LOUIS.LESSION  

19. [INFO] Saving file LessionMapper.xml  

20. [INFO] Saving file LessionExample.java  

21. [INFO] Saving file Lession.java  

22. [INFO] Saving file LessionMapper.java  

23. [WARNING] Root class com.foo.louis.Hello cannot be loaded, checking for member overrides is disabled for this class   

24. [WARNING] Existing file E:\sources\tutor\src\main\java\org\louis\hometutor\po\Lession.java was overwritten  

25. [WARNING] Existing file E:\sources\tutor\src\main\java\com\foo\tourist\dao\LessionMapper.java was overwritten  

26. [INFO] ------------------------------------------------------------------------  

27. [INFO] BUILD SUCCESS  

28. [INFO] ------------------------------------------------------------------------  

29. [INFO] Total time: 2.334s  

30. [INFO] Finished at: Tue Jan 27 12:04:08 CST 2015  

31. [INFO] Final Memory: 8M/107M  

32. [INFO] ------------------------------------------------------------------------  

33.   

34. Process finished with exit code 0  

好，看到BUILD SUCCESS，則大功告成，若是有錯誤的話，因爲添加了-e 選項，會把具體的詳細錯誤信息打印出來的，根據錯誤信息修改便可