1. 程式人生 > >Mybatis最入門---代碼自動生成(generatorConfig.xml配置)

Mybatis最入門---代碼自動生成(generatorConfig.xml配置)

pack ces war map serial file 用戶名 clip 英文

第一種方式:通過Main方法執行配置文件。

-------------------------------------------------------------------------------------------------------------------------------------

1.創建本文我們將使用的工程Mybatis13,工程結構圖如下:【重點文件我們給出,其他配置文件請讀者參考前文工程】

技術分享

2.修改jdbc.properties文件,具體內容如下:

  1. jdbc.driverClassName=com.mysql.jdbc.Driver
  2. jdbc.url=jdbc:mysql://localhost:3306/mybatis
  3. jdbc.username=root
  4. jdbc.password=1234

3.修改log4j.properties,具體內容如下:

  1. log4j.rootLogger=debug,stdout
  2. log4j.appender.stdout=org.apache.log4j.ConsoleAppender
  3. log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
  4. log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n

4.修改mbgConfiguration.xml,具體內容如下:

  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. <properties resource="jdbc.properties" />
  7. <context id="sqlserverTables" targetRuntime="MyBatis3">
  8. <!-- 生成的pojo,將implements Serializable-->
  9. <plugin type="org.mybatis.generator.plugins.SerializablePlugin"></plugin>
  10. <commentGenerator>
  11. <!-- 是否去除自動生成的註釋 true:是 : false:否 -->
  12. <property name="suppressAllComments" value="true" />
  13. </commentGenerator>
  14. <!-- 數據庫鏈接URL、用戶名、密碼 -->
  15. <jdbcConnection driverClass="${jdbc.driverClassName}"
  16. connectionURL="${jdbc.url}"
  17. userId="${jdbc.username}"
  18. password="${jdbc.password}">
  19. </jdbcConnection>
  20. <!--
  21. 默認false,把JDBC DECIMAL 和 NUMERIC 類型解析為 Integer
  22. true,把JDBC DECIMAL 和 NUMERIC 類型解析為java.math.BigDecimal
  23. -->
  24. <javaTypeResolver>
  25. <property name="forceBigDecimals" value="false" />
  26. </javaTypeResolver>
  27. <!--
  28. 生成model模型,對應的包路徑,以及文件存放路徑(targetProject),targetProject可以指定具體的路徑,如./src/main/java,
  29. 也可以使用“MAVEN”來自動生成,這樣生成的代碼會在target/generatord-source目錄下
  30. -->
  31. <!--<javaModelGenerator targetPackage="com.joey.mybaties.test.pojo" targetProject="MAVEN">-->
  32. <javaModelGenerator targetPackage="com.csdn.ingo.entity" targetProject="./src/main/java">
  33. <property name="enableSubPackages" value="true"/>
  34. <!-- 從數據庫返回的值被清理前後的空格 -->
  35. <property name="trimStrings" value="true" />
  36. </javaModelGenerator>
  37. <!--對應的mapper.xml文件 -->
  38. <sqlMapGenerator targetPackage="mappers" targetProject="./src/main/resources">
  39. <property name="enableSubPackages" value="true"/>
  40. </sqlMapGenerator>
  41. <!-- 對應的Mapper接口類文件 -->
  42. <javaClientGenerator type="XMLMAPPER" targetPackage="com.csdn.ingo.dao" targetProject="./src/main/java">
  43. <property name="enableSubPackages" value="true"/>
  44. </javaClientGenerator>
  45. <!-- 列出要生成代碼的所有表,這裏配置的是不生成Example文件 -->
  46. <table tableName="userinfo" domainObjectName="UserInfoPO"
  47. enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false"
  48. enableSelectByExample="false" selectByExampleQueryId="false" >
  49. <property name="useActualColumnNames" value="false"/>
  50. </table>
  51. </context>
  52. </generatorConfiguration>

5.修改GenMain.java文件,具體內容如下:

  1. package com.csdn.ingo.main;
  2. import java.io.File;
  3. import java.io.IOException;
  4. import java.sql.SQLException;
  5. import java.util.ArrayList;
  6. import java.util.List;
  7. import org.mybatis.generator.api.MyBatisGenerator;
  8. import org.mybatis.generator.config.Configuration;
  9. import org.mybatis.generator.config.xml.ConfigurationParser;
  10. import org.mybatis.generator.exception.InvalidConfigurationException;
  11. import org.mybatis.generator.exception.XMLParserException;
  12. import org.mybatis.generator.internal.DefaultShellCallback;
  13. public class GenMain {
  14. public static void main(String[] args) {
  15. List<String> warnings = new ArrayList<String>();
  16. boolean overwrite = true;
  17. String genCfg = "/mbgConfiguration.xml";
  18. File configFile = new File(GenMain.class.getResource(genCfg).getFile());
  19. ConfigurationParser cp = new ConfigurationParser(warnings);
  20. Configuration config = null;
  21. try {
  22. config = cp.parseConfiguration(configFile);
  23. } catch (IOException e) {
  24. e.printStackTrace();
  25. } catch (XMLParserException e) {
  26. e.printStackTrace();
  27. }
  28. DefaultShellCallback callback = new DefaultShellCallback(overwrite);
  29. MyBatisGenerator myBatisGenerator = null;
  30. try {
  31. myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
  32. } catch (InvalidConfigurationException e) {
  33. e.printStackTrace();
  34. }
  35. try {
  36. myBatisGenerator.generate(null);
  37. } catch (SQLException e) {
  38. e.printStackTrace();
  39. } catch (IOException e) {
  40. e.printStackTrace();
  41. } catch (InterruptedException e) {
  42. e.printStackTrace();
  43. }
  44. }
  45. }

6.測試方法:運行main方法,然後刷新工程即可。正常情況下:控制臺能夠看到如下輸出,刷新工程後項目列表也能夠看到填充文件的變化。

技術分享
技術分享
--------------------------------------------------------------------------------------------------------------------------------------------------------

在上面的mbgConfiguration.xml文件中,我們在給出一份更加詳細的官方配置地址供讀者參考,如下:

【英文版】http://www.mybatis.org/generator/configreference/xmlconfig.html

【中文版】http://generator.sturgeon.mopaas.com/configreference/table.html

--------------------------------------------------------------------------------------------------------------------------------------------------------

第二種方式:通過Maven插件運行。

--------------------------------------------------------------------------------------------------------------------------------------------------------

上面我們的工程是通過maven構建的,mybatis generator中也包含了一個可以集成到Maven的插件,具體做法如下:

1.修改pom.xml文件如下:

  1. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  2. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  3. <modelVersion>4.0.0</modelVersion>
  4. <groupId>com.java.mybatis</groupId>
  5. <artifactId>mybatis13</artifactId>
  6. <version>0.0.1-SNAPSHOT</version>
  7. <packaging>jar</packaging>
  8. <name>mybatis13</name>
  9. <url>http://maven.apache.org</url>
  10. <properties>
  11. <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  12. </properties>
  13. <dependencies>
  14. <dependency>
  15. <groupId>junit</groupId>
  16. <artifactId>junit</artifactId>
  17. <version>4.12</version>
  18. <scope>test</scope>
  19. </dependency>
  20. <dependency>
  21. <groupId>org.mybatis</groupId>
  22. <artifactId>mybatis</artifactId>
  23. <version>3.3.1</version>
  24. </dependency>
  25. <dependency>
  26. <groupId>mysql</groupId>
  27. <artifactId>mysql-connector-java</artifactId>
  28. <version>5.1.26</version>
  29. </dependency>
  30. <dependency>
  31. <groupId>org.mybatis.generator</groupId>
  32. <artifactId>mybatis-generator-core</artifactId>
  33. <version>1.3.2</version>
  34. </dependency>
  35. <dependency>
  36. <groupId>log4j</groupId>
  37. <artifactId>log4j</artifactId>
  38. <version>1.2.17</version>
  39. </dependency>
  40. </dependencies>
  41. <build>
  42. <plugins>
  43. <plugin>
  44. <groupId>org.mybatis.generator</groupId>
  45. <artifactId>mybatis-generator-maven-plugin</artifactId>
  46. <version>1.3.2</version>
  47. <configuration>
  48. <verbose>true</verbose>
  49. <overwrite>true</overwrite>
  50. </configuration>
  51. </plugin>
  52. </plugins>
  53. </build>
  54. </project>

2.在默認情況下,MBG的配置文件的名稱為generatorConfig.xml,並且與上文不同的是,這裏需要指明數據庫連接器的絕對路徑。修改之後的配置文件如下:

  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. <classPathEntry
  7. location="C:/Users/yyg/Desktop/DevTool/DevTool/repository/Maven/Maven3.2.2/local/repo/mysql/mysql-connector-java/5.1.26/mysql-connector-java-5.1.26.jar" />
  8. <context id="sqlserverTables" targetRuntime="MyBatis3">
  9. <!-- 生成的pojo,將implements Serializable -->
  10. <plugin type="org.mybatis.generator.plugins.SerializablePlugin"></plugin>
  11. <commentGenerator>
  12. <!-- 是否去除自動生成的註釋 true:是 : false:否 -->
  13. <property name="suppressAllComments" value="true" />
  14. </commentGenerator>
  15. <!-- 數據庫鏈接URL、用戶名、密碼 -->
  16. <jdbcConnection driverClass="com.mysql.jdbc.Driver"
  17. connectionURL="jdbc:mysql://localhost:3306/mybatis" userId="root" password="1234">
  18. </jdbcConnection>
  19. <!-- 默認false,把JDBC DECIMAL 和 NUMERIC 類型解析為 Integer true,把JDBC DECIMAL
  20. 和 NUMERIC 類型解析為java.math.BigDecimal -->
  21. <javaTypeResolver>
  22. <property name="forceBigDecimals" value="false" />
  23. </javaTypeResolver>
  24. <!-- 生成model模型,對應的包路徑,以及文件存放路徑(targetProject),targetProject可以指定具體的路徑,如./src/main/java,
  25. 也可以使用“MAVEN”來自動生成,這樣生成的代碼會在target/generatord-source目錄下 -->
  26. <!--<javaModelGenerator targetPackage="com.joey.mybaties.test.pojo" targetProject="MAVEN"> -->
  27. <javaModelGenerator targetPackage="com.csdn.ingo.entity"
  28. targetProject="./src/main/java">
  29. <property name="enableSubPackages" value="true" />
  30. <!-- 從數據庫返回的值被清理前後的空格 -->
  31. <property name="trimStrings" value="true" />
  32. </javaModelGenerator>
  33. <!--對應的mapper.xml文件 -->
  34. <sqlMapGenerator targetPackage="mappers"
  35. targetProject="./src/main/resources">
  36. <property name="enableSubPackages" value="true" />
  37. </sqlMapGenerator>
  38. <!-- 對應的Mapper接口類文件 -->
  39. <javaClientGenerator type="XMLMAPPER"
  40. targetPackage="com.csdn.ingo.dao" targetProject="./src/main/java">
  41. <property name="enableSubPackages" value="true" />
  42. </javaClientGenerator>
  43. <!-- 列出要生成代碼的所有表,這裏配置的是不生成Example文件 -->
  44. <table tableName="userinfo" domainObjectName="UserInfoPO"
  45. enableCountByExample="false" enableUpdateByExample="false"
  46. enableDeleteByExample="false" enableSelectByExample="false"
  47. selectByExampleQueryId="false">
  48. <property name="useActualColumnNames" value="false" />
  49. </table>
  50. </context>
  51. </generatorConfiguration>


3.運行方法:在eclipse 中,選擇pom.xml文件,擊右鍵先擇Run AS——>Maven Build… ——>在Goals框中輸入:mybatis-generator:generate

--------------------------------------------------------------------------------------------------------------------------------------------------------

對比上面兩種方式,博主更加傾向於第一種方式,其main方法每次保持不變,xml配置文件中,也不用關心jdbc配置,每次使用時只需要修改其他關鍵配置項即可。另外,按照官方文檔,我們還能夠使用命令行,ant等方式實現上述同樣的效果。這裏博主只列出這兩種方式的示例,更多內容請讀者自行實現。

最後,在給出一個小建議:在建表時,字段名稱建議用"_"分隔多個單詞,比如:AWB_NO、REC_ID...,這樣生成的entity,屬性名稱就會變成漂亮的駝峰命名,即:awbNo、recId

--------------------------------------------------------------------------------------------------------------------------------------------------------

至此,Mybatis最入門---代碼自動生成(GeneratorCOnfig.xml配置)結束

Mybatis最入門---代碼自動生成(generatorConfig.xml配置)