MyBatis Generator(MBG)使用

Maven依赖

创建SpringBoot项目增加Maven依赖

<build>
        <plugins>
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.6</version>
                <configuration>
                    <configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
                    <verbose>true</verbose>
                    <overwrite>true</overwrite>
                </configuration>
                <dependencies>
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>5.1.34</version>
                    </dependency>
                    <dependency>
                        <groupId>org.mybatis.generator</groupId>
                        <artifactId>mybatis-generator-core</artifactId>
                        <version>1.3.6</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>

注意到上面的插件中有配置文件路径<configurationFile>src/main/resources/generatorConfig.xml</configurationFile>，下面就看下这个配置文件generatorConfig.xml

---

编写generatorConfig.xml文件

<jdbcConnection >是数据库连接信息，可以直接写入，也可以通过我下面给出的配置方式<properties resource="config/jdbc.properties" />连接属性文件的方式引入进来。

更多详细信息参见MBG官方配置说明

<?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="config/jdbc.properties" />
    <!--执行generator插件生成文件的命令： call mvn mybatis-generator:generate -e -->
    <!-- 引入配置文件 -->
    <!--<properties resource="mybatis-generator/mybatisGeneratorinit.properties"/>-->
    <!--classPathEntry:数据库的JDBC驱动,换成你自己的驱动位置 可选 -->
    <!--<classPathEntry location="D:\generator_mybatis\mysql-connector-java-5.1.24-bin.jar" /> -->

    <!-- 一个数据库一个context -->
    <!--defaultModelType="flat" 大数据字段，不分表 -->
    <context id="MysqlTables" targetRuntime="MyBatis3Simple" defaultModelType="flat">
        <!-- 自动识别数据库关键字，默认false，如果设置为true，根据SqlReservedWords中定义的关键字列表；
        一般保留默认值，遇到数据库关键字（Java关键字），使用columnOverride覆盖 -->
        <property name="autoDelimitKeywords" value="true" />
        <!-- 生成的Java文件的编码 -->
        <property name="javaFileEncoding" value="utf-8" />
        <!-- beginningDelimiter和endingDelimiter：指明数据库的用于标记数据库对象名的符号，比如ORACLE就是双引号，MYSQL默认是`反引号； -->
        <property name="beginningDelimiter" value="`" />
        <property name="endingDelimiter" value="`" />

        <!-- 格式化java代码 -->
        <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
        <!-- 格式化XML代码 -->
        <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin" />

        <plugin type="org.mybatis.generator.plugins.ToStringPlugin" />

        <!-- 注释 -->
        <commentGenerator >
            <property name="suppressAllComments" value="true"/><!-- 是否取消注释 -->
            <property name="suppressDate" value="true" /> <!-- 是否生成注释代时间戳-->
        </commentGenerator>

        <!-- jdbc连接 -->
        <jdbcConnection driverClass="${spring.datasource.driver-class-name}"
                        connectionURL="${spring.datasource.url}"
                        userId="${spring.datasource.username}"
                        password="${spring.datasource.password}" />

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

        <!-- 生成实体类地址 -->
        <javaModelGenerator targetPackage="com.centerm.domain" targetProject="src/main/java" >
            <property name="enableSubPackages" value="false"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
        <!-- 生成mapxml文件 -->
        <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources" >
            <property name="enableSubPackages" value="false" />
        </sqlMapGenerator>
        <!-- 生成mapxml对应client，也就是接口dao -->
        <javaClientGenerator targetPackage="com.centerm.mapper" targetProject="src/main/java" type="XMLMAPPER" >
            <property name="enableSubPackages" value="false" />
        </javaClientGenerator>
        <!-- table可以有多个,每个数据库中的表都可以写一个table，tableName表示要匹配的数据库表,也可以在tableName属性中通过使用%通配符来匹配所有数据库表,只有匹配的表才会自动生成文件 -->
        <!--
        <table tableName="SYSTEM_OBJECT"
               enableCountByExample="true"
               enableSelectByExample="true">
            <property name="useActualColumnNames" value="false" />
             &lt;!&ndash;数据库表主键 &ndash;&gt;
            <generatedKey column="OBJECT_ID" sqlStatement="MySql" identity="true" />
        </table>
        <table tableName="SYSTEM_OBJECT_ATTR_REL"
               enableCountByExample="true"
               enableSelectByExample="true">
            <property name="useActualColumnNames" value="false" />
            &lt;!&ndash;数据库表主键 &ndash;&gt;
            <generatedKey column="REL_ID" sqlStatement="MySql" identity="true" />
        </table>
        <table tableName="ATTR_SPEC"
               enableCountByExample="true"
               enableSelectByExample="true">
            <property name="useActualColumnNames" value="false" />
            &lt;!&ndash;数据库表主键 &ndash;&gt;
            <generatedKey column="ATTR_ID" sqlStatement="MySql" identity="true" />
        </table>
        <table tableName="ATTR_VALUE"
               enableCountByExample="true"
               enableSelectByExample="true">
            <property name="useActualColumnNames" value="false" />
            &lt;!&ndash;数据库表主键 &ndash;&gt;
            <generatedKey column="ATTR_VALUE_ID" sqlStatement="MySql" identity="true" />
        </table>
        -->
    </context>
</generatorConfiguration>

配置运行

Idea可以按照下面的截图配置执行就可以发现在对应目录下生成目标代码了