Mybatis-Plus開發(fā)提速器generator的使用
前言
在基于Mybatis的開發(fā)模式中,很多開發(fā)者還會(huì)選擇Mybatis-Plus來(lái)輔助功能開發(fā),以此提高開發(fā)的效率。雖然Mybatis也有代碼生成的工具,但Mybatis-Plus由于在Mybatis基礎(chǔ)上做了一些調(diào)整,因此,常規(guī)的生成工具生成的代碼還有一些不太符合預(yù)期。而且對(duì)于多數(shù)據(jù)庫(kù)的支持不是很好。
因此,我們需要一款支持高度定制化,帶圖形UI頁(yè)面,能適配多數(shù)數(shù)據(jù)庫(kù)的基礎(chǔ)程序生成框架。本文就介紹這款基于Mybatis-Plus的代碼自助生成器,github地址:mybatis-plus-generator-ui。
文章通過(guò)實(shí)例集成的方式來(lái)詳細(xì)講解mybatis-plus-generator-ui,感興趣的朋友可以自己clone下來(lái),也可以自己進(jìn)行擴(kuò)展自定義。
一、mybatis-plus-generator-ui是什么?
它是對(duì)mybatis-plus-generator進(jìn)行封裝,通過(guò)Web UI快速生成兼容Spring boot,mybatis-plus框架的各類業(yè)務(wù)代碼。提供交互式的Web UI用于生成兼容mybatis-plus框架的相關(guān)功能代碼,包括Entity、Mapper、Mapper.xml、Service、Controller等,可以自定義模板以及各類輸出參數(shù),也可通過(guò)SQL查詢語(yǔ)句直接生成代碼。


功能列表:
- Table查詢: 查詢配置的關(guān)系型數(shù)據(jù)庫(kù)表的列表查詢。
- 輸出配置: 對(duì)需要生成的相關(guān)代碼,比如Entity、Mapper、Servcie、Controller等代碼模板信息進(jìn)行配置,用于在轉(zhuǎn)換時(shí)調(diào)用。
- 項(xiàng)目導(dǎo)入: 可以導(dǎo)入其它項(xiàng)目配置好的信息給本項(xiàng)目使用。
- 下載模板: 支持本項(xiàng)目配置的模板信息下載后共享。
- 策略配置: 直接定義各種文件的生成策略。
- 模板上傳: 支持從別的項(xiàng)目中下載模板,同上傳供本項(xiàng)目使用。
- SQL輸入上傳: 支持將查詢語(yǔ)句直接上傳或者復(fù)制到輸入框中。
- SQL代碼生成: 基于SQL腳本生成相應(yīng)的代碼。
二、 mybatis-plus-generator-ui怎么用?
mybatis-plus-generator-ui提供以jar包的形式為外部項(xiàng)目提供服務(wù),通過(guò)配置的數(shù)據(jù)庫(kù)配置去讀取數(shù)據(jù)庫(kù)的配置信息,并通過(guò)Web UI的方式提供給開發(fā)者使用。mybatis-plus-generator-ui支持POSTGRE_SQL、ORACLE、DB2、MySQL、SQLSERVER等常見的關(guān)系型數(shù)據(jù)庫(kù)。
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函數(shù)的方式運(yùn)行
mybatis-plus-generator-ui在1.4.0版本之后,可支持將GeberatorUIServer獨(dú)立部署為一個(gè)單獨(dú)的spring boot項(xiàng)目,通過(guò)頁(yè)面指定目標(biāo)項(xiàng)目根目錄的方式為多個(gè)項(xiàng)目提供源碼生成服務(wù)。這種方式適用于有多個(gè)項(xiàng)目庫(kù)需要獨(dú)立進(jìn)行開發(fā)的模式。實(shí)例關(guān)鍵代碼如下:
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").driverClassName("org.postgresql.Driver")
// 數(shù)據(jù)庫(kù)schema,POSTGRE_SQL,ORACLE,DB2類型的數(shù)據(jù)庫(kù)需要指定
// .schemaName("myBusiness")
// 如果需要修改各類生成文件的默認(rèn)命名規(guī)則,可自定義一個(gè)NameConverter實(shí)例,覆蓋相應(yīng)的名稱轉(zhuǎn)換方法:
.nameConverter(new NameConverter() {
/**
* 自定義Service類文件的名稱規(guī)則
*/
public String serviceNameConvert(String tableName) {
return this.entityNameConvert(tableName) + "Service";
}
/**
* 自定義Controller類文件的名稱規(guī)則
*/
public String controllerNameConvert(String tableName) {
return this.entityNameConvert(tableName) + "Action";
}
}).basePackage("com.github.davidfantasy.mybatisplustools.example").port(8068).build();
MybatisPlusToolsApplication.run(config);
}
}在上面的配置中,我們連接的示例數(shù)據(jù)庫(kù)是PostgerSQL,需要在Maven中定義相應(yīng)的驅(qū)動(dòng)程序,并且在上述代碼中正確配置相應(yīng)的類。最后指定了程序的運(yùn)行端口為8086,這種運(yùn)行方式跟SpringBoot非常相似。
3、實(shí)例運(yùn)行
運(yùn)行以上的main方法,在控制臺(tái)可以看到以下輸出即為成功部署。

在輸出的日志中,可以看到程序的運(yùn)行端口,以及默認(rèn)的模板目錄地址。在瀏覽器中輸入訪問(wèn)地址http://localhost:8068/,即可進(jìn)行配置生成。
三、mybatis-plus-generator-ui代碼生成
1、Table的查詢和瀏覽
可以直接瀏覽和查詢配置的數(shù)據(jù)源的數(shù)據(jù)表信息,可選擇一個(gè)或多個(gè)生成模板代碼。

2、輸出配置
內(nèi)置Entity、Mapper、Service、Controller等6種類型代碼的模板配置,可以上傳模板進(jìn)行替換,并修改各類參數(shù),配置參數(shù)已經(jīng)按照影響的文件類型重新進(jìn)行了分類,并加入了部分文本說(shuō)明;也可以自行添加其它類型的自定義輸出文件。所有的配置項(xiàng)都會(huì)按照項(xiàng)目包名進(jìn)行保存,只需一次性設(shè)置就可以了。

3、策略配置
將每次生成代碼時(shí)可能變動(dòng)的內(nèi)容加入到代碼生成選項(xiàng)中,方便調(diào)整每次的生成策略,比如:是否覆蓋原文件,生成文件的種類等等:

4、SQL配置生成
通過(guò)輸入查詢SQL,可自動(dòng)在Mapper(Xml及Java)中生成對(duì)應(yīng)的查詢方法,DTO對(duì)象和ResultMap(結(jié)果集映射配置)

5、代碼生成


四、自定義擴(kuò)展
1、相關(guān)模板調(diào)整
在相關(guān)的頁(yè)面中,可以進(jìn)行相應(yīng)的調(diào)整,在對(duì)應(yīng)的btl模板中下載對(duì)應(yīng)文件的具體模板,使用文本工具打開,直接修改源代碼,文中取一種方式示例,其它方式一樣。


2、代碼層級(jí)的配置
在一些團(tuán)隊(duì)中,肯定對(duì)Mapper的定義為Dao,Controller層需要定義為Action,通過(guò)修改代碼模板btl的方式是可以的,還有一種方式是通過(guò)調(diào)整內(nèi)部映射的方式來(lái)進(jìn)行修改。主要使用的類是NameConverter。
/**
* 自定義Service類文件的名稱規(guī)則
*/
public String serviceNameConvert(String tableName) {
return this.entityNameConvert(tableName) + "Service";
}
/**
* 自定義Controller類文件的名稱規(guī)則
*/
public String controllerNameConvert(String tableName) {
return this.entityNameConvert(tableName) + "Action";
}除了Service、Controller、Entity、FieldName都可以實(shí)現(xiàn)自定義的擴(kuò)展。下面是NameConverter類的核心代碼,這里有詳細(xì)的定義。
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;
/**
* 自定義各類名稱轉(zhuǎn)換的規(guī)則
*/
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()));
}
/**
* 自定義表字段名到實(shí)體類屬性名的轉(zhuǎn)換規(guī)則
*
* @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 在頁(yè)面上輸入的輸出文件標(biāo)識(shí)
* @param tableName 關(guān)聯(lián)的數(shù)據(jù)表名稱名稱
* @return 生成文件的名稱,帶后綴
*/
default String outputFileNameConvert(String fileType, String tableName) {
if (fileType.equals(Constant.FILE_TYPE_ENTITY)) {
return this.entityNameConvert(tableName) + DOT_JAVA;
} else if (fileType.equals(Constant.FILE_TYPE_MAPPER)) {
return this.mapperNameConvert(tableName) + DOT_JAVA;
} else if (fileType.equals(Constant.FILE_TYPE_MAPPER_XML)) {
return this.mapperXmlNameConvert(tableName) + DOT_XML;
} else if (fileType.equals(Constant.FILE_TYPE_SERVICE)) {
return this.serviceNameConvert(tableName) + DOT_JAVA;
} else if (fileType.equals(Constant.FILE_TYPE_SERVICEIMPL)) {
return this.serviceImplNameConvert(tableName) + DOT_JAVA;
} else if (fileType.equals(Constant.FILE_TYPE_CONTROLLER)) {
return this.controllerNameConvert(tableName) + DOT_JAVA;
}
return this.entityNameConvert(tableName) + fileType;
}
}mybatis-plus-generator-ui的功能非常豐富,甚至針對(duì)ui都是可以自定義修改的。如果需要定制UI的話,將代碼clone下來(lái)后,進(jìn)入到frontend目錄下,進(jìn)行相應(yīng)的擴(kuò)展開發(fā)。

修改完成后,需要另行編譯src\frontend中的靜態(tài)資源(源碼中不包含已編譯的頁(yè)面),在src\frontend文件夾中執(zhí)行:
yarn install yarn run build
五、總結(jié)
以上就是今天要講的內(nèi)容,本文簡(jiǎn)要介紹一款基于Mybatis-Plus的代碼自助生成器,地址:https://github.com/davidfantasy/mybatis-plus-generator-ui
文章通過(guò)實(shí)例集成的方式來(lái)詳細(xì)講解mybatis-plus-generator-ui,從相關(guān)概念到實(shí)際集成案例,以及具體的擴(kuò)展開發(fā)介紹。如果在工作中有這種需要,不妨采用這種方式。
到此這篇關(guān)于Mybatis-Plus開發(fā)提速器generator的使用的文章就介紹到這了,更多相關(guān)Mybatis-Plus generator內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
- Mybatis generator修改Mapper.java文件實(shí)現(xiàn)詳解
- MyBatis?Generator?ORM層面的代碼自動(dòng)生成器(推薦)
- 更簡(jiǎn)單更高效的Mybatis?Plus最新代碼生成器AutoGenerator
- MybatisX-Generator自動(dòng)代碼生成插件教程
- Mybatis代碼生成器Mybatis Generator(MBG)實(shí)戰(zhàn)詳解
- MyBatis-Plus中AutoGenerator的使用案例
- Mybatis-plus?代碼生成器?AutoGenerator?的簡(jiǎn)介和使用詳解
- MyBatis Generator介紹及使用方法
- MyBatis Generator配置入門
- mybatis-generator-gui根據(jù)需求改動(dòng)示例
- MyBatis?Generator使用小結(jié)
相關(guān)文章
項(xiàng)目總結(jié)之HttpURLConnection的disconnect的問(wèn)題
這篇文章主要介紹了項(xiàng)目總結(jié)之HttpURLConnection的disconnect的問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-06-06
spring-redis-session 自定義 key 和過(guò)期時(shí)間
這篇文章主要介紹了spring-redis-session 自定義 key 和過(guò)期時(shí)間,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2019-12-12
Java用POI解析excel并獲取所有單元格數(shù)據(jù)的實(shí)例
下面小編就為大家?guī)?lái)一篇Java用POI解析excel并獲取所有單元格數(shù)據(jù)的實(shí)例。小編覺得挺不錯(cuò)的,現(xiàn)在就分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2017-10-10
Java Spring分別實(shí)現(xiàn)定時(shí)任務(wù)方法
這篇文章主要為大家詳細(xì)介紹了Java與Spring設(shè)置動(dòng)態(tài)定時(shí)任務(wù)的方法,定時(shí)任務(wù)的應(yīng)用場(chǎng)景十分廣泛,如定時(shí)清理文件、定時(shí)生成報(bào)表、定時(shí)數(shù)據(jù)同步備份等2022-07-07
ssm框架Springmvc文件上傳實(shí)現(xiàn)代碼詳解
這篇文章主要介紹了ssm框架Springmvc文件上傳實(shí)現(xiàn)代碼詳解,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-07-07
舉例說(shuō)明Java設(shè)計(jì)模式編程中ISP接口隔離原則的使用
這篇文章主要介紹了Java設(shè)計(jì)模式編程中ISP接口隔離原則的使用,接口隔離原則主張一個(gè)類對(duì)另外一個(gè)類的依賴性應(yīng)當(dāng)是建立在最小的接口上,需要的朋友可以參考下2016-02-02
Java畢業(yè)設(shè)計(jì)實(shí)戰(zhàn)之財(cái)務(wù)預(yù)算管理系統(tǒng)的實(shí)現(xiàn)
這是一個(gè)使用了java+SSM+Jsp+Mysql+Layui+Maven開發(fā)的財(cái)務(wù)預(yù)算管理系統(tǒng),是一個(gè)畢業(yè)設(shè)計(jì)的實(shí)戰(zhàn)練習(xí),具有財(cái)務(wù)預(yù)算管理該有的所有功能,感興趣的朋友快來(lái)看看吧2022-02-02
SpringBoot后端數(shù)據(jù)校驗(yàn)實(shí)戰(zhàn)操作指南
在項(xiàng)?開發(fā)中,對(duì)于前端提交的表單,后臺(tái)接?接收到表單數(shù)據(jù)后,為了保證程序的嚴(yán)謹(jǐn)性,通常后端會(huì)加?業(yè)務(wù)參數(shù)的合法校驗(yàn)操作來(lái)避免程序的?技術(shù)性?bug,這篇文章主要給大家介紹了關(guān)于SpringBoot后端數(shù)據(jù)校驗(yàn)的相關(guān)資料,需要的朋友可以參考下2022-07-07

