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

系统管理员 2022-06-18 02:10 221阅读 0赞

ntellij IDEA  作为[Java ][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 plain][]   [copy][view plain]
> 
>   [![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]
> 
> 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 plain][]   [copy][view plain]
> 
>   [![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]
> 
> 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.        
> 10.     **<****classPathEntry** location="$\{jdbc.driverLocation\}"**/>**  
> 11.   
> 12.     **<****context** id="default" targetRuntime="MyBatis3"**>**  
> 13.   
> 14.   
> 15.           
> 16.         **<****commentGenerator****>**  
> 17.             **<****property** name="suppressDate" value="true" **/>**  
> 18.         **</****commentGenerator****>**  
> 19.   
> 20.   
> 21.           
> 22.         **<****jdbcConnection** driverClass="$\{jdbc.driverClass\}" connectionURL="$\{jdbc.connectionURL\}" userId="$\{jdbc.userId\}" password="$\{jdbc.password\}"**>**  
> 23.         **</****jdbcConnection****>**  
> 24.   
> 25.   
> 26.   
> 27.           
> 28.         **<****javaTypeResolver** **>**  
> 29.             **<****property** name="forceBigDecimals" value="false" **/>**  
> 30.         **</****javaTypeResolver****>**  
> 31.   
> 32.           
> 38.             **<****property** name="constructorBased" value="true"**/>**  
> 39.   
> 40.               
> 41.             **<****property** name="enableSubPackages" value="false"**/>**  
> 42.   
> 43.               
> 44.             **<****property** name="immutable" value="true"**/>**  
> 45.   
> 46.               
> 47.             **<****property** name="rootClass" value="com.foo.louis.Hello"**/>**  
> 48.   
> 49.               
> 50.             **<****property** name="trimStrings" value="true"**/>**  
> 51.         **</****javaModelGenerator****>**  
> 52.   
> 53.           
> 54.         **<****sqlMapGenerator** targetPackage="org.louis.hometutor.domain" targetProject="src/main/java"**>**  
> 55.             **<****property** name="enableSubPackages" value="false"**/>**  
> 56.         **</****sqlMapGenerator****>**  
> 57.   
> 58.   
> 59.           
> 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 plain][]   [copy][view plain]
> 
>   [![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]
> 
> 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  
> 
>   
> 
> 
> 项目目录如下：
> 
> ![技术分享][20150127125526859]  
> 
> 
>   
> 
> 
>   
> 
> 
>   
>

#### STEP 3. 在Intellij IDEA添加一个“Run运行”选项，使用maven运行mybatis-generator-maven-plugin插件 ： ####

> ![技术分享][20150127114624571]

> ![技术分享][20150127114637987]
> 
> 之后弹出运行配置框，为当前配置配置一个名称，这里其名为"generator",然后在 “Command line” 选项中输入“mybatis-generator:generate  -e”
> 
> 这里加了“-e ”选项是为了让该插件输出详细信息，这样可以帮助我们定位问题。  
>

> ![技术分享][20150127114644399]
> 
> ![技术分享][20150127115339141]
> 
> 如果添加成功，则会在run 选项中有“generator” 选项，如下：
> 
> ![技术分享][20150127115619156]
> 
> 点击运行，然后不出意外的话，会在控制台输出：
> 
> **\[plain\]**  [view plain][]   [copy][view plain]
> 
>   [![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]
> 
> 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 选项，会把具体的详细错误信息打印出来的，根据错误信息修改即可

[Java]: http://lib.csdn.net/base/java
[view plain]: http://blog.csdn.net/sunny243788557/article/details/45166397#
[CODE]: https://code.csdn.net/assets/CODE_ico.png
[CODE_CODE]: https://code.csdn.net/snippets/590183
[ico_fork.svg]: https://code.csdn.net/assets/ico_fork.svg
[ico_fork.svg 1]: https://code.csdn.net/snippets/590183/fork
[20150127125526859]: /images/20220618/b719882e7854454d9a40d5086a4d13b6.png
[20150127114624571]: /images/20220618/b14a44147031432880772f925707d7c8.png
[20150127114637987]: /images/20220618/37ca1dca2858444bae340bf4cf727a89.png
[20150127114644399]: /images/20220618/0f96c754d9104037abe088df2c9f29b5.png
[20150127115339141]: /images/20220618/c567971013804dcabae88833e736a0c9.png
[20150127115619156]: /images/20220618/9f6535d332834bb983576a772e2d0ac6.png