MyBatis通过mybatis-generator自动生成文件

本文是基于SpringBoot框架的mybatis工具使用。
需要通过mybatis-generator自动生成mapper文件、xml文件和实体类，需要准备两个重要的文件：
generatorConfig.xml和generatorConfig.properties
通常我们可以在resource目录下创建子目录，用于存放这两个文件：

下面是这两个文件的具体内容：
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="mybatis-generator/generatorConfig.properties"/>

    <!-- 一个数据库一个context -->
    <context id="mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">
        <property name="javaFileEncoding" value="UTF-8"/>
        <plugin type="tk.mybatis.mapper.generator.MapperPlugin">
            <property name="mappers" value="tk.mybatis.mapper.common.Mapper"/>
            <!-- caseSensitive默认false，当数据库表名区分大小写时，可以将该属性设置为true -->
            <property name="caseSensitive" value="false"/>
        </plugin>

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

        <!-- jdbc连接 -->
        <jdbcConnection driverClass="${jdbc_driver}"
                        connectionURL="${jdbc_url}"
                        userId="${jdbc_user}"
                        password="${jdbc_password}" />

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

        <!-- 生成实体类地址 -->
        <javaModelGenerator targetPackage="${model_package}"
                            targetProject="${project}">
            <!-- 是否在当前路径下新加一层schema,eg：fase路径com.oop.eksp.user.model， true:com.oop.eksp.user.model.[schemaName] -->
            <property name="enableSubPackages" value="false"/>
            <!-- 是否针对string类型的字段在set的时候进行trim调用 -->
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <!-- 生成mapxml文件 -->
        <sqlMapGenerator targetPackage="${xml_package}"
                         targetProject="${project}">
            <!-- 是否在当前路径下新加一层schema,eg：fase路径com.oop.eksp.user.model， true:com.oop.eksp.user.model.[schemaName] -->
            <property name="enableSubPackages" value="false" />

        </sqlMapGenerator>

        <!-- 生成mapxml对应client，也就是接口dao -->
        <javaClientGenerator targetPackage="${dao_package}"
                             targetProject="${project}" type="XMLMAPPER" >
            <!-- 是否在当前路径下新加一层schema,eg：fase路径com.oop.eksp.user.model， true:com.oop.eksp.user.model.[schemaName] -->
            <property name="enableSubPackages" value="false" />
        </javaClientGenerator>

        <table tableName="pipeline">
            <generatedKey column="id" sqlStatement="mysql" identity="true"/>
        </table>
        <table tableName="project">
            <generatedKey column="id" sqlStatement="mysql" identity="true"/>
        </table>
    </context>
</generatorConfiguration>

其中，properties配置项是用于引入配置文件，结合上面两个文件的位置理解
table 是数据库中的表名，后面生成的文件都是基于这个里的表，可设置多个表
代码中的pipeline和project就是2个不同的表

generatorConfig.properties：

#Mybatis Generator configuration

project=src/main/java
jdbc_driver=com.mysql.jdbc.Driver
jdbc_url=jdbc:mysql://数据库ip地址:端口号/数据库名
jdbc_user=用户名
jdbc_password=密码
jdbc_schema=

model_package=com.xxx.xxxx.testservice.model
dao_package=com.xxx.xxxx.testservice.mapper
xml_package=com.xxx.xxxx.testservice.mapper

数据库地址和账号替换成自己可用的地址和账号
下面的3行是指定生成的mapper文件、xml文件和实体类存放的位置

除了这2个重要的文件，pom文件中还需要添加插件配置：

<plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.2</version>
                <executions>
                    <execution>
                        <id>Generate MyBatis Artifacts</id>
                        <phase>deploy</phase>
                        <goals>
                            <goal>generate</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <!-- generator 工具配置文件的位置 -->
                    <configurationFile>src/main/resources/mybatis-generator/generatorConfig.xml</configurationFile>
                    <verbose>true</verbose>
                    <overwrite>true</overwrite>
                </configuration>
                <dependencies>
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>5.1.39</version>
                    </dependency>
                    <dependency>
                        <groupId>org.mybatis.generator</groupId>
                        <artifactId>mybatis-generator-core</artifactId>
                        <version>1.3.2</version>
                    </dependency>
                    <dependency>
                        <groupId>tk.mybatis</groupId>
                        <artifactId>mapper</artifactId>
                        <version>3.1.2</version>
                    </dependency>
                </dependencies>
            </plugin>

其中，configurationFile对应的是上述xml文件的位置

最后，在pom文件同级目录执行命令：
mvn mybatis-generator:generate
搞定！