MyBatis Generator的配置及使用

MyBatis Generator的配置及使用

简介

MyBatis Generator（MBG）是MyBatis和iBATIS的代码生成器。
它可以为所有版本的MyBatis以及2.2.0之后的iBATIS版本生成代码。
可以通过配置，快速生成moedl，mapper和xml文件
通过MBG可以自动生成单表查询的几乎所有方法，但对于连接查询或存储过程仍然需要手动编写。

运行MyBatis Generator

通过Maven运行

在pom文件中引入MBG插件

<build>
    <plugins>
        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.7</version>
        </plugin>
    </plugins>
</build>

这个时候项目中就已经导入MBG插件了
可以在IDEA右侧的Maven下的Plugins中看到

接下来，在插件中添加数据库驱动，通过向插件配置添加依赖项来实现，这里以MySQL为例，如下所示：

<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.3.7</version>
    <configuration>
        <configurationFile>src/main/resources/generatorConfig.xml</configurationFile> # 配置文件路径
        <overwrite>true</overwrite> # 重复生成代码时，采用覆盖的方式
        <verbose>true</verbose> # 启用日志记录
    </configuration>
    <dependencies>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.16</version>
        </dependency>
    </dependencies>
</plugin>

到这里，pom.xml的配置基本完成，接下来去src/main的resource目录下创建数据库连接配置文件datasource.properties

# datasource.properties 可根据自己的实际修改
jdbc.driverClass=com.mysql.cj.jdbc.Driver
jdbc.connectionURL=jdbc:mysql://localhost:3306/example?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC
jdbc.userId=root
jdbc.password=root

接下来去src/main的resource目录下创建MBG的配置文件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>
    <!--导入数据库连接属性配置文件-->
    <properties resource="datasource.properties" />
    <!--context 逆向工程的主要配置信息  id：工程名字 targetRuntime：设置生成的文件适用于哪个MyBatis版本-->
    <!--defaultModelType: 设置生成的model类型-->
    <context id="context" targetRuntime="MyBatis3" defaultModelType="flat">
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
        <property name="javaFileEncoding" value="UTF-8"/>
        <!-- 为模型生成序列化方法-->
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
        <!-- 为生成的Java模型创建一个toString方法 -->
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>
        <!--可以自定义生成model的代码注释-->
        <commentGenerator>
            <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
            <property name="suppressAllComments" value="true"/>
            <property name="suppressDate" value="true"/>
            <property name="addRemarkComments" value="true"/>
        </commentGenerator>
        <!--配置数据库连接-->
        <jdbcConnection driverClass="${jdbc.driverClass}"
                        connectionURL="${jdbc.connectionURL}"
                        userId="${jdbc.userId}"
                        password="${jdbc.password}">
            <!--解决mysql驱动升级到8.0后不生成指定数据库代码的问题-->
            <property name="nullCatalogMeansCurrent" value="true" />
        </jdbcConnection>
        <!--指定生成model的路径-->
        <javaModelGenerator targetPackage="com.generator.model" targetProject="src\main\java" >
            <!-- 是否允许子包 -->
            <property name="enableSubPackages" value="false" />
            <!-- 是否对modal添加构造函数 -->
            <property name="constructorBased" value="true" />
            <!-- 是否清理从数据库中查询出的字符串左右两边的空白字符 -->
            <property name="trimStrings" value="true" />
            <!-- 建立modal对象是否不可改变 即生成的modal对象不会有setter方法，只有构造方法 -->
            <property name="immutable" value="false" />
        </javaModelGenerator>
        <!--指定生成mapper.xml的路径-->
        <sqlMapGenerator targetPackage="com.generator.mapper" targetProject="src\main\resources"/>
        <!--指定生成mapper接口的的路径-->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.generator.mapper"
                             targetProject="src\main\java"/>
        <!--生成全部表tableName设为%-->
        <table tableName="pms_brand">
            <generatedKey column="id" sqlStatement="MySql" identity="true"/>
        </table>
    </context>
</generatorConfiguration>

上述步骤完成后，基本就完成了MBG的配置工作。
点击Maven插件中的mybatis-generator:generate就可以自动生成model，mapper和xml文件了