IDEA中使用Mybatis Generator自动生成数据库持久层相应的代码

当项目中我们使用Mybatis作为数据库持久层框架时，Mybatis的XML配置以及对应的实体类以及Mapper类的创建会占用我们大量的时间，如果我们在这上面耗费太多的时间就太浪费了。官方给我们提供了Mybatis Generator工具，只需要简单的配置，就能够自动为我们生成简单的CURD对应XML配置、数据库表对应的实体类以及Mapper类，把我们从简单重复的工作中解放出来，专注于业务的开发。

本文主要介绍IDEA开发工具中，常用的mybatis generator的配置以及基于maven方式运行mybatis generator自动生成数据库持久层 Mybatis相应的代码。Mybatis Generator官方文档：http://mybatis.org/generator/index.html。在IDEA中创建空的maven项目，然后使用mybatis generator自动生成mybatis对应的数据库持久层代码。

MyBatis GeneratorXML配置

创建generatorconf.xml配置文件，详细的配置参考官网介绍：http://mybatis.org/generator/configreference/xmlconfig.html。示例代码中application.properties文件是数据连接配置文件，context节点上的targetRuntime="MyBatis3Simple"配置自动创建简单的CURD语句，常用的详细配置如下：

<?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>
    <!-- 配置文档 http://mybatis.org/generator/configreference/xmlconfig.html -->
    <properties resource="application.properties"/>


    <!--defaultModelType="flat" 主键和blob等全部字段放入到一个对象中 -->
    <context id="sql" targetRuntime="MyBatis3Simple" defaultModelType="flat">
        <property name="autoDelimitKeywords" value="true"/>
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
        <property name="javaFileEncoding" value="utf-8"/>
        <!-- 生成的POJO实现java.io.Serializable接口 -->
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>

        <!-- 注释 -->
        <commentGenerator>
            <!-- 是否取消注释 -->
            <property name="suppressAllComments" value="false"/>
            <!-- 生成注释是否取消时间戳-->
            <property name="suppressDate" value="false"/>
            <!-- 是否将数据库中表的字段描述信息添加到注释 -->
            <property name="addRemarkComments" value="true"/>
        </commentGenerator>

        <!--数据库链接地址账号密码-->
        <jdbcConnection driverClass="${spring.datasource.driver-class-name}"
                        connectionURL="${spring.datasource.url}"
                        userId="${spring.datasource.username}"
                        password="${spring.datasource.password}">
            <!--下面的参数mysql-connector-java版本不兼容 -->
            <property name="nullCatalogMeansCurrent" value="true"/>
        </jdbcConnection>

        <!-- 类型转换 -->
        <javaTypeResolver>
            <!-- 是否使用bigDecimal， false可自动转化以下类型（Long, Integer, Short, etc.） -->
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!--生成Model类存放位置-->
        <javaModelGenerator targetPackage="com.flyduck.mybatis-generator.entity" targetProject="src/main/java">
            <property name="enableSubPackages" value="true"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <!-- 生成mapxml文件 -->
        <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources/mybatis">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>

        <!-- 生成mapxml对应client，也就是接口dao -->
        <javaClientGenerator targetPackage="com.flyduck.mybatis-generator.mapper" targetProject="src/main/java" type="XMLMAPPER">
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>

        <!-- table可以有多个,每个数据库中的表都可以写一个table，tableName表示要匹配的数据库表-->
        <table tableName="user">
            <!-- 数据库表主键 -->
            <generatedKey column="id" sqlStatement="MySql" identity="true"/>
        </table>

        <table tableName="role">
            <!-- 数据库表主键 -->
            <generatedKey column="id" sqlStatement="MySql" identity="true"/>
        </table>

        <table tableName="user_role">
            <!-- 数据库表主键 -->
            <generatedKey column="id" sqlStatement="MySql" identity="true"/>
        </table>
    </context>
</generatorConfiguration>

pom.xml配置

mybatis generator可以有多种执行方式来生成代码（官网执行方式：http://mybatis.org/generator/running/running.html），示例代码中我们使用maven的方式来执行。官网maven方式的配置说明：http://mybatis.org/generator/running/runningWithMaven.html，示例的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.flyduck</groupId>
    <artifactId>mybatis-generator</artifactId>
    <version>1.0-SNAPSHOT</version>
    <name>mybatis-generator</name>
    <description>mybatis-generator使用Demo</description>

    <build>
        <plugins>
            <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.16</version>
                    </dependency>
                </dependencies>
                <executions>
                    <execution>
                        <id>Generate MyBatis Artifacts</id>
                        <!--避免项目package或者install时会自动执行 mybatis-generator:generate 命令-->
                        <!--<phase>package</phase>-->
                        <phase>deploy</phase>
                        <goals>
                            <goal>generate</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <!-- If true, then MBG will write progress messages to the build log.-->
                    <verbose>true</verbose>
                    <!-- 是否覆盖，true表示会替换生成的JAVA文件，false则不覆盖 -->
                    <overwrite>false</overwrite>
                    <configurationFile>src/main/resources/mybatis/generatorconf.xml</configurationFile>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

运行Mybatis Generator

在IDEA项目中的Plugins中点击mybatis-generator:generate运行生成mybatis对应的数据库持久层代码。

示例代码中，执行mybatis generator后会自动生成entity、mapper、以及xml代码，如下图所示：

总结

本文基于真实项目中mybatis generator的常用配置，在IDEA中使用Maven的方式运行自动生成mybatis的数据库持久层相应的代码。示例中使用的数据库在源码中提供了db_initial.sql创建脚本，示例代码地址：https://gitee.com/flyduck128/springboot-demo/tree/master/flyduck-mybatis-generator。本文参考官网介绍结合项目中实战总结，将常用的配置和使用方式做一个演示，希望可以给其他小伙伴提供一些帮助，如果有描述错误的地方欢迎指正。