mybatis自動生成代碼插件mybatis-generator使用流程(親測可用)

mybatis-generator是一款在使用mybatis框架時，自動生成model，dao和mapper的工具，很大程度上減少了業務開發人員的手動編碼時間

坐着在idea上用maven構建springboot項目,親測可用,流程記錄如下

1.添加依賴

<!--mybatis逆向工程-->
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.3.7</version>
        </dependency>

2.添加maven插件,在build的plugins中添加

<!--mybatis逆向工程-->
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.7</version>
                <configuration>
                    <configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
                    <verbose>true</verbose>
                    <overwrite>true</overwrite>
                </configuration>
            </plugin>

3.插件的配置文件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>

    <!--
        可以用於加載配置項或者配置文件
        resource：配置資源加載地址，使用resource，從classpath開始找，比如com/myproject/generatorConfig.properties
        url：配置資源加載地質，使用URL的方式，比如file:///C:/myfolder/generatorConfig.properties.
        注意，兩個屬性只能選址一個
     -->
    <!--導入屬性配置-->
    <properties resource="datasource.properties"/>

    <!--指定特定數據庫的jdbc驅動jar包的位置-->
    <!-- 暫時不清楚怎么指定相對路徑，只能指定maven倉庫中的jar包 -->
    <classPathEntry location="D:/repository/mysql/mysql-connector-java/8.0.12/mysql-connector-java-8.0.12.jar"/>

    <!--
    context:生成一組對象的環境
    id:必選，上下文id，用於在生成錯誤時提示
    targetRuntime:
        1，MyBatis3：默認的值，生成基於MyBatis3.x以上版本的內容，包括XXXBySample；
        2，MyBatis3Simple：類似MyBatis3，只是不生成XXXBySample；
-->
    <context id="default" targetRuntime="MyBatis3">

        <!--生成的bean是沒有tostring方法的，所以如果要想生成tostring方法的話，需要在generatorConfig.xml中加上如下配置-->
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin"></plugin>
        <!-- 該元素最多可以配置1個,可以生成文件的注釋 -->
        <commentGenerator>
            <!--阻止生成的注釋包含時間戳,默認為false-->
            <property name="suppressDate" value="true"/>
            <!--阻止生成注釋,默認為false-->
            <property name="suppressAllComments" value="true"/>
            <!--設置要使用的Java文件的編碼-->
            <property name="javaFileEncoding" value="UTF-8"/>
        </commentGenerator>

        <!--jdbc的數據庫連接，引入上述的配置文件datasource.properties的內容,這里直接寫死也可以 -->
        <jdbcConnection
                driverClass="${jdbc.driverClass}"
                connectionURL="${jdbc.url}"
                userId="${jdbc.username}"
                password="${jdbc.password}">
        </jdbcConnection>

        <!-- 是否使用bigDecimal， false可自動轉化以下類型（Long, Integer, Short, etc.） -->
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- Model模型生成器,用來生成數據庫對應的實體類
            targetPackage     指定生成的實體類 所在的包名
            targetProject     指定在該項目下所在的路徑
        -->
        <javaModelGenerator targetPackage="com.pdzx.entity" targetProject="D:/workspaces/pdzx-customer-microservice/pdzx-manage-system/src/main/java">
            <!-- 是否允許子包，eg：fase路徑com.pdzx.entity， true:com.pdzx.entity..[schemaName] -->
            <property name="enableSubPackages" value="false"/>
            <!-- 是否對model添加 構造函數 -->
            <property name="constructorBased" value="false"/>
            <!-- 建立的Model對象是否 不可改變  即生成的Model對象不會有 setter方法，只有構造方法 -->
            <property name="immutable" value="false"/>
            <!-- 設置是否在getter方法中，對String類型字段調用trim()方法 -->
            <!--如果設置為true就會生成類似這樣  public void setUsername(String username) {this.username = username == null ? null : username.trim();}-->
            <property name="trimStrings" value="false"/>
        </javaModelGenerator>

        <!--mapper映射文件生成所在的目錄 為每一個數據庫的表生成對應的SqlMap文件,就是用xml寫SQL的方式 -->
        <sqlMapGenerator targetPackage="com.pdzx.mapper" targetProject="D:/workspaces/pdzx-customer-microservice/pdzx-manage-system/src/main/java">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>

        <!--
                生成易於使用的針對Model對象和XML配置文件 的代碼,即dao層接口文件
                type="ANNOTATEDMAPPER",基於注解的Mapper接口，不會有對應的XML映射文件
                type="MIXEDMAPPER",XML和注解的混合形式，(上面這種情況中的)SqlProvider注解方法會被XML替代
                type="XMLMAPPER",所有的方法都在XML中，接口調用依賴XML文件。
        -->
        <!-- targetPackage：mapper接口dao生成的位置 -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.pdzx.dao" targetProject="D:/workspaces/pdzx-customer-microservice/pdzx-manage-system/src/main/java">
            <!-- enableSubPackages:是否讓schema作為包的后綴 -->
            <property name="enableSubPackages" value="false" />
        </javaClientGenerator>

        <!--
        tableName為對應的數據庫表
         domainObjectName是要生成的實體類
          enable*ByExample是否生成 example類   -->
        <table tableName="b_template_useclient"
               domainObjectName="TemplateUseclient"
               enableCountByExample="false"
               enableUpdateByExample="false"
               enableDeleteByExample="false"
               enableSelectByExample="false"
               selectByExampleQueryId="false">
            <!-- 上面的屬性都可以使用子標簽形式表示 -->
            <!-- 是否使用真實字段名，設置為false將自動駝峰轉換 -->
            <property name="useActualColumnNames" value="false" />
        </table>

    </context>
    
</generatorConfiguration>

4.數據庫配置文件datasource.properties

jdbc.driverClass=com.mysql.cj.jdbc.Driver
jdbc.url=jdbc:mysql://139.196.51.7:3306/pdafc?characterEncoding=utf8&useSSL=false&allowMultiQueries=true&nullCatalogMeansCurrent=true&tinyInt1isBit=false
jdbc.username=xxx
jdbc.password=xxx

注意兩個問題的解決方案:

1. mybatis自動生成的代碼只有insert()和insertSelective()

　　解決方案:在jdbc url后增加下面代碼即可

nullCatalogMeansCurrent=true

 

2.mybatis 自動生成代碼對於tinyint 類型自動解析成BOOLEAN類型

　　解決方案:對於tinyint 類型自動解析成BYTE類型  在jdbc.url后增加下面代碼即可

 tinyInt1isBit=false

 

5.如下圖所示,執行該插件生成代碼即可