Idea使用Mybatis generator自动生成插件

今天尝试在idea使用mybatis generator插件生成数据表对应的mapper和entity文件，碰到了一下问题，记录学习一下。本人

参考https://www.cnblogs.com/mkl34367803/p/8353597.html

1.pom.xml配置插件

<!-- 自动生成mybatis插件-->
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.2</version>
                <configuration>
                    <configurationFile>src/main/resources/mybatis-generator/generatorConfig.xml</configurationFile>
                    <verbose>true</verbose>
                    <overwrite>true</overwrite>
                </configuration>
                <executions>
                    <execution>
                        <id>Generate MyBatis Artifacts</id>
                        <goals>
                            <goal>generate</goal>
                        </goals>
                    </execution>
                </executions>
                <dependencies>
                    <dependency>
                        <groupId>org.mybatis.generator</groupId>
                        <artifactId>mybatis-generator-core</artifactId>
                        <version>1.3.2</version>
                    </dependency>
                </dependencies>
            </plugin>

2.将generatorConfig.xml文件根据自己的配置修改，放到工程中（我是放在resources下)

<?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="application.properties"/>

    <!-- 指定数据库连接驱动jara地址 -->
    <classPathEntry
            location="E:/InstalledSoft/apache-maven-3.5.0/repository/mysql/mysql-connector-java/8.0.16/mysql-connector-java-8.0.16.jar" />

    <!-- 一个数据库一个context -->
    <context id="sqlserverTables">
        <!-- 生成的pojo，将implements Serializable -->
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"></plugin>

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

        <!-- 数据库链接URL、用户名、密码 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/testsql?serverTimezone=UTC&amp; zeroDateTimeBehavior=round&amp; nullCatalogMeansCurrent=true" userId="root"
                        password="******">
        </jdbcConnection>

        <!-- 类型转换 -->
        <javaTypeResolver>
            <!-- 默认false，把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer true，把JDBC DECIMAL
                和 NUMERIC 类型解析为java.math.BigDecimal -->
            <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>

        <!-- 生成model模型，对应的包路径，以及文件存放路径(targetProject)，targetProject可以指定具体的路径,如./src/main/java，
            也可以使用“MAVEN”来自动生成，这样生成的代码会在target/generatord-source目录下 -->
        <javaModelGenerator targetPackage="cn.wallace.entity"
                            targetProject="C:/Users/Administrator/IdeaProjects/demo/src/main/java">
            <!-- 是否在当前路径下新加一层schema,eg：fase路径com.oop.eksp.user.model， true:com.oop.eksp.user.model.[schemaName] -->
            <property name="enableSubPackages" value="false" />
            <!-- 从数据库返回的值被清理前后的空格 -->
            <property name="trimStrings" value="true" />
        </javaModelGenerator>

        <!--对应的mapper.xml文件 -->
        <sqlMapGenerator targetPackage="mapper"
                         targetProject="C:/Users/Administrator/IdeaProjects/demo/src/main/resources/">
            <property name="enableSubPackages" value="false" />
        </sqlMapGenerator>

        <!-- 对应的Mapper接口类文件 -->
        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="cn.wallace.mapper" targetProject="C:/Users/Administrator/IdeaProjects/demo/src/main/java">
            <property name="enableSubPackages" value="false" />
        </javaClientGenerator>


        <!-- 列出要生成代码的所有表，这里配置的是不生成Example文件 -->
        <!-- schema即为数据库名 tableName为对应的数据库表 domainObjectName是要生成的实体类 enable*ByExample
                   是否生成 example类   -->
        <table tableName="tbl_user" domainObjectName="User"
               schema="testsql"
               enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false"
               selectByExampleQueryId="false" enableSelectByPrimaryKey="true"
               enableUpdateByPrimaryKey="true" enableDeleteByPrimaryKey="true" >
            <!-- 忽略列，不生成bean 字段
            <ignoreColumn column="FRED" />-->
            <!-- 指定列的java数据类型
            <columnOverride column="LONG_VARCHAR_FIELD" jdbcType="VARCHAR" />  -->
            <!-- 用于指定生成实体类时是否使用实际的列名作为实体类的属性名。false是 Camel Case风格-->
            <property name="useActualColumnNames" value="false" />
        </table>
    </context>
</generatorConfiguration>

这里主要需要修改的配置项有（具体可以参考xml文件的注释部分）：

• classPathEntry:location设置为数据库驱动所在的位置
• jdbcConnection:设置数据库的驱动名，链接，用户名和密码
• javaModelGenerator：设置实体类的包和位置信息
• sqlMapGenerator：设置sqlmapper的包和位置信息
• javaClientGenerator：设置mapper接口的包和位置信息
• table：设置表等信息

3.完成上面的配置之后，就可以使用maven自动生成代码了

生成的目录结构如下

4.至此，在idea中使用mybatis generator生成表信息代码完成。但是其中遇到了两个问题及解决方法如下

• 生成的mapper文件只有insert和insertSelective两个函数，原因为generatorConfig.xml文件在配置table信息时，没有正确配置enableSelectByPrimaryKey="true" enableUpdateByPrimaryKey="true" enableDeleteByPrimaryKey="true"几个属性，参考下图

<table tableName="tbl_user" domainObjectName="User"
               schema="testsql"
               enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false"
               selectByExampleQueryId="false" enableSelectByPrimaryKey="true"
               enableUpdateByPrimaryKey="true" enableDeleteByPrimaryKey="true" >
            <!-- 忽略列，不生成bean 字段
            <ignoreColumn column="FRED" />-->
            <!-- 指定列的java数据类型
            <columnOverride column="LONG_VARCHAR_FIELD" jdbcType="VARCHAR" />  -->
            <!-- 用于指定生成实体类时是否使用实际的列名作为实体类的属性名。false是 Camel Case风格-->
            <property name="useActualColumnNames" value="false" />
        </table>

• maven编译的时候提示Cannot obtain primary key information from the database, generated objects may be incomplete的错误，此时需要在数据库的url后面加上?serverTimezone=UTC& zeroDateTimeBehavior=round& nullCatalogMeansCurrent=true，如下图

  <!-- connectionUrl必须添加serverTimezone=UTC&amp; zeroDateTimeBehavior=round&amp; nullCatalogMeansCurrent=true-->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/testsql?serverTimezone=UTC&amp; zeroDateTimeBehavior=round&amp; nullCatalogMeansCurrent=true" userId="root"
                        password="*****">
        </jdbcConnection>