实践应用：Spring Boot项目集成MyBatis Generator进行数据层代码自动生成

概 述

MyBatis Generator (简称 MBG) 是一个用于 MyBatis和 iBATIS的代码生成器。它可以为 MyBatis的所有版本以及 2.2.0之后的 iBATIS版本自动生成 ORM层代码，典型地包括我们日常需要手写的 POJO、 mapper xml 以及 mapper 接口等。MyBatis Generator 自动生成的 ORM层代码几乎可以应对大部分 CRUD 数据表操作场景，可谓是一个生产力工具啊！

数据库准备与工程搭建

• 首先我们准备一个 MySQL数据表 dept 用于下文实验
  里面插入了若干条数据：
  

• 新建一个Spring Boot 工程

• 引入 MyBatis Generator 依赖

    <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.4.0</version>
            <scope>provided</scope>
        </dependency>

• 引入 MyBatis Generator Maven 插件

  <!--Mybatis代码自动生成器-->
            <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.4.0</version>
            <dependencies>
                <dependency>
                    <groupId> mysql</groupId>
                    <artifactId> mysql-connector-java</artifactId>
                    <version>8.0.28</version>
                    <!--  <version> 5.1.39</version>  -->
                </dependency>
            </dependencies>
            <executions>
                <execution>
                    <id>Generate MyBatis Artifacts</id>
                    <phase>package</phase>
                    <goals>
                        <goal>generate</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <!--允许移动生成的文件 -->
                <verbose>true</verbose>
                <!-- 是否覆盖 -->
                <overwrite>true</overwrite>
                <!-- 自动生成的配置 -->
                <configurationFile>src/main/resources/mybatis-generator.xml</configurationFile>
            </configuration>
            </plugin>

MyBatis Generator Maven 插件引入以后，我们可以在 Spring Boot工程的 Maven插件工具栏中看到新增的插件选项，类似下图：

准备MyBatis Generator配置文件

MyBatis Generator 也需要一个 xml格式的配置文件，该文件的位置配在了上文 引入 MyBatis Generator Maven 插件的 xml配置里，即 src/main/resources/mybatis-generator.xml，下面给出本文所使用的配置：

<!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="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">

        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
        <!--配置数据源-->
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/db01"
                        userId="root"
                        password="123456">

        </jdbcConnection>

        <!--配置实体类存放的目录-->
        <javaModelGenerator targetPackage="com.dhx.po"
                            targetProject="src/main/java"/>

        <!--配置mapper.xml文件存放的目录-->
        <sqlMapGenerator targetPackage="mapper"
                         targetProject="src/main/resources"/>

        <!--配置mapper接口文件存放的目录-->
        <javaClientGenerator targetPackage="com.dhx.mapper"
                             targetProject="src/main/java"
                             type="XMLMAPPER"/>

        <!--配置需要自动生成的表名  -->
        <table tableName="dept">
            <property name="modelOnly" value="false"/>
        </table>

    </context>
</generatorConfiguration>

上面 xml中几个关键的配置简介如下：

• < jdbcConnection /> ：数据库连接配置，至关重要
• <javaModelGenerator/> ：指定自动生成的 POJO置于哪个包下
• <sqlMapGenerator/> ：指定自动生成的 mapper.xml置于哪个包下
• <javaClientGenerator/> ：指定自动生成的 DAO接口置于哪个包下
• <table/> ：指定数据表名，可以使用_和%通配符

更多关于 MyBatis Generator 配置的内容，可以移步官方文档。

运行 MyBatis Generator

直接通过 IDEA的 Maven图形化插件来运行 MyBatis Generator，其自动生成的过程 和 生成的结果如下图所示：

很明显，通过 MyBatis Generator，已经很方便的帮我们自动生成了 POJO、 mapper xml 以及 mapper接口，接下来我们看看自动生成的代码怎么用！