Mybatis逆向工程的使用方法

一、什么是MyBatis逆向工程

简单的解释就是通过数据库中的单表，自动生成Java代码。

我们平时在使用Mabatis框架进行Web应用开发的过程中，需要根据数据库表编写对应的Pojo类和Mapper映射文件，而这个过程重复单一且浪费时间。基于此，MyBatis官方为了让开发者更加方便快捷地使用MYBatis框架而不必编写繁琐的Pojo类以及Mapper文件，提供了一个十分简洁的逆向工程的工具。

Mybatis官方提供了逆向工程，可以针对数据库的表自动生成对应的mybatis代码（mapper.java\mapper.xml\pojo类）有了这个工具可以大大简化我们持久层代码的编写，和写代码过程中出错的概率。

二、下载逆向工程

https://github.com/mybatis/generator/releases/tag/mybatis-generator-1.3.2

下载完成后，将generatorSqlmapCustom这个Java工程导入到Eclipse中，项目结构如下

三、使用方法

1、  修改逆向工程generator配置文件；

2、  使用java类来执行逆向工程；

3、  把生成的代码拷贝到项目中。

下面进行详细的介绍：

第一步:修改逆向工程generator配置文件，上面项目结构图片中最下面的那个XML文件即为逆向工程的配置文件，按照自己的需要进行修改：

[html] view plain copy

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.   
6. <generatorConfiguration>  
7.     <context id="testTables" targetRuntime="MyBatis3">  
8.         <commentGenerator>  
9.             <!-- 是否去除自动生成的注释 true：是 ： false:否 -->  
10.             <property name="suppressAllComments" value="true" />  
11.         </commentGenerator>  
12.         <!--数据库连接的信息：驱动类、连接地址、用户名、密码 -->  
13.         <jdbcConnection driverClass="com.mysql.jdbc.Driver"  
14.             connectionURL="jdbc:mysql://localhost:3306/test" userId="fuxiao"  
15.             password="pass">  
16.         </jdbcConnection>  
17.         <!-- 默认false，把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer，为 true时把JDBC DECIMAL 和   
18.             NUMERIC 类型解析为java.math.BigDecimal -->  
19.         <javaTypeResolver>  
20.             <property name="forceBigDecimals" value="false" />  
21.         </javaTypeResolver>  
22.   
23.         <!-- targetProject:生成PO类的位置 -->  
24.         <javaModelGenerator targetPackage="me.fuxiao.pojo"  
25.             targetProject=".\src">  
26.             <!-- enableSubPackages:是否让schema作为包的后缀 -->  
27.             <property name="enableSubPackages" value="false" />  
28.             <!-- 从数据库返回的值被清理前后的空格 -->  
29.             <property name="trimStrings" value="true" />  
30.         </javaModelGenerator>  
31.         <!-- targetProject:mapper映射文件生成的位置 -->  
32.         <sqlMapGenerator targetPackage="me.fuxiao.mapper"   
33.             targetProject=".\src">  
34.             <!-- enableSubPackages:是否让schema作为包的后缀 -->  
35.             <property name="enableSubPackages" value="false" />  
36.         </sqlMapGenerator>  
37.         <!-- targetPackage：mapper接口生成的位置 -->  
38.         <javaClientGenerator type="XMLMAPPER"  
39.             targetPackage="me.fuxiao.mapper"   
40.             targetProject=".\src">  
41.             <!-- enableSubPackages:是否让schema作为包的后缀 -->  
42.             <property name="enableSubPackages" value="false" />  
43.         </javaClientGenerator>  
44.         <!-- 指定数据库表 -->  
45.         <table schema="" tableName="student"></table>  
46.   
47.     </context>  
48. </generatorConfiguration>  

第二步：使用java类来执行逆向工程

运行官方提供的GeneratorSqlmap.java这个程序

[java] view plain copy

1. import java.io.File;  
2. import java.io.IOException;  
3. import java.util.ArrayList;  
4. import java.util.List;  
5.   
6. import org.mybatis.generator.api.MyBatisGenerator;  
7. import org.mybatis.generator.config.Configuration;  
8. import org.mybatis.generator.config.xml.ConfigurationParser;  
9. import org.mybatis.generator.exception.XMLParserException;  
10. import org.mybatis.generator.internal.DefaultShellCallback;  
11.   
12. public class GeneratorSqlmap {  
13.   
14.     public void generator() throws Exception{  
15.   
16.         List<String> warnings = new ArrayList<String>();  
17.         boolean overwrite = true;  
18.         File configFile = new File("generatorConfig.xml");   
19.         ConfigurationParser cp = new ConfigurationParser(warnings);  
20.         Configuration config = cp.parseConfiguration(configFile);  
21.         DefaultShellCallback callback = new DefaultShellCallback(overwrite);  
22.         MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config,  
23.                 callback, warnings);  
24.         myBatisGenerator.generate(null);  
25.   
26.     }   
27.     public static void main(String[] args) throws Exception {  
28.         try {  
29.             GeneratorSqlmap generatorSqlmap = new GeneratorSqlmap();  
30.             generatorSqlmap.generator();  
31.         } catch (Exception e) {  
32.             e.printStackTrace();  
33.         }  
34.           
35.     }  
36.   
37. }  

第三步：把生成的代码拷贝到项目中

第二步完成后，刷新工程目录，便会生成我们需要的代码

四、注意事项

Mapper映射文件已经存在时，如果进行重新生成则mapper.xml文件时，内容不被覆盖而是进行内容追加，结果导致mybatis解析失败。故需要重新生成代码时，先删除原来已经生成的mapper xml文件再进行生成。Mybatis自动生成的pojo类及对应的mapper.java文件不是内容而是直接覆盖没有此问题。