IDEA使用mybatis-generator，自动生成mybatis代码

mybatis-generator是代码生成工具

mybatis-generator是什么？

如标题所写，是mybatis一个能自动生成所需代码的工具或者说是插件，让开发人员写更少的代码也能实现大大的效果。

能生成什么代码？

使用过mybatis开发的朋友们应该都知道，需要自己写好mapper接口、mapper映射文件（xml文件）来进行数据库操作。

那么使用mybatis-generator后，工具能够根据数据库表自动帮我们生成PO类，能生成mapper映射文件（其中包括基本的增删改查功能）、能生成mapper接口。

这能减少开发人员的代码量，大大提高开发效率。（不了解MyBatis的小伙伴们可以先学习一下MyBatis再了解mybatis-generator这款工具）

IDEA使用mybatis-generator

1.在项目的pom文件的<build>下的<plugins>添加以下配置

<plugin>
     <groupId>org.mybatis.generator</groupId>
     <artifactId>mybatis-generator-maven-plugin</artifactId>
     <version>1.3.5</version>
     <configuration>
         <!-- 在控制台打印执行日志 -->
         <verbose>true</verbose>
         <!-- 重复生成时会覆盖之前的文件-->
         <overwrite>true</overwrite>
     <configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
     </configuration>
     <!-- 数据库连接选择8.0以上的，因为用的mysql8.0-->
     <dependencies>
         <dependency>
             <groupId>mysql</groupId>
             <artifactId>mysql-connector-java</artifactId>
             <version>8.0.16</version>
         </dependency>
     </dependencies>
</plugin>

2.在mysql中建立测试数据库表person

3.在resources下创建generatorConfig.xml

具体内容如下：

<?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="MySqlContext" targetRuntime="MyBatis3" defaultModelType="flat">
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
        <property name="javaFileEncoding" value="UTF-8"/>
        <!--覆盖生成XML文件-->
        <plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin"></plugin>
        <!-- 为模型生成序列化方法-->
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
        <!-- 为生成的Java模型创建一个toString方法 -->
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>
        <!--可以自定义生成model的代码注释-->
        <commentGenerator>
            <!--**阻止**生成注释-->
            <property name="suppressAllComments" value="true"/>
            <!--**阻止**生成的注释包含时间戳-->
            <property name="suppressDate" value="true"/>
            <!--在生成的实体类中附带表字段的注释-->
            <property name="addRemarkComments" value="true"/>
        </commentGenerator>
        <!--配置数据库连接-->
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/test?serverTimezone=Asia/Shanghai"
                        userId="root"
                        password="123456">
            <!--解决mysql驱动升级到8.0后不生成指定数据库代码的问题-->
            <property name="nullCatalogMeansCurrent" value="true" />
        </jdbcConnection>
        <!--指定生成model的路径-->
        <javaModelGenerator targetPackage="com.example.test.pojo" targetProject="src/main/java"/>
        <!--指定生成mapper.xml的路径-->
        <sqlMapGenerator targetPackage="mbgMapper" targetProject="src/main/resources"/>
        <!--指定生成mapper接口的的路径-->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.example.test.mbgMapper"
                             targetProject="src/main/java"/>
        <!--生成全部表tableName设为%-->
        <table tableName="person">
            <generatedKey column="id" sqlStatement="MySql" identity="true"/>
        </table>
    </context>
</generatorConfiguration>

4.双击运行，看文件是否生成成功

控制台出现这个就表示成功了

再看回项目结构目录，是否出现以下文件（文件的生成路径在generatorConfig.xml定义了的）

到这里，说明mybatis-generator的使用效果出来了。

如何使用生成的代码？

如果配置得当，生成的符合要求，可以直接在生成的基础上进行修改和添加功能。
如果生成的实在是不符合要求，也可以只复制自己能使用的进行修改使用。

总结

mybatis-generator的使用只是帮助我们快速生成某些我们需要的文件，这些文件的作用和之间的关联到底是怎样的，归根结底还是需要我们了解MyBatis开发的思想和过程。