MyBatis：逆向工程

目錄

• 一、什麼是逆向工程？
• 二、MyBatis 逆向工程特點
• • 1、MyBatis 逆向工程的優點
  • 2、MyBatis 逆向工程的缺點
• 三、MyBatis 逆向工程搭建
• • 1、添加依賴 pom.xml
  • 2、建立 MBG 配置檔案 generatorConfig.xml
  • 3、生成相關的資源

一、什麼是逆向工程？

針對資料表自動生成 MyBatis 執行所需要的代碼，包括：Mapper.java（***Repository），Mapper.xml，實體類。

二、MyBatis 逆向工程特點

1、MyBatis 逆向工程的優點

使用 MyBatis 逆向工程來自動生成需要的資源，減少開發者的工作量，讓開發者可以将精力集中在業務邏輯上，而非是建立實體類，Repository 接口等工作。

2、MyBatis 逆向工程的缺點

逆向工程有局限性，方法隻能執行一次，如果再次執行就會重複生成 Repositpory 接口，實體類等資源，如果需要對表結構進行修改，那麼就必須删除已經生成的所有資源，重新生成。

三、MyBatis 逆向工程搭建

MyBatis Generator，簡稱 MBG：是一個專門為 MyBatis 架構定制的代碼生成器，可以根據資料表結構快速生成對應的 Mapper.xml，Mapper 接口以及實體類，支援基本的 CRUD，複雜的 SQL 語句需要開發者手動編寫。

1、添加依賴 pom.xml

<dependencies>
    <!-- MySQL驅動 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>5.1.48</version>
    </dependency>

    <!-- MyBatis -->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.4.0</version>
    </dependency>

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

2、建立 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">
        <!-- 配置資料庫連接配接資訊 -->
        <jdbcConnection
                driverClass="com.mysql.jdbc.Driver"
                connectionURL="jdbc:mysql://localhost:3306/mydb?useUnicode=true&amp;characterEncoding=UTF-8"
                userId="root"
                password="root"
        ></jdbcConnection>

        <!-- 實體類 -->
        <javaModelGenerator targetPackage="com.spring.entity" targetProject="./src/main/java"></javaModelGenerator>

        <!-- Mapper.xml -->
        <sqlMapGenerator targetPackage="com.spring.repository" targetProject="./src/main/java"></sqlMapGenerator>

        <!-- Mapper.java -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.spring.repository" targetProject="./src/main/java"></javaClientGenerator>

        <!-- 資料表 -->
        <table tableName="t_user" domainObjectName="User"></table>
    </context>
</generatorConfiguration>
           

3、生成相關的資源

package com.spring;

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 GeneratorMain {
    public static void main(String[] args) {
        List<String> warings = new ArrayList<String>();
        boolean overwrite = true;
        String genCig = "/generatorConfig.xml";
        File configFile = new File(GeneratorMain.class.getResource(genCig).getFile());
        ConfigurationParser cp = new ConfigurationParser(warings);
        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,warings);
        } catch (InvalidConfigurationException e) {
            e.printStackTrace();
        }

        try {
            myBatisGenerator.generate(null);
        } catch (SQLException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}