自動生成Mapper文件（基於Mybatis Maven插件）

自動生成Mybatis的Mapper文件

　工作中使用mybatis時我們需要根據數據表字段創建pojo類、mapper文件以及dao類，並且需要配置它們之間的依賴關系，這樣的工作很瑣碎和重復，mybatis官方也發現了這個問題，因此給我們提供了mybatis generator工具來幫我們自動創建pojo類、mapper文件以及dao類並且會幫我們配置好它們的依賴關系。

實際上，最非常流行MyBatis-Plus中內置了代碼生成器：采用代碼或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 層代碼，支持模板引擎，有超多自定義配置等，在這主要介紹Mybatis的自動生成步驟。

插件依賴

直接在maven的pom.xml文件中復制粘貼即可。

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.5</version>
            <dependencies>
                <dependency>
                    <groupId>mysql</groupId>
                    <artifactId>mysql-connector-java</artifactId>
                    <version>6.0.6</version>
                </dependency>
                <dependency>
                    <groupId>org.mybatis.generator</groupId>
                    <artifactId>mybatis-generator-core</artifactId>
                    <version>1.3.5</version>
                </dependency>
            </dependencies>
            <configuration>
                <!--允許移動生成的文件 -->
                <verbose>true</verbose>
                <!-- 是否覆蓋 -->
                <overwrite>true</overwrite>
                <!-- 自動生成的配置 -->
                <configurationFile>
                    src/main/resources/generatorConfig.xml
                </configurationFile>
            </configuration>
        </plugin>
    </plugins>
</build>

BUG提醒：mysql-connector-java的版本問題，如果你的驅動是com.mysql.cj.jdbc.Driver，你就需要6.0.x的版本。如果是com.mysql.jdbc.Driver 則是5.1.x的版本。

注意

如果在工作中，你要使用Mybatis的反向工程生成文件，你應該不能在項目pom.xml中引用上圖的依賴，那么你可以專門創建一個sringboot工具項目來生成文件，然后在拖動到你工作項目中。其實我們最需要的是Mapper文件中的restMap，如果你的數據庫字段有30 40 個之多，手動Mapper文件絕對會讓你懷疑人生。

配置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>
    <!--導入屬性配置-->
    <!-- context 是逆向工程的主要配置信息 -->
    <!-- id：name -->
    <!-- targetRuntime：設置生成的文件適用於那個 mybatis 版本 -->
    <context id="default" targetRuntime="MyBatis3">

        <!-- 生成的 Java 文件的編碼 -->
        <property name="javaFileEncoding" value="UTF-8"/>

        <!-- optional，旨在創建class時，對注釋進行控制 -->
        <commentGenerator>
            <property name="suppressDate" value="true"/>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>

        <!--jdbc的數據庫連接 -->
        <jdbcConnection
                driverClass="com.mysql.cj.jdbc.Driver"
                connectionURL= 你數據庫url
                userId= 賬號
                password= 你的密碼 >
        </jdbcConnection>

        <!-- 非必需，類型處理器，在數據庫類型和java類型之間的轉換控制-->
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- Model模型生成器,用來生成含有主鍵key的類，記錄類 以及查詢Example類
            targetPackage     指定生成的model生成所在的包名
            targetProject     指定在該項目下所在的路徑
        -->
        <!--<javaModelGenerator targetPackage="com.mmall.pojo" targetProject=".\src\main\java">-->
        <javaModelGenerator targetPackage="com.ke.likehouse.model" targetProject="./src/main/java">
            <!-- 是否允許子包，即targetPackage.schemaName.tableName -->
            <property name="enableSubPackages" value="false"/>
            <!-- 是否對model添加 構造函數，如果為true則不會生成ResultMap -->
            <property name="constructorBased" value="false"/>
            <!-- 是否對類CHAR類型的列的數據進行trim操作 -->
            <property name="trimStrings" value="true"/>
            <!-- 建立的Model對象是否 不可改變  即生成的Model對象不會有 setter方法，只有構造方法 -->
            <property name="immutable" value="false"/>
        </javaModelGenerator>

        <!--mapper映射文件生成所在的目錄 為每一個數據庫的表生成對應的SqlMap文件 -->
        <!--<sqlMapGenerator targetPackage="mappers" targetProject=".\src\main\resources">-->
        <sqlMapGenerator targetPackage="mybatis/mappers" targetProject="./src/main/resources">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>

        <!-- 客戶端代碼，生成易於使用的針對Model對象和XML配置文件 的代碼
                type="ANNOTATEDMAPPER",生成Java Model 和基於注解的Mapper對象
                type="MIXEDMAPPER",生成基於注解的Java Model 和相應的Mapper對象
                type="XMLMAPPER",生成SQLMap XML文件和獨立的Mapper接口
        -->
        <!-- targetPackage：mapper接口dao生成的位置 -->
        <!--<javaClientGenerator type="XMLMAPPER" targetPackage="com.mmall.dao" targetProject=".\src\main\java">-->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.ke.likehouse.dao" targetProject="./src/main/java">
            <!-- enableSubPackages:是否讓schema作為包的后綴 -->
            <property name="enableSubPackages" value="false" />
        </javaClientGenerator>

        <!--生成的表-->
        <!--domainObjectName：生成的domain類的名字，如果不設置，直接使用表名作為domain類的名字；可以設置為somepck.domainName，那么會自動把domainName類再放到somepck包里面；-->
        <!--enableInsert（默認true）：指定是否生成insert語句；-->
        <!--enableSelectByPrimaryKey（默認true）：指定是否生成按照主鍵查詢對象的語句（就是getById或get）；-->
        <!--enableSelectByExample（默認true）：MyBatis3Simple為false，指定是否生成動態查詢語句；-->
        <!--enableUpdateByPrimaryKey（默認true）：指定是否生成按照主鍵修改對象的語句（即update)；-->
        <!--enableDeleteByPrimaryKey（默認true）：指定是否生成按照主鍵刪除對象的語句（即delete）；-->
        <!--enableDeleteByExample（默認true）：MyBatis3Simple為false，指定是否生成動態刪除語句；-->
        <!--enableCountByExample（默認true）：MyBatis3Simple為false，指定是否生成動態查詢總條數語句（用於分頁的總條數查詢）；-->
        <!--enableUpdateByExample（默認true）：MyBatis3Simple為false，指定是否生成動態修改語句（只修改對象中不為空的屬性）；-->
        <table tableName="agent" domainObjectName="Agent"
               enableCountByExample="false"
               enableUpdateByExample="false"
               enableDeleteByExample="false"
               enableSelectByExample="false"
               selectByExampleQueryId="false">
        </table>

        <!-- geelynote mybatis插件的搭建 -->
    </context>
</generatorConfiguration>

上圖的配置文件中包含了幾乎所有你可能用到的參數配置並帶有注釋，最終在IDEA中你看到項目結構應該是這樣的：

執行maven命令

IDEA 的右方有MAVEN工具欄

1. 方式一：通過IDEA的MAVEN工具執行
   

2. 方式二：通過MAVEN命令
   配置命令：mybatis-generator:generate -e
   

然后Run就好了：

run成功后，你會在你配置的項目文件夾下看到生成好的代碼，然后基於此再做修改。

可能出現的BUG

如果你復制粘貼了代碼卻出現稀奇古怪的BUG，很有可能是：

1. 你的maven的配置文件問題
2. 引用的mysql-connector-java與driverClassName版本不匹配

如果你的驅動是com.mysql.cj.jdbc.Driver，你就需要6.x.x的版本。如果是com.mysql.jdbc.Driver 則是5.x.x的版本。