IDEA自動生成Mapper和實體文件

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

今天用到這塊工具，通過自己的努力終於可以成功的應用，特意把該工程上傳到Github上供大家參考學習，地址：https://github.com/haobindayi/Mybatis-Generator-Mapper
大家可以直接到github上下載，也可以跟着我下面的步驟自己來試一下。

1.新建一個空白的maven工程，填寫必填的項目名稱進入項目頁面。



2.打開pom.xml文件進行修改文件，引入需要的依賴，並修改對應的build的規則。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>github.haobindayi</groupId>
    <artifactId>GenerateMapper</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.3.5</version>
        </dependency>
    </dependencies>
    <build>
        <finalName>haobindayi</finalName>
        <pluginManagement>
            <plugins>
                <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>5.1.46</version>
                        </dependency>
                    </dependencies>
                    <configuration>
                        <!-- mybatis用於生成代碼的配置文件 -->
                        <configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
                        <verbose>true</verbose>
                        <overwrite>true</overwrite>
                    </configuration>
                </plugin>
            </plugins>
        </pluginManagement>
    </build>
</project>

BUG提醒：mysql-connector-java的版本問題，如果你的驅動是com.mysql.cj.jdbc.Driver，你就需要6.0.x的版本。如果是com.mysql.jdbc.Driver 則是5.1.x的版本。
我自己用的是mysql8.0，在idea中配置database後點擊驅動可以查看其版本5.1.46.

3.根據上述的配置文件可以看到需要resources/generatorConfig.xml的配置文件，所以我們新建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">
<!--第二行引入爆紅，說明沒有導入mybatis-generator-core的依賴，導入後刷新maven-->
<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的數據庫連接 
        URL後加的參數可以減少報錯，&連接需要做轉義，SSL版本高需要聲明-->
        <jdbcConnection
                driverClass="com.mysql.jdbc.Driver"
                connectionURL= "jdbc:mysql://localhost:3306/baimax?characterEncoding=utf8&amp;useSSL=false"
                userId= "root"
                password= "root" >
        </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="module" 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="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="user" domainObjectName="User"
               enableCountByExample="false"
               enableUpdateByExample="false"
               enableDeleteByExample="false"
               enableSelectByExample="false"
               selectByExampleQueryId="false">
        </table>
    </context>
</generatorConfiguration>

具體聲明解釋已經在文中標註了，需要更改自己想要生成文件的存放位置，和要生成的table的名稱。

4.添加執行方式，

如下圖，打開配置tomcat的窗口，點擊加號，選擇maven，然後輸入，確定保存即可。

mybatis-generator:generate -e

5.啓動執行生成文件

可以點擊運行中間件的開始符號【Shift + F10】或者打開右側maven，執行Run Configurations即可成功



到這裏自動生成文件的工程就搭建並使用完成了，希望可以幫到困難中的你，如果有什麼疑問呢，歡迎和我進行溝通交流，也可以WX搜一搜「程序員互助圈」一起互幫互助。
我們的世界不只是Code。