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>