6. MyBatis 逆向工程

MyBatis逆向工程

我们知道使用MyBatis 框架需要：实体类、自定义 Mapper 接口、Mapper.xml 配置

传统的开发中，上述的三个组件需要开发者手动创建，逆向工程可以帮助开发者来自动创建这三个组件，减轻开发者的工作量，提高工作效率。

如何使用逆向工程

MyBatis Generator，简称 MBG，是一个专门为 MyBatis 框架开发定制的代码生成器，可自动生成 MyBatis 框架所需的实体类、Mapper 接口、Mapper.xml，支持基本的 CRUD 操作，但是一些相对复杂的 SQL 需要开发者自己来完成。

Step1：新建 maven 工程，在 pom.xml 中引入相关依赖

<?xml version="1.0" encoding="UTF-8"?>
<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/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.training</groupId>
    <artifactId>mybatisPro</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.6</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.20</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.3.2</version>
        </dependency>
    </dependencies>
</project>

Step2：创建 MBG 的配置文件 generatorConfig.xml

• jdbcConnection 配置数据库连接信息
• javaModelGenerator 配置 JavaBean 的生成策略
• sqlMapGenerator 配置 SQL 映射文件的生成策略
• javaClientGenerator 配置 Mapper 接口的生成策略
• 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"></property>
        </commentGenerator>

        <!-- 配置数据库连接信息 -->
        <jdbcConnection
                driverClass="com.mysql.cj.jdbc.Driver"
                connectionURL="jdbc:mysql://localhost:3306/test?useUnicode=true&amp;characterEncoding=UTF-8"
                userId="root"
                password="123456">
        </jdbcConnection>
        <!-- 自动生成实体类存放的位置 -->
        <javaModelGenerator
                targetPackage="com.trainingl.entity"
                targetProject="./src/main/java">
        </javaModelGenerator>
        <!-- 自动生成Mapper.xml存放的位置 -->
        <sqlMapGenerator
                targetPackage="com.trainingl.repository"
                targetProject="./src/main/java">
        </sqlMapGenerator>
        <!-- 自动生成Mapper接口存放的位置 -->
        <javaClientGenerator
                type="XMLMAPPER"
                targetPackage="com.trainingl.repository"
                targetProject="./src/main/java">
        </javaClientGenerator>
        <!-- 自动生成Mapper接口存放的位置 -->
        <table tableName="student" domainObjectName="Student"></table>
    </context>
</generatorConfiguration>

Step3：创建 MyBatisGenerator 测试类，执行自动生成资源的代码

package com.trainingl.test;

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;

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

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

运行逆向工程代码之前，工程目录结构如下：

运行 MyBatisGenerator 测试类之后，刷新工程，目录结构如下：

说明：红框标注的内容为自动生成的资源，包括实体类、Mapper接口以及 Mapper.xml。

这样创建 MyBatis 逆向工程的步骤比较繁琐，后续会介绍一款 IDEA 的 mybatis generator 的插件 MyBatisCodeHelperPro 简化开发的流程。