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文件即为逆向工程的配置文件，按照自己的需要进行修改：

 xml version="1.0" encoding="UTF-8"?>

   PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
   "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

 <generatorConfiguration>
     <context id="testTables" targetRuntime="MyBatis3">
         <commentGenerator>

             <property name="suppressAllComments" value="true" />
         commentGenerator>

         <jdbcConnection driverClass="com.mysql.jdbc.Driver"
             connectionURL="jdbc:mysql://localhost:3306/test" userId="fuxiao"
             password="pass">
         jdbcConnection>

         <javaModelGenerator targetPackage="me.fuxiao.pojo"
             targetProject=".\src">

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

             <property name="trimStrings" value="true" />
         javaModelGenerator>

         <sqlMapGenerator targetPackage="me.fuxiao.mapper"
             targetProject=".\src">

             <property name="enableSubPackages" value="false" />
         sqlMapGenerator>

         <javaClientGenerator type="XMLMAPPER"
             targetPackage="me.fuxiao.mapper"
             targetProject=".\src">

             <property name="enableSubPackages" value="false" />
         javaClientGenerator>

         <table schema="" tableName="student">table>

     context>
 generatorConfiguration>

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

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

 import java.io.File;
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.List;

 import org.mybatis.generator.api.MyBatisGenerator;
 import org.mybatis.generator.config.Configuration;
 import org.mybatis.generator.config.xml.ConfigurationParser;
 import org.mybatis.generator.exception.XMLParserException;
 import org.mybatis.generator.internal.DefaultShellCallback;

 public class GeneratorSqlmap {

     public void generator() throws Exception{

         List warnings = new ArrayList();
         boolean overwrite = true;
         File configFile = new File("generatorConfig.xml");
         ConfigurationParser cp = new ConfigurationParser(warnings);
         Configuration config = cp.parseConfiguration(configFile);
         DefaultShellCallback callback = new DefaultShellCallback(overwrite);
         MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config,
                 callback, warnings);
         myBatisGenerator.generate(null);

     }
     public static void main(String[] args) throws Exception {
         try {
             GeneratorSqlmap generatorSqlmap = new GeneratorSqlmap();
             generatorSqlmap.generator();
         } catch (Exception e) {
             e.printStackTrace();
         }

     }

 }

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

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

四、注意事项

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