SpringBoot教程（十二）之集成mybatis generator工具自动生成代码

一、前言

mybatis也发现了我们需要重复的去创建pojo类、mapper文件以及dao类并且需要配置它们之间的依赖关系可能会很麻烦，所以mybtis提供了一个mybatis generator工具来帮我们自动创建pojo类、mapper文件以及dao类并且会帮我们配置好它们的依赖关系，而我们只需要关系我们的业务逻辑直接使用就行了。 

使用mybatis generator工具有两种方式：eclipse下载generator插件和pom引入generator插件

二、IDE中使用generator

对于Eclipse详情见https://www.cnblogs.com/shyroke/p/8042868.html

对于Idea，只需要pom引入gennerator插件即可

三、pom引入gennerator插件

要使用mybatis generator工具需要在pom.xml文件中添加一个generator的maven工具：

<build>
        <plugins>
            <!--mybatis自动生成代码插件-->
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.4.0</version>
                <configuration>
                    <!-- generator 工具配置文件的位置 -->
                    <configurationFile>src/main/resources/mybatis-generator/generatorConfig.xml</configurationFile>
                    <!-- 是否覆盖，true表示会替换生成的JAVA文件，false则不覆盖 -->
                    <overwrite>true</overwrite>
                </configuration>
                <dependencies>
                    <!--mysql驱动包-->
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>8.0.18</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>

上面指定了mybatis generator工具配置文件的位置，在这个位置创建一个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/generator.properties"/>

    <!-- defaultModelType="flat" 设置复合主键时不单独为主键创建实体 -->
    <context id="mysql" defaultModelType="flat" targetRuntime="MyBatis3">
        <!-- 生成的 Java 文件的编码 -->
        <property name="javaFileEncoding" value="UTF-8"/>
        <!-- 格式化 Java 代码 -->
        <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
        <!-- 格式化 XML 代码 -->
        <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
        <!--覆盖生成XML文件-->
        <plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin"/>
        <!-- 生成的POJO实现java.io.Serializable接口 -->
        <!--<plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>-->
        <!-- 生成的POJO toString方法插件 -->
        <!--<plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>-->
        <!-- 分页 -->
        <plugin type="org.mybatis.generator.plugins.RowBoundsPlugin"/>

        <!--optional,旨在创建class时，对注释进行控制-->
        <!--<commentGenerator>
            <property name="suppressDate" value="true" />
            <property name="addRemarkComments" value="true"/>
        </commentGenerator>-->
        <!-- 注释 -->
        <commentGenerator >
            <property name="suppressAllComments" value="false"/><!-- 是否取消注释 -->
            <property name="suppressDate" value="true" /> <!-- 是否生成注释代时间戳-->
            <property name="addRemarkComments" value="true"/>
        </commentGenerator>

        <!-- 数据库连接，直接通过${}jdbc.properties里的配置 -->
        <jdbcConnection
                driverClass="${jdbc_driver}"
                connectionURL="${jdbc_url}"
                userId="${jdbc_user}"
                password="${jdbc_password}">
            <!-- 设置 useInformationSchema 属性为 true 以便获取表的注释 -->
            <property name="useInformationSchema" value="true"/>
        </jdbcConnection>
        <!--非必须，类型处理器，在数据库类型和java类型之间的转换控制-->
        <javaTypeResolver>
            <!-- 默认情况下数据库中的 decimal，bigInt 在 Java 对应是 sql 下的 BigDecimal 类 -->
            <!-- 不是 double 和 long 类型 -->
            <!-- 使用常用的基本类型代替 sql 包下的引用类型 -->
            <!-- 是否使用bigDecimal， false可自动转化以下类型（Long, Integer, Short, etc.） -->
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- 生成POJO对象，并将类放到com.wqc.model包下 -->
        <javaModelGenerator targetPackage="com.wqc.model" targetProject="${project}">
            <!--enableSubPackages: value为true时，包不存在会自动创建-->
            <property name="enableSubPackages" value="true"/>
            <!-- 是否对modal添加构造函数 -->
            <property name="constructorBased" value="true"/>
            <!-- 是否清理从数据库中查询出的字符串左右两边的空白字符 -->
            <property name="trimStrings" value="true"/>
            <!-- 建立model对象是否不可改变 即生成的model对象不会有setter方法，只有构造方法 -->
            <property name="immutable" value="false"/>
            <!-- model的父类 -->
            <!--<property name="rootClass" value="com.wqc.vo.BaseVo"/>-->
        </javaModelGenerator>
        <!-- 生成mapper xml文件，并放到resources下的mapper/ssm文件夹下 -->
        <sqlMapGenerator targetPackage="mappers" targetProject="${resources}">
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>
        <!-- 生成mapper xml对应dao接口，com.wqc.dao包下-->
        <javaClientGenerator targetPackage="com.wqc.dao" targetProject="${project}" type="XMLMAPPER">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>

        <!--  useActualColumnNames:如果为true，则MBG将使用从数据库元数据返回的列名作为生成的域对象的属性。
                                   如果为false（默认），则MBG将尝试以驼峰式表示返回的名称。
                                   默认值为false。-->

        <!-- table标签可以有多个，至少一个，tableName指定表名，可以使用_和%通配符 -->
        <table tableName="conf_dictionary"
               enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false"
               selectByExampleQueryId="false">
            <!-- 是否只生成POJO对象 -->
            <property name="modelOnly" value="false"/>
            <!-- generatedKey用于生成生成主键的方法 -->
            <generatedKey column="id" sqlStatement="MySql" identity="true"/>
            <!-- domainObjectRenamingRule该功能项是在MBG 1.3.6中新增加的功能，用于定义实体的重命名规则，常见的用途是取消表前缀。-->
            <!-- 类似于columnRenamingRule，前者是重命名生成的模型对象的名称，后者是重命名表字段的名称。-->
            <domainObjectRenamingRule searchString="^t_" replaceString=""/>
        </table>
    </context>
</generatorConfiguration>

在generatorConfig.xml同目录下创建generator.properties文件：

#Mybatis Generator configuration
#dao类和实体类的位置
project =src/main/java
#mapper文件的位置
resources=src/main/resources
#根据数据库中的表生成对应的pojo类、dao、mapper
jdbc_driver =com.mysql.jdbc.Driver
jdbc_url=jdbc:mysql://localhost:3306/demo
jdbc_user=root
jdbc_password=123456

到此，整个配置就完成了，既然该工具的作用是将数据库中的表生成对应的实体、dao类和mapper文件，那么首先需要建立数据库表，当数据库表建立好后在pom.xml文件所在的目录执行如下命令：

mvn mybatis-generator:generate

或者在Idea 的Maven project中点击：

然后就可以看到在指定目录下已经生成了对应的文件，关于mybatis generator的更多详细的配置请自行百度/谷歌！