Mybatis Generator具體使用小技巧

Posted on by

1、問題描述

mybatis generator 簡單說就是生成一些mybatis的公共方法，用瞭好多年瞭，一直也沒記錄過，最近使用稍微有瞭點變話，簡單記錄下，方便下次使用，也希望可以幫到其他人。

2、解決方案

最近使用主要有兩點變化：

（1）以前使用，指定瞭本地數據庫驅動jar包，本次直接用maven，dependency指定下就好瞭，配置文件配置好後，團隊人員都可以執行；

（2）發現朋友使用的方式挺好的，就是初期開發過程中，不可避免的會增加或修改一些字段，xml中新加或者重新生成方法，都有點麻煩，通過新增一個新的類，繼承屬性，可以盡可能減少改動；

2.1 pom中指定mybatis generator 插件

  <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.4.0</version>
                <configuration>
            <configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
                    <verbose>true</verbose>
                    <overwrite>true</overwrite>
                </configuration>
                <dependencies>
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>8.0.25</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>

說明：

在插件中指定（dependency）數據庫的驅動， 示例中使用的是：mysql，oracel數據庫更換成oracle驅動就好瞭；

2.2 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="DB2Tables" targetRuntime="MyBatis3">
          <commentGenerator>
            <!-- 是否去除自動生成的註釋 true：是 ： false:否 -->
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>

        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://127.0.0.1:3306/ruanjianlaowang"
                        userId="laowang"
                        password="laowang">
        </jdbcConnection>
        
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>
        <javaModelGenerator targetPackage="com.laowang.lwcrud.db.entity" targetProject="./src/main/java">
            <property name="enableSubPackages" value="true"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <sqlMapGenerator targetPackage="com.laowang.lwcrud.db.mapper" targetProject="./src/main/java">
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.laowang.lwcrud.db.mapper" targetProject="src/main/java">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>
        <table tableName="user" domainObjectName="User" enableInsert="true"
               enableDeleteByPrimaryKey="true"
               enableSelectByPrimaryKey="true"
               enableUpdateByPrimaryKey="true"
               enableCountByExample="false"
               enableDeleteByExample="true"
               enableSelectByExample="true"
               enableUpdateByExample="true">
            <property name="useActualColumnNames" value="false"/>
<!--            <generatedKey column="id" sqlStatement="MYSQL" identity="true"/>-->
        </table>

    </context>
</generatorConfiguration>

說明：

（1）<jdbcConnection><jdbcConnection>,用於指定數據庫連接；
（2）<javaModelGenerator></javaModelGenerator>指定entity目錄；
（3）<javaClientGenerator type=”XMLMAPPER” ></javaClientGenerator >指定Mapper接口目錄；
（4）<sqlMapGenerator></sqlMapGenerator>指定xml文件類目錄；
（5）<table></table>指定具體數據表，其中的幾個參數自己可以試試，帶ByExample是生成示例，有些朋友喜歡用這個方式，個人還是比較喜歡直接用原始sql，加參數的方式；
（6）這裡有個點，<table>中的generatedKey，假如數據庫用自增id的話，可以選擇這個，使用uuid的話，註釋掉就好瞭。

2.3 執行

2.3.1 雙擊插件

文件生成完成：

2.3.2 生成實體類

生成兩個實體類；對應數據庫中字段；

2.3.3 生成mapper類

生成mapper方法，包含常用的保存、更新、刪除等；

2.3.4 生成xml類

生成xml方法，對應Mapper接口方法；

2.3.5 生成擴展文件 （mapper）

新增擴展文件，在原有mapper後面增加Ext；

2.3.6 生成擴展文件（extmapper.xml）

說明：

擴展類繼承，自動生成的屬性，這個新增或者修改的屬性同時會生效；

<mapper namespace="com.laowang.lwcrud.db.mapper.UserExtMapper">
    <resultMap id="BaseResultMap" type="com.laowang.lwcrud.db.entity.User"
               extends="com.laowang.lwcrud.db.mapper.UserMapper.BaseResultMap">
    </resultMap>

2.4 總結

整體來說，就是個工具的使用，通過插件生成公共的數據庫操作方法，然後通過新增擴展ext文件記錄自定義方法，避免每次修改數據庫字段，對自定義的方法造成影響（假如有指定的屬性字段修改瞭，也要一並修改），可以方便的使用；

到此這篇關於Mybatis Generator具體使用小技巧的文章就介紹到這瞭,更多相關Mybatis Generator使用內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：