MyBatis教程(3)：逆向工程

前言：

什么是Mybatis逆向工程？

可以针对单表自动生成MyBatis执行所需要的代码，包括：Mapper.java，Mapper.xml，实体类。

为什么要使用Mybatis逆向工程？

我们之前说过MyBatis是一个"半自动"的ORM框架，SQL语句需要开发者自定义，这样做的好处是代码更加灵活，缺点是如果参与业务的表太多，每张表的业务都需要自定义SQL，创建实体类，DAO接口，难免会很麻烦。所以我们需要使用逆向工程，让MyBatis自动生成表对应的各种资源，大大减少我们的工作量。

Mybatis逆向工程有什么不足？

逆向工程有它自身的局限性，逆向工程方法只能执行一次，如果再次执行就会重复生成对应的DAO接口，实体类等资源。如果需要对表结构进行修改，那么就必须删除已经生成的所有资源，重新生成一次。

如何使用Mybatis逆向工程？

MyBatis Generator，简称MBG：是一个专门为MyBatis框架开发者定制的代码生成器，可以根据表结构快速生成对应的Mapper.xml，Mapper接口以及实体类。支持基本的CRUD（Create，Read，Update，Delete），但是复杂的SQL语句需要开发者手动编写。

代码：

1.添加依赖jar包到pom.xml文件。

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.southwind</groupId>
  <artifactId>MBGMaven</artifactId>
  <packaging>war</packaging>
  <version>0.0.1-SNAPSHOT</version>
  <name>MBGMaven Maven Webapp</name>
  <url>http://maven.apache.org</url>
  <dependencies>

    <dependency>
      <groupId>org.mybatis</groupId>
      <artifactId>mybatis</artifactId>
      <version>3.4.5</version>
    </dependency>

    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <version>5.1.25</version>
    </dependency>

    <dependency>  
      <groupId>org.mybatis.generator</groupId>  
      <artifactId>mybatis-generator-core</artifactId>  
      <version>1.3.2</version>  
    </dependency>

  </dependencies>
  <build>
    <finalName>MBGMaven</finalName>
  </build>
</project>

2.创建MBG配置文件generatorConfig.xml:

(1) jdbcConnection配置数据库连接信息。

(2) javaModelGenerator配置javaBean的生成策略。

(3) sqlMapGenerator 配置sql映射文件生成策略。

(4) javaClientGenerator配置Mapper接口的生成策略。

(5) table配置要逆向解析的数据表（tableName：表名，domainObjectName：对应的javaBean名）。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
  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/mybatis?useUnicode=true&amp;characterEncoding=UTF-8" 
            userId="root"
            password="root">
        </jdbcConnection>

        <!-- 数据类型解析，false表示将DECIMAL和 NUMERIC类型解析为 Integer，true表示解析为java.math.BigDecimal -->
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>

        <!-- 自动生成实体类存放的位置 -->
        <javaModelGenerator targetPackage="com.southwind.entity"
            targetProject="./src/main/java">
            <!-- enableSubPackages:是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="false" />
            <!-- 从数据库返回的值被清理前后的空格 -->
            <property name="trimStrings" value="true" />
        </javaModelGenerator>

        <!-- 自动生成Mapper.xml存放的位置 -->
        <sqlMapGenerator targetPackage="com.southwind.dao" 
            targetProject="./src/main/resources">
            <!-- enableSubPackages:是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="false" />
        </sqlMapGenerator>

        <!-- 自动生成Mapper接口存放的位置 -->
        <javaClientGenerator type="XMLMAPPER"
            targetPackage="com.southwind.dao" 
            targetProject="./src/main/java">
            <!-- enableSubPackages:是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="false" />
        </javaClientGenerator>

        <!-- 指定数据库表 -->
        <table tableName="t_user" domainObjectName="User"></table>    

    </context>
</generatorConfiguration>

3.创建GeneratorMain类，执行自动生成资源的代码。

package com.southwind.main;

import java.io.File;
import java.io.IOException;
import java.sql.SQLException;
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.InvalidConfigurationException;
import org.mybatis.generator.exception.XMLParserException;
import org.mybatis.generator.internal.DefaultShellCallback;

public class GeneratorMain {

    public static void main(String[] args) throws Exception {
        List<String> warnings = new ArrayList<String>();  
        boolean overwrite = true;  
        String genCfg = "/generatorConfig.xml";  
        File configFile = new File(GeneratorMain.class.getResource(genCfg).getFile());  
        ConfigurationParser cp = new ConfigurationParser(warnings);  
        Configuration config = null;  
        try {  
            config = cp.parseConfiguration(configFile);  
        } catch (IOException e) {  
            e.printStackTrace();  
        } catch (XMLParserException e) {  
            e.printStackTrace();  
        }  
        DefaultShellCallback callback = new DefaultShellCallback(overwrite);  
        MyBatisGenerator myBatisGenerator = null;  
        try {  
            myBatisGenerator = new MyBatisGenerator(config, callback, warnings);  
        } catch (InvalidConfigurationException e) {  
            e.printStackTrace();  
        }  
        try {  
            myBatisGenerator.generate(null);  
        } catch (SQLException e) {  
            e.printStackTrace();  
        } catch (IOException e) {  
            e.printStackTrace();  
        } catch (InterruptedException e) {  
            e.printStackTrace();  
        }      

    }
}

运行逆向工程代码之前，工程目录结构是这样的。

运行GeneratorMain类的main方法，刷新工程，结构如下。

红框标注的部分为自动生成的资源，包括实体类，Mapper接口以及Mapper.xml，使用逆向工程自动生成代码测试成功。

源码：

github

https://github.com/southwind9801/MBGTest.git