mybatisplus自定義sql查詢（試試MyBatis-Plus同款IDEA插件吧）

2023-05-16 07:45:21 1

最近發現之前使用的MyBatis插件很久都沒更新了，就想換個其他插件來用用。偶然發現MyBatis-Plus團隊也開發了一款插件MyBatisX，體驗了一把確實非常好用，提示很全，而且還能通過GUI生成代碼，推薦給大家！

MybatisX簡介

MybatisX是一款基於IDEA的快速開發插件，由MyBatis-Plus團隊開發維護，為效率而生。

它的主要功能如下：

支持mapper.xml和Mapper接口之間方法的互相導航跳轉；內置代碼生成器，通過使用GUI的形式，能根據資料庫來生成Domain、mapper.xml、Mapper、Service和Service實現類代碼；可以自定義代碼生成器模板；可以通過類似JPA的方式，直接根據方法名稱在mapper.xml中生成查詢實現，同時支持提示。使用

接下來介紹下MybatisX的使用，這裡以我的腳手架項目mall-tiny為例。

安裝

在使用前我們需要在插件市場中搜索並安裝MyBatisX插件。

安裝完成後我們會發現所有的Mapper接口和mapper.xml文件都變成了MyBatis的小鳥圖標。

XML與接口互跳

我們點擊Mapper接口方法左側的圖標可以直接跳轉到mapper.xml對應的SQL實現，在mapper.xml點擊左側圖標也可以直接跳轉到Mapper接口中對應的方法。

自動生成代碼

還記得之前在mall-tiny項目中我們手寫的代碼生成器麼，MyBatisX直接整了個帶圖形化界面的，下面我們來體驗下。

選中表以後右鍵可以直接生成對應表的CRUD代碼，當然你也可以多選，支持一次性生成多表；

生成的時候可以通過GUI來修改選項，比如修改基礎包路徑、實體類包路徑等；

生成時選擇註解和模板類型為Mybatis-Plus 3，有需要的話可以勾選Lombok選項以及修改mapper.xml的文件路徑；

點擊確認後將生成如下文件，還記得之前在mall-tiny項目中用代碼寫的代碼生成器麼，有了GUI就用不著手寫了！

自定義生成模板

如果你覺得默認的代碼生成器模板不符合你的要求，還可以試試自定義模板。

我們一般會在實體類中加入Swagger的註解，方便API文檔的生成，MyBatisX默認生成的實體類是不帶Swagger註解的；

MyBatisX也提供了生成帶Swagger註解的實體類模板，但是有點複雜不太符合我的要求，我們可以修改下生成模板，生成模板都在extensions->MyBaitsX目錄下；

這裡我們修改下domain.ftl文件即可，最終文件內容如下；

package ${domain.packageName};import java.io.Serializable;${"\n"}import ${fieldType};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}對象",)public class ${tableClass.shortClassName} implements Serializable { private static final long serialVersionUID=1L; @ApiModelProperty("${field.remark!}") private ${field.shortTypeName} ${field.fieldName};}

然後再運行代碼生成器，選擇只生成帶Swagger註解的實體類；

生成完成後實體類就會帶上Swagger註解了，是不是很方便！

JPA提示

MyBatisX還有個強大的功能，可以根據JPA風格的方法名直接生成SQL實現，無需手寫SQL。

例如我們想寫個批量插入數據方法，就可以這樣來操作；

例如我們想寫個根據名稱查詢品牌的方法，MyBatisX會像JPA一樣自動提示欄位，並且能自動生成SQL實現；

例如我們想寫個根據ID修改品牌名稱的方法；

例如我們想寫個根據名稱刪除品牌的方法，MyBatisX的JPA提示還是非常全面的！

圖標設置

如果你不想Mapper接口和mapper.xml文件都變成小鳥圖標的話，可以做在MyBatisX的設置中進行修改。

總結

MyBatisX確實是一款非常好用的IDEA插件，不僅提示全面，而且自帶了圖形化的代碼生成器，能極大地提高我們的開發效率。MyBatisX中的JPA提示功能也非常不錯，只要你的方法命名符合JPA規範，就能自動生成SQL實現，確實是個好功能。

參考資料

官方文檔：https://baomidou.com/pages/ba5b24/

來源：https://mp.weixin.qq.com/s/IkSwjT01H1mLtHK0xb14wA

,