使用 myabtis-generator 自动生成 mapper

概述

所谓代码生成,其实就是通过数据库中的表来去自动生成 mapper,使我们可以开箱即用一些常用的增删改查语句。

(其实还不如直接使用 myabtis plsu 2333.

配置

pom 文件

首先在全局 pom 文件(假设是多模块项目)中的 pom 文件 > build > plugins 加入以下语句:


        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.7</version>
            <configuration>
                <!-- 在控制台打印执行日志 -->
                <verbose>true</verbose>
                <!-- 重复生成时会覆盖之前的文件-->
                <overwrite>true</overwrite>
                <configurationFile>src/main/resources/generator/generatorConfig.xml</configurationFile>
            </configuration>
            <dependencies>
                <dependency>
                    <groupId>mysql</groupId>
                    <artifactId>mysql-connector-java</artifactId>
                    <version>${mysql.connector.version}</version>
                </dependency>
            </dependencies>
        </plugin>

其次注意配置中的「configurationFile」 参数,此处保存的是 generator 的配置文件,需要按照此处配置的路径去创建。

generator 配置

此配置可以复用,主要根据当前数据表的情况来更改(增加)底部的「table」标签。

<?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:起个名字 -->
    <!-- targetRuntime:设置生成的文件适用于那个 mybatis 版本 -->
    <context id="default" targetRuntime="MyBatis3">

        <!--覆盖生成XML文件-->
        <plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin" />

        <!--为实体类加入 toString 方法-->
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin" />

        <!--optional,指在创建class时,对注释进行控制-->
        <commentGenerator>
            <property name="suppressDate" value="true"/>
            <!-- 是否去除自动生成的注释 true:是 : false:否 -->
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>

        <!--jdbc的数据库连接 wg_insert 为数据库名字-->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/courseimooc"
                        userId="course"
                        password="123456"></jdbcConnection>

        <!--非必须,类型处理器,在数据库类型和java类型之间的转换控制-->
        <javaTypeResolver>
            <!-- 默认情况下数据库中的 decimal,bigInt 在 Java 对应是 sql 下的 BigDecimal 类 -->
            <!-- 不是 double 和 long 类型 -->
            <!-- 使用常用的基本类型代替 sql 包下的引用类型 -->
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- targetPackage:生成的实体类所在的包 -->
        <!-- targetProject:生成的实体类所在的硬盘位置 -->
        <javaModelGenerator targetPackage="com.course.server.pojo"
                            targetProject="src/main/java"/>

        <!-- targetPackage 和 targetProject:生成的 mapper 文件的包和位置 -->
        <sqlMapGenerator targetPackage="mapper"
                         targetProject="src/main/resources"/>

        <!-- targetPackage 和 targetProject:生成的 interface 文件的包和位置 type 代表此 mapper 是 xml 形式的,也可以另外选择Java 形式和 部分在 Java 部分在 xml 的形式-->
        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="com.course.server.mapper"
                             targetProject="src/main/java"/>

        <!-- tableName是数据库中的表名,domainObjectName是生成的JAVA模型名,后面的参数不用改,要生成更多的表就在下面继续加table标签 -->
        <table tableName="test" domainObjectName="Test" />
    </context>
</generatorConfiguration>

运行

之后在 idea 中添加运行配置,如下图:

Snipaste_2020-08-08_22-02-10.png

然后添加 maven 运行配置,如下选择工作空间为当前模块,然后在命令行输入框中输入:「mybatis-generator:generate -e」

Snipaste_2020-08-08_22-02-35.png

保存之后,在 idea 中运行此配置,当输出「BUILD SUCCESS」并且 mapper 也成功输出在你绑定的文件夹之中,即为成功。