還在手寫SQL實現?試試MyBatis-Plus同款IDEA外掛吧!提示太全了,還能一鍵生成程式碼!

macrozheng 發表於 2022-11-24
MyBatis SQL
最近發現之前使用的MyBatis外掛很久都沒更新了,就想換個其他外掛來用用。偶然發現MyBatis-Plus團隊也開發了一款外掛MyBatisX,體驗了一把確實非常好用,提示很全,而且還能透過GUI生成程式碼,推薦給大家!

SpringBoot實戰電商專案mall(50k+star)地址:https://github.com/macrozheng/mall

MybatisX簡介

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

它的主要功能如下:

  • 支援mapper.xml和Mapper介面之間方法的互相導航跳轉;
  • 內建程式碼生成器,透過使用GUI的形式,能根據資料庫來生成Domain、mapper.xml、Mapper、Service和Service實現類程式碼;
  • 可以自定義程式碼生成器模板;
  • 可以透過類似JPA的方式,直接根據方法名稱在mapper.xml中生成查詢實現,同時支援提示。

使用

接下來介紹下MybatisX的使用,這裡以我的腳手架專案mall-tiny為例。

安裝

在使用前我們需要在外掛市場中搜尋並安裝MyBatisX外掛。

還在手寫SQL實現?試試MyBatis-Plus同款IDEA外掛吧!提示太全了,還能一鍵生成程式碼!

安裝完成後我們會發現所有的Mapper介面和mapper.xml檔案都變成了MyBatis的小鳥圖示。

還在手寫SQL實現?試試MyBatis-Plus同款IDEA外掛吧!提示太全了,還能一鍵生成程式碼!

XML與介面互跳

我們點選Mapper介面方法左側的圖示可以直接跳轉到mapper.xml對應的SQL實現,在mapper.xml點選左側圖示也可以直接跳轉到Mapper介面中對應的方法。

還在手寫SQL實現?試試MyBatis-Plus同款IDEA外掛吧!提示太全了,還能一鍵生成程式碼!

自動生成程式碼

還記得之前在mall-tiny專案中我們手寫的程式碼生成器麼,MyBatisX直接整了個帶圖形化介面的,下面我們來體驗下。
  • 選中表以後右鍵可以直接生成對應表的CRUD程式碼,當然你也可以多選,支援一次性生成多表;

還在手寫SQL實現?試試MyBatis-Plus同款IDEA外掛吧!提示太全了,還能一鍵生成程式碼!

  • 生成的時候可以透過GUI來修改選項,比如修改基礎包路徑、實體類包路徑等;

還在手寫SQL實現?試試MyBatis-Plus同款IDEA外掛吧!提示太全了,還能一鍵生成程式碼!

  • 生成時選擇註解和模板型別為Mybatis-Plus 3,有需要的話可以勾選Lombok選項以及修改mapper.xml的檔案路徑;

還在手寫SQL實現?試試MyBatis-Plus同款IDEA外掛吧!提示太全了,還能一鍵生成程式碼!

  • 點選確認後將生成如下檔案,還記得之前在mall-tiny專案中用程式碼寫的程式碼生成器麼,有了GUI就用不著手寫了!

還在手寫SQL實現?試試MyBatis-Plus同款IDEA外掛吧!提示太全了,還能一鍵生成程式碼!

自定義生成模板

如果你覺得預設的程式碼生成器模板不符合你的要求,還可以試試自定義模板。
  • 我們一般會在實體類中加入Swagger的註解,方便API文件的生成,MyBatisX預設生成的實體類是不帶Swagger註解的;

還在手寫SQL實現?試試MyBatis-Plus同款IDEA外掛吧!提示太全了,還能一鍵生成程式碼!

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

還在手寫SQL實現?試試MyBatis-Plus同款IDEA外掛吧!提示太全了,還能一鍵生成程式碼!

  • 這裡我們修改下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 class ${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註解的實體類;

還在手寫SQL實現?試試MyBatis-Plus同款IDEA外掛吧!提示太全了,還能一鍵生成程式碼!

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

還在手寫SQL實現?試試MyBatis-Plus同款IDEA外掛吧!提示太全了,還能一鍵生成程式碼!

JPA提示

MyBatisX還有個強大的功能,可以根據JPA風格的方法名直接生成SQL實現,無需手寫SQL。
  • 例如我們想寫個批次插入資料方法,就可以這樣來操作;

還在手寫SQL實現?試試MyBatis-Plus同款IDEA外掛吧!提示太全了,還能一鍵生成程式碼!

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

還在手寫SQL實現?試試MyBatis-Plus同款IDEA外掛吧!提示太全了,還能一鍵生成程式碼!

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

還在手寫SQL實現?試試MyBatis-Plus同款IDEA外掛吧!提示太全了,還能一鍵生成程式碼!

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

還在手寫SQL實現?試試MyBatis-Plus同款IDEA外掛吧!提示太全了,還能一鍵生成程式碼!

圖示設定

如果你不想Mapper介面和mapper.xml檔案都變成小鳥圖示的話,可以做在MyBatisX的設定中進行修改。

還在手寫SQL實現?試試MyBatis-Plus同款IDEA外掛吧!提示太全了,還能一鍵生成程式碼!

總結

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

參考資料

官方文件:https://baomidou.com/pages/ba...