MybatisX簡介
MybatisX是一款基于IDEA的快速開發插件,由MyBatis-Plus團隊開發維護,爲效率而生。
它的主要功能如下:
支持mapper.xml和Mapper接口之間方法的互相導航跳轉;內置代碼生成器,通過使用GUI的形式,能根據數據庫來生成Domain、mapper.xml、Mapper、Service和Service實現類代碼;可以自定義代碼生成器模板;可以通過類似JPA的方式,直接根據方法名稱在mapper.xml中生成查詢實現,同時支持提示。使用
接下來介紹下MybatisX的使用,這裏以我的腳手架項目mall-tiny爲例。
安裝
在使用前我們需要在插件市場中搜索並安裝MyBatisX插件。
![](http://image.uc.cn/s/wemedia/s/upload/2024/cb9f517942a713290a98ea02e0ad111d.png)
安裝完成後我們會發現所有的Mapper接口和mapper.xml文件都變成了MyBatis的小鳥圖標。
![](http://image.uc.cn/s/wemedia/s/upload/2024/8fb9318bf5c08b1c6be222186536bb21.png)
XML與接口互跳
我們點擊Mapper接口方法左側的圖標可以直接跳轉到mapper.xml對應的SQL實現,在mapper.xml點擊左側圖標也可以直接跳轉到Mapper接口中對應的方法。
![](http://image.uc.cn/s/wemedia/s/upload/2024/82d48892be30820907fcb7a4485be219.gif)
自動生成代碼
還記得之前在mall-tiny項目中我們手寫的代碼生成器麽,MyBatisX直接整了個帶圖形化界面的,下面我們來體驗下。
選中表以後右鍵可以直接生成對應表的CRUD代碼,當然你也可以多選,支持一次性生成多表;
![](http://image.uc.cn/s/wemedia/s/upload/2024/fd5758a5a7de53ee947f4f86ce58c086.png)
生成的時候可以通過GUI來修改選項,比如修改基礎包路徑、實體類包路徑等;
![](http://image.uc.cn/s/wemedia/s/upload/2024/281afaa473a5be6018e23372d58ab82c.png)
生成時選擇注解和模板類型爲Mybatis-Plus 3,有需要的話可以勾選Lombok選項以及修改mapper.xml的文件路徑;
![](http://image.uc.cn/s/wemedia/s/upload/2024/f412d709c9fee4ae8b5f285f626e7dab.png)
點擊確認後將生成如下文件,還記得之前在mall-tiny項目中用代碼寫的代碼生成器麽,有了GUI就用不著手寫了!
![](http://image.uc.cn/s/wemedia/s/upload/2024/4123d89328b00b646ba94a1e66dfd828.png)
自定義生成模板
如果你覺得默認的代碼生成器模板不符合你的要求,還可以試試自定義模板。
我們一般會在實體類中加入Swagger的注解,方便API文檔的生成,MyBatisX默認生成的實體類是不帶Swagger注解的;
![](http://image.uc.cn/s/wemedia/s/upload/2024/046cfb8ee7f7057515254345f0a1225b.png)
MyBatisX也提供了生成帶Swagger注解的實體類模板,但是有點複雜不太符合我的要求,我們可以修改下生成模板,生成模板都在extensions->MyBaitsX目錄下;
![](http://image.uc.cn/s/wemedia/s/upload/2024/9c803bfe46e5274a7a1d219bc17813e8.png)
這裏我們修改下domain.ftl文件即可,最終文件內容如下;package ${domain.packageName};import java.io.Serializable;<#list tableClass.importList as fieldType>${"\n"}import ${fieldType};</#list>import io.swagger.annotations.ApiModelProperty;import io.swagger.annotations.ApiModel;import lombok.Data;import lombok.EqualsAndHashCode;import com.baomidou.mybatisplus.annotation.TableName;/*** ${tableClass.remark!}*/@Data@EqualsAndHashCode(callSuper = false)@TableName("${tableClass.tableName}")@ApiModel(value="${tableClass.shortClassName}對象", description="${tableClass.remark!}")public ${tableClass.shortClassName} implements Serializable { private static final long serialVersionUID=1L;<#list tableClass.allFields as field> @ApiModelProperty("${field.remark!}") private ${field.shortTypeName} ${field.fieldName};</#list>}然後再運行代碼生成器,選擇只生成帶Swagger注解的實體類;
![](http://image.uc.cn/s/wemedia/s/upload/2024/33b104050d5bde5deb8381ad9012d327.png)
生成完成後實體類就會帶上Swagger注解了,是不是很方便!
![](http://image.uc.cn/s/wemedia/s/upload/2024/2718a3bf3a6cb2a4ddc69c90a950e4df.png)
JPA提示
MyBatisX還有個強大的功能,可以根據JPA風格的方法名直接生成SQL實現,無需手寫SQL。
例如我們想寫個批量插入數據方法,就可以這樣來操作;
![](http://image.uc.cn/s/wemedia/s/upload/2024/b3dc1c1e713a7f9fd318a7a0aec0fdfa.gif)
例如我們想寫個根據名稱查詢品牌的方法,MyBatisX會像JPA一樣自動提示字段,並且能自動生成SQL實現;
![](http://image.uc.cn/s/wemedia/s/upload/2024/46bb64124711ca0d529663889f449200.gif)
例如我們想寫個根據ID修改品牌名稱的方法;
![](http://image.uc.cn/s/wemedia/s/upload/2024/898f9345d56675ada8461931cca44c8b.gif)
例如我們想寫個根據名稱刪除品牌的方法,MyBatisX的JPA提示還是非常全面的!
![](http://image.uc.cn/s/wemedia/s/upload/2024/e3e5e1d94638f3e67c61229d3d081e85.gif)
圖標設置
如果你不想Mapper接口和mapper.xml文件都變成小鳥圖標的話,可以做在MyBatisX的設置中進行修改。
![](http://image.uc.cn/s/wemedia/s/upload/2024/9f2c4612d5ca47034d36e288af7d9afe.png)
總結
MyBatisX確實是一款非常好用的IDEA插件,不僅提示全面,而且自帶了圖形化的代碼生成器,能極大地提高我們的開發效率。MyBatisX中的JPA提示功能也非常不錯,只要你的方法命名符合JPA規範,就能自動生成SQL實現,確實是個好功能。