Mybatis Generator 的简单使用

1、介绍

（1）诞生背景

​ 虽然 MyBatis 是一个简单易学的框架，但是配置XML文件也是一件相当繁琐的一个过程，而且会出现很多不容易定位的错误。当在工作中需要生成大量对象的时候，有太多的重复劳动，简直是生无可恋。所以，官方开发了 MyBatis Generator。它只需要很少量的简单配置，就可以完成大量的数据表到 Java 对象的生成工作，拥有零出错和速度快的优点，让开发人员解放出来更专注于业务逻辑的开发。

（2）简介

​ Mybatis Generator，简称 MBG，逆向工程，意思就是通过你所创建的数据表，来为你生成对应的 实体类 、Mapper接口 、Mapper配置文件。自动生成以下三类文件：

• pojo 实体类
• Mapper 接口
• Mapper xml 配置文件

（3）官方文档

​ <MyBatis Generator Core – Introduction to MyBatis Generator>

---

2、开始使用

（1）导入 Maven 依赖

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

（2）编写 Mybatis Generator 配置文件 generatorConfig.xml

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

<generatorConfiguration>

    <!--
        targetRuntime 有两个属性：
        Mybatis3Simple    生成基础的SQL语句
        MyBatis3          生成复杂的SQL语句
    -->
    <context id="DB2Tables" targetRuntime="Mybatis3">
        <!--生成mapper.xml时覆盖原文件，避免生成重复的SQL语句而导致报错-->
        <plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin" />

        <commentGenerator>
            <property name="suppressAllComments" value="true" />
        </commentGenerator>
        
        <!--配置数据库连接-->
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/ssmblog?useSSL=false&amp;serverTimezone=GMT&amp;useUnicode=true&amp;characterEncoding=utf-8"
                        userId="root"
                        password="1234567890">
        </jdbcConnection>

        <javaTypeResolver>
            <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>

        <!--
            生成pojo，JavaBean，也就是数据表对应的实体类对象
            targetPackage：将生成的 JavaBean 放在哪个包
            targetProject：放在哪个工程下
        -->
        <javaModelGenerator targetPackage="com.yanghui.pojo"
                            targetProject=".\src\main\java">
            <property name="enableSubPackages" value="true" />
            <property name="trimStrings" value="true" />
        </javaModelGenerator>

        <!--指定sql映射文件生成的位置-->
        <sqlMapGenerator
                targetPackage="mapper"
                targetProject=".\src\main\resources">
            <property name="enableSubPackages" value="true" />
        </sqlMapGenerator>

        <!--指定dao接口生成的位置，mapper接口-->
        <javaClientGenerator
                type="MAPPER"
                targetPackage="com.yanghui.dao"
                targetProject="src\main\java">
            <property name="enableSubPackages" value="true" />
        </javaClientGenerator>

        <!--指定每个表的生成策略
            tableName：表名
            domainObjectName：这个表生成的实体类对象名
        -->
        <table tableName="t_blog" domainObjectName="Blog">
            <!--
                当为 false 时表示针对字段的下划线转换为驼峰写法，
                如数据库中的字段为 type_name，转换后就是 typeName
                当为 true 表示不变，和数据库表中的字段一样
            -->
            <property name="useActualColumnNames" value="true" />
        </table>
    </context>
</generatorConfiguration>

可能对每个文件生成的位置比较模糊，这是我的目录结构，我的 Mapper 配置文件是放在 resources 目录下面的。

（3）编写 Java 代码，开始生成

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

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

public class MybatisGeneratorTest {
    public static void main(String[] args) throws Exception {
        List<String> warnings = new ArrayList<>();
        boolean overwrite = true;
        
        /**
         * 只需要改这一个地方，就是编写好的 Mybatis Generator 配置文件的路径
         * 文件路径，根据配置文件的位置来写
         */
        File configFile = new File("src/main/resources/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);
    }
}

（4）大功告成，完结散花！