Mybatis最入门---代码自动生成（generatorConfig.xml配置）

[一步是咫尺，一步即天涯]

经过前文的叙述，各位看官是不是已经被Mybatis的强大功能给折服了呢？本文我们将介绍一个能够极大提升我们开发效率的插件：即代码自动生成。这里的代码自动生成包括，与数据库一一对应的实体对象，Mapper基本结构文件，与Mapper对应的基本接口文件。本文，我们只介绍这个插件的基本用法，更多内容，就请读者先自行学习吧。

准备工作：

a.操作系统 ：win7 x64

b.基本软件：MySQL，Mybatis，SQLyog

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

第一种方式：通过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配置）结束

参考资料：

官方文档：

http://www.jianshu.com/p/e09d2370b796

http://www.cnblogs.com/yjmyzz/p/4210554.html