Mybatis-Plus 開發提速器：mybatis-plus-generator-ui

點選關註公眾號，Java幹貨 及時送達 👇

前言

在基於Mybatis的開發模式中，很多開發者還會選擇Mybatis-Plus來輔助功能開發，以此提高開發的效率。雖然Mybatis也有程式碼生成的工具，但Mybatis-Plus由於在Mybatis基礎上做了一些調整，因此，常規的生成工具生成的程式碼還有一些不太符合預期。而且對於多資料庫的支持不是很好。

因此，我們需要一款支持高度客製化，帶圖形UI頁面，能適配多數資料庫的基礎程式生成框架。本文就介紹這款基於Mybatis-Plus的程式碼自助生成器，github地址:mybatis-plus-generator-ui。

文章透過例項整合的方式來詳細講解mybatis-plus-generator-ui，感興趣的朋友可以自己clone下來，也可以自己進行擴充套件自訂。

一、mybatis-plus-generator-ui是什麽？

它是對mybatis-plus-generator進行封裝，透過Web UI快速生成相容Spring boot，mybatis-plus框架的各類業務程式碼。提供互動式的Web UI用於生成相容mybatis-plus框架的相關功能程式碼，包括Entity、Mapper、Mapper.xml、Service、Controller等，可以自訂樣版以及各類輸出參數，也可透過SQL查詢語句直接生成程式碼。

功能列表：

二、 mybatis-plus-generator-ui怎麽用？

mybatis-plus-generator-ui提供以jar包的形式為外部計畫提供服務，透過配置的資料庫配置去讀取資料庫的配置資訊，並透過Web UI的方式提供給開發者使用。mybatis-plus-generator-ui支持POSTGRE_SQL、ORACLE、DB2、MySQL、SQLSERVER等常見的關系型資料庫。

1、maven pom引入

<project xmlns="http://maven.apache.org/POM/4.0.0"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 <modelVersion>4.0.0</modelVersion>
 <groupId>com.yelang</groupId>
 <artifactId>mybatis-plus-generator-ui-case</artifactId>
 <version>0.0.1-SNAPSHOT</version>
 <dependencies>
<dependency>
<groupId>com.github.davidfantasy</groupId>
<artifactId>mybatis-plus-generator-ui</artifactId>
<version>1.4.5</version>
</dependency>
<dependency>
<groupId>org.postgresql</groupId>
<artifactId>postgresql</artifactId>
<version>42.2.25</version>
</dependency>
 </dependencies>
</project>


2、新建程式入口，以main函式的方式執行

mybatis-plus-generator-ui在1.4.0版本之後，可支持將GeberatorUIServer獨立部署為一個單獨的spring boot計畫，透過頁面指定目標計畫根目錄的方式為多個計畫提供源碼生成服務。這種方式適用於有多個計畫庫需要獨立進行開發的模式。例項關鍵程式碼如下：

package com.yelang;
import com.github.davidfantasy.mybatisplus.generatorui.GeneratorConfig;
import com.github.davidfantasy.mybatisplus.generatorui.MybatisPlusToolsApplication;
import com.github.davidfantasy.mybatisplus.generatorui.mbp.NameConverter;
public class GeneratorMain {
 public static void main(String[] args) {
GeneratorConfig config = GeneratorConfig.builder().jdbcUrl("jdbc:postgresql://127.0.0.1:5432/ghyapp")
.userName("ghy01").password("ghy01").driver className("org.postgresql.Driver")
// 資料庫schema，POSTGRE_SQL,ORACLE,DB2型別的資料庫需要指定
// .schemaName("myBusiness")
// 如果需要修改各類生成檔的預設命名規則，可自訂一個NameConverter例項，覆蓋相應的名稱轉換方法：
.nameConverter(new NameConverter() {
/**
* 自訂Service類檔的名稱規則
*/
public String serviceNameConvert(String tableName) {
return this.entityNameConvert(tableName) + "Service";
}
/**
* 自訂Controller類檔的名稱規則
*/
public String controllerNameConvert(String tableName) {
return this.entityNameConvert(tableName) + "Action";
}
}).basePackage("com.github.davidfantasy.mybatisplustools.example").port(8068).build();
MybatisPlusToolsApplication.run(config);
 }
}







在上面的配置中，我們連線的範例資料庫是PostgerSQL，需要在Maven中定義相應的驅動程式，並且在上述程式碼中正確配置相應的類。最後指定了程式的執行埠為8086，這種執行方式跟SpringBoot非常相似。

3、例項執行

執行以上的main方法，在控制台可以看到以下輸出即為成功部署。

在輸出的日誌中，可以看到程式的執行埠，以及預設的樣版目錄地址。在瀏覽器中輸入存取地址http://localhost:8068/，即可進行配置生成。

三、mybatis-plus-generator-ui程式碼生成

1、Table的查詢和瀏覽

可以直接瀏覽和查詢配置的資料來源的數據表資訊，可選擇一個或多個生成樣版程式碼。

2、輸出配置

內建Entity、Mapper、Service、Controller等6種型別程式碼的樣版配置，可以上傳樣版進行替換，並修改各類參數，配置參數已經按照影響的檔型別重新進行了分類，並加入了部份文本說明；也可以自行添加其它型別的自訂輸出檔。所有的配置項都會按照計畫包名進行保存，只需一次性設定就可以了。

3、策略配置

將每次生成程式碼時可能變動的內容加入到程式碼生成選項中，方便調整每次的生成策略，比如：是否覆蓋原檔，生成檔的種類等等：

4、SQL配置生成

透過輸入查詢SQL，可自動在Mapper（Xml及Java）中生成對應的查詢方法，DTO物件和ResultMap（結果集對映配置）

5、程式碼生成

四、自訂擴充套件

1、相關樣版調整

在相關的頁面中，可以進行相應的調整，在對應的btl樣版中下載對應檔的具體樣版，使用文本工具開啟，直接修改原始碼，文中取一種方式範例，其它方式一樣。

2、程式碼層級的配置

在一些團隊中，肯定對Mapper的定義為Dao，Controller層需要定義為Action，透過修改程式碼樣版btl的方式是可以的，還有一種方式是透過調整內部對映的方式來進行修改。主要使用的類是NameConverter。

/**
* 自訂Service類檔的名稱規則
*/
public String serviceNameConvert(String tableName) {
return this.entityNameConvert(tableName) + "Service";
}
/**
* 自訂Controller類檔的名稱規則
*/
public String controllerNameConvert(String tableName) {
return this.entityNameConvert(tableName) + "Action";
}

除了Service、Controller、Entity、FieldName都可以實作自訂的擴充套件。下面是NameConverter類的核心程式碼，這裏有詳細的定義。

package com.github.davidfantasy.mybatisplus.generatorui.mbp;
import cn.hutool.core.util.StrUtil;
import com.github.davidfantasy.mybatisplus.generatorui.dto.Constant;
import com.google.common.base.Strings;
import static com.github.davidfantasy.mybatisplus.generatorui.dto.Constant.DOT_JAVA;
import static com.github.davidfantasy.mybatisplus.generatorui.dto.Constant.DOT_XML;
/**
 * 自訂各類名稱轉換的規則
 */
public interface NameConverter {
/**
* 自訂Entity.java的類名稱
*
* @param tableName 表名稱
* @return
*/
default String entityNameConvert(String tableName) {
if (Strings.isNullOrEmpty(tableName)) {
return"";
}
tableName = tableName.substring(tableName.indexOf(StrUtil.UNDERLINE) + 1, tableName.length());
return StrUtil.upperFirst(StrUtil.toCamelCase(tableName.toLowerCase()));
}
/**
* 自訂表欄位名到實體類內容名的轉換規則
*
* @param fieldName 表欄位名稱
* @return
*/
default String propertyNameConvert(String fieldName) {
if (Strings.isNullOrEmpty(fieldName)) {
return"";
}
if (fieldName.contains("_")) {
return StrUtil.toCamelCase(fieldName.toLowerCase());
}
return fieldName;
}
/**
* 自訂Mapper.java的類名稱
*/
default String mapperNameConvert(String tableName) {
return entityNameConvert(tableName) + "Mapper";
}
/**
* 自訂Mapper.xml的檔名稱
*/
default String mapperXmlNameConvert(String tableName) {
return entityNameConvert(tableName) + "Mapper";
}
/**
* 自訂Service.java的類名稱
*/
default String serviceNameConvert(String tableName) {
return"I" + entityNameConvert(tableName) + "Service";
}
/**
* 自訂ServiceImpl.java的類名稱
*/
default String serviceImplNameConvert(String tableName) {
return entityNameConvert(tableName) + "ServiceImpl";
}
/**
* 自訂Controller.java的類名稱
*/
default String controllerNameConvert(String tableName) {
return entityNameConvert(tableName) + "Controller";
}
/**
* 自訂其它生成檔的檔名（不包括entity,mapper.java,mapper.xml,service,serviceImpl,controller這6種）
*
* @param fileType 在頁面上輸入的輸出檔標識
* @param tableName 關聯的數據表名稱名稱
* @return 生成檔的名稱，帶字尾
*/
default String outputFileNameConvert(String fileType, String tableName) {
if (fileType.equals(Constant.FILE_TYPE_ENTITY)) {
return this.entityNameConvert(tableName) + DOT_JAVA;
} elseif (fileType.equals(Constant.FILE_TYPE_MAPPER)) {
return this.mapperNameConvert(tableName) + DOT_JAVA;
} elseif (fileType.equals(Constant.FILE_TYPE_MAPPER_XML)) {
return this.mapperXmlNameConvert(tableName) + DOT_XML;
} elseif (fileType.equals(Constant.FILE_TYPE_SERVICE)) {
return this.serviceNameConvert(tableName) + DOT_JAVA;
} elseif (fileType.equals(Constant.FILE_TYPE_SERVICEIMPL)) {
return this.serviceImplNameConvert(tableName) + DOT_JAVA;
} elseif (fileType.equals(Constant.FILE_TYPE_CONTROLLER)) {
return this.controllerNameConvert(tableName) + DOT_JAVA;
}
return this.entityNameConvert(tableName) + fileType;
}
}












mybatis-plus-generator-ui的功能非常豐富，甚至針對ui都是可以自訂修改的。如果需要客製UI的話，將程式碼clone下來後，進入到frontend目錄下，進行相應的擴充套件開發。

修改完成後，需要另行編譯src\frontend中的靜態資源（源碼中不包含已編譯的頁面），在src\frontend資料夾中執行：

yarn install
yarn run build


五、總結

以上就是今天要講的內容，本文簡要介紹一款基於Mybatis-Plus的程式碼自助生成器，地址:

https://github.com/davidfantasy/mybatis-plus-generator-ui

文章透過例項整合的方式來詳細講解mybatis-plus-generator-ui，從相關概念到實際整合案例，以及具體的擴充套件開發介紹。如果在工作中有這種需要，不妨采用這種方式。希望本文對您有所幫助，歡迎指導交流。

END

看完本文有收獲？請轉發分享給更多人

關註「Java編程鴨」，提升Java技能

關註Java編程鴨微信公眾號，後台回復：碼農大禮包可以獲取最新整理的技術資料一份。涵蓋Java 框架學習、架構師學習等！

文章有幫助的話，在看，轉發吧。

謝謝支持喲 (*^__^*）