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

SpringBoot實戰(zhàn)電商項目mall（50k+star）地址： https://github.com/macrozheng/mall

MybatisX簡介

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

它的主要功能如下：

• 支持mapper.xml和Mapper接口之間方法的互相導(dǎo)航跳轉(zhuǎn)；
• 內(nèi)置代碼生成器，通過使用GUI的形式，能根據(jù)數(shù)據(jù)庫來生成Domain、mapper.xml、Mapper、Service和Service實現(xiàn)類代碼；
• 可以自定義代碼生成器模板；
• 可以通過類似JPA的方式，直接根據(jù)方法名稱在mapper.xml中生成查詢實現(xiàn)，同時支持提示。

使用

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

安裝

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

安裝完成后我們會發(fā)現(xiàn)所有的Mapper接口和mapper.xml文件都變成了MyBatis的小鳥圖標。

XML與接口互跳

我們點擊Mapper接口方法左側(cè)的圖標可以直接跳轉(zhuǎn)到mapper.xml對應(yīng)的SQL實現(xiàn)，在mapper.xml點擊左側(cè)圖標也可以直接跳轉(zhuǎn)到Mapper接口中對應(yīng)的方法。

自動生成代碼

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

• 選中表以后右鍵可以直接生成對應(yīng)表的CRUD代碼，當然你也可以多選，支持一次性生成多表；

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

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

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

自定義生成模板

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

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

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

• 這里我們修改下domain.ftl 文件即可，最終文件內(nèi)容如下；

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注解的實體類；

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

JPA提示

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

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

• 例如我們想寫個根據(jù)名稱查詢品牌的方法，MyBatisX會像JPA一樣自動提示字段，并且能自動生成SQL實現(xiàn)；

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

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

圖標設(shè)置

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

總結(jié)

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