SpringBoot基于Mybatis-Plus自動(dòng)代碼生成
前言
大家好啊,我是湯圓,今天給大家?guī)?lái)的是《SpringBoot中的自動(dòng)代碼生成 - 基于Mybatis-Plus》,希望對(duì)大家有幫助,謝謝
簡(jiǎn)介
基于Mybatis-Plus的自動(dòng)代碼生成有很多方式,這里介紹下我在用的兩種:
- 本地代碼生成:Mybatis-Plus官方
- 在線代碼生成:第三方
這兩種各有優(yōu)缺點(diǎn),看喜歡哪一種了
聽(tīng)說(shuō)Idea也有自動(dòng)生成的插件,但是我還沒(méi)去看,我覺(jué)得這倆就夠用了(但也說(shuō)不準(zhǔn)哪天,用了插件后,才發(fā)現(xiàn)柳暗花明呢)
有的官人,可能要問(wèn)了,既然Mybatis-Plus官網(wǎng)有例子了,為啥還要在這里寫(xiě)出來(lái)呢?
是因?yàn)閷?duì)于我這種不熟悉模板引擎的人來(lái)說(shuō),官網(wǎng)介紹的一些配置我們可以省掉,從而減少我們調(diào)試的時(shí)間(因?yàn)槟J(rèn)的模板生成配置就夠用了,我們不需要再去接觸那些模板語(yǔ)法啥的)
本地代碼生成
就是在自己的項(xiàng)目里,寫(xiě)一個(gè)Java程序,配置好各種參數(shù),啟動(dòng)后就可以自動(dòng)生成
這種方法的好處是,直接生成到本地項(xiàng)目,不需要手動(dòng)再去復(fù)制粘貼
缺點(diǎn)就是,剛開(kāi)始的配置比較多(但是一勞永逸)
好了,下面開(kāi)始上代碼,好消息是下面的代碼都有注釋說(shuō)明,另一個(gè)好消息是生成的代碼也是有注釋的(尤其是entity類的字段注解,很實(shí)用)
配置pom.xml
<!-- mybatis-plus代碼生成器 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.4.0</version>
</dependency>
<!-- velocity模板引擎,用于mybatis-plus代碼生成器 -->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.3</version>
</dependency>
<!-- lombok 自動(dòng)生成會(huì)用到-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.16</version>
</dependency>
自動(dòng)生成代碼的Java主程序:參考官網(wǎng)
// 演示例子,執(zhí)行 main 方法控制臺(tái)輸入模塊表名回車(chē)自動(dòng)生成對(duì)應(yīng)項(xiàng)目目錄中
public class GenerateCode {
/**
* <p>
* 讀取控制臺(tái)內(nèi)容
* </p>
*/
public static String scanner(String tip) {
Scanner scanner = new Scanner(System.in);
StringBuilder help = new StringBuilder();
help.append("請(qǐng)輸入" + tip + ":");
System.out.println(help.toString());
if (scanner.hasNext()) {
String ipt = scanner.next();
if (StringUtils.isNotBlank(ipt)) {
return ipt;
}
}
throw new MybatisPlusException("請(qǐng)輸入正確的" + tip + "!");
}
public static void main(String[] args) {
// 代碼生成器
AutoGenerator mpg = new AutoGenerator();
// 1. 全局配置
GlobalConfig gc = new GlobalConfig();
// 項(xiàng)目根目錄
String projectPath = System.getProperty("user.dir");
// 生成代碼的輸出目錄:一般這個(gè)就是固定的,這里不用寫(xiě)到具體的哪個(gè)包,因?yàn)橄旅鏁?huì)單獨(dú)配置包名
gc.setOutputDir(projectPath + "/src/main/java");
// 生成代碼的author
gc.setAuthor("javalover");
// 生成代碼后,是否自動(dòng)打開(kāi)生成的目錄:這里我們不需要,因?yàn)榫褪巧傻疆?dāng)前項(xiàng)目
gc.setOpen(false);
// 設(shè)置全局配置
mpg.setGlobalConfig(gc);
// 2. 數(shù)據(jù)源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/guns?autoReconnect=true&useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=CONVERT_TO_NULL&useSSL=false&serverTimezone=CTT&nullCatalogMeansCurrent=true");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("root");
mpg.setDataSource(dsc);
// 3. 包配置
PackageConfig pc = new PackageConfig();
// 設(shè)置包名:和上面的輸出目錄進(jìn)行拼接(ourDir+parent)
pc.setParent("cn.stylefeng.guns.modular.business");
// 檢測(cè)命令行輸入的模塊名:和上面的包名進(jìn)行拼接(outDir+parent+moduleName),生成代碼都會(huì)放到這個(gè)模塊下
pc.setModuleName(scanner("模塊名"));
mpg.setPackageInfo(pc);
// 4. 策略配置
StrategyConfig strategy = new StrategyConfig();
// 自動(dòng)生成 實(shí)體類的命名:數(shù)據(jù)庫(kù)映射到實(shí)體類,下劃線轉(zhuǎn)駝峰
strategy.setNaming(NamingStrategy.underline_to_camel);
// 這里如果不設(shè)置,會(huì)跟隨上面實(shí)體類的命名設(shè)置
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
// 字段注解:這里我們把表字段的注解打開(kāi),比如@TableField("car_name")
strategy.setEntityTableFieldAnnotationEnable(true);
// 實(shí)體類的父類:如果有就配置,記得加包名
strategy.setSuperEntityClass("cn.stylefeng.roses.kernel.db.api.pojo.entity.BaseEntity");
// 映射類的父類:如果有就配置,記得加包名
strategy.setSuperMapperClass("com.baomidou.mybatisplus.core.mapper.BaseMapper");
// 服務(wù)接口的父類:如果有就配置,記得加包名
strategy.setSuperServiceClass("com.baomidou.mybatisplus.extension.service.IService");
// 服務(wù)實(shí)現(xiàn)類的父類:如果有就配置,記得加包名
strategy.setSuperServiceImplClass("com.baomidou.mybatisplus.extension.service.impl.ServiceImpl");
// 控制器類的父類:如果有就配置,記得加包名
// strategy.setSuperControllerClass("");
// lombok:是否開(kāi)啟Lombok的注解,比如@Data,@EqualsAndHashCode(callSuper = true)
strategy.setEntityLombokModel(true);
// 控制器的@RestController注解:是否開(kāi)啟,不開(kāi)啟則默認(rèn)為@Controller
strategy.setRestControllerStyle(true);
// 監(jiān)測(cè)命令行的輸入:表名
strategy.setInclude(scanner("表名,多個(gè)英文逗號(hào)分割").split(","));
// 控制器的請(qǐng)求映射url風(fēng)格:駝峰轉(zhuǎn)連字符,比如"carList"-> "car-list"
strategy.setControllerMappingHyphenStyle(true);
// 設(shè)置表的前綴:設(shè)置后,生成的類名和Controller的請(qǐng)求映射中就不會(huì)包含表前綴
// 設(shè)置后為 @RequestMapping("/gps/car"),而不是@RequestMapping("/gps/gps-car")
// 類名同理
strategy.setTablePrefix("gps");
mpg.setStrategy(strategy);
// 5. 配置模板引擎
// 默認(rèn)采用velocity模板
// mpg.setTemplateEngine(new VelocityTemplateEngine());
mpg.execute();
}
}
啟動(dòng)程序,在命令行依次輸入包名,表名,等待運(yùn)行完成就可以了
生成后的目錄結(jié)構(gòu)如下:

可以看到,基本的框架都有了
下面我們看下生成的entity文件:
Car.java
/**
* <p>
* 車(chē)輛管理
* </p>
*
* @author javalover
* @since 2021-04-22
*/
@Data
@EqualsAndHashCode(callSuper = true)
@TableName("gps_car")
public class Car extends BaseEntity {
private static final long serialVersionUID = 1L;
/**
* 車(chē)輛id
*/
@TableId("car_id")
private Long carId;
/**
* 所屬公司id
*/
@TableField("company_id")
private Long companyId;
/**
* 車(chē)輛名稱
*/
@TableField("car_name")
private String carName;
/**
* 車(chē)輛種類
*/
@TableField("car_type")
private Integer carType;
/**
* 車(chē)輛顏色
*/
@TableField("car_color")
private String carColor;
/**
* 司機(jī)
*/
@TableField("car_driver")
private String carDriver;
/**
* 車(chē)輛價(jià)格
*/
@TableField("car_price")
private BigDecimal carPrice;
/**
* 油耗
*/
@TableField("fuel_consumption")
private BigDecimal fuelConsumption;
/**
* 車(chē)牌號(hào)
*/
@TableField("car_number")
private String carNumber;
/**
* 車(chē)架號(hào)
*/
@TableField("frame_number")
private String frameNumber;
/**
* 載重
*/
@TableField("load_weight")
private BigDecimal loadWeight;
/**
* 車(chē)照片
*/
@TableField("car_img")
private String carImg;
/**
* 車(chē)輛實(shí)時(shí)定位
*/
@TableField("car_location")
private String carLocation;
}
可以看到,注釋的很詳細(xì)啊,多好(字段的注釋是根據(jù)數(shù)據(jù)庫(kù)的注釋來(lái)的)
在線代碼生成
就是在第三方的網(wǎng)站,配置各種參數(shù),點(diǎn)擊生成就可以了,然后下載到本地
這種方法的好處是,前期不用太多配置,使用方便
缺點(diǎn)就是
- 需要在線配置一個(gè)小型的數(shù)據(jù)庫(kù),上傳SQL語(yǔ)句
- 生成后,需要拉到本地項(xiàng)目中
- 不夠靈活,比如父類的配置等
其實(shí)它的缺點(diǎn)就是因?yàn)樗暮?jiǎn)單導(dǎo)致的
這種就比較適合新的項(xiàng)目,想要快速上手體驗(yàn)的朋友
因?yàn)樵诰€的操作很簡(jiǎn)單,這里給出鏈接,具體操作大家體驗(yàn)下就知道了
在線鏈接:https://gen.stylefeng.cn/#/createCode
總結(jié)
自動(dòng)生成代碼的方式有很多,而這里的只是冰山一角
角1:基于Mybatis-Plus官網(wǎng)的例子(靈活,功能全)
角2:基于第三方的在線生成(簡(jiǎn)單,上手快)
到此這篇關(guān)于SpringBoot基于Mybatis-Plus自動(dòng)代碼生成的文章就介紹到這了,更多相關(guān)SpringBoot Mybatis-Plus自動(dòng)代碼生成內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
SpringBoot實(shí)現(xiàn)多文件上傳的詳細(xì)示例代碼
文件上傳中并沒(méi)有什么太多的知識(shí)點(diǎn),下面這篇文章主要給大家介紹了關(guān)于SpringBoot實(shí)現(xiàn)多文件上傳的詳細(xì)示例,文中通過(guò)實(shí)例代碼介紹的非常詳細(xì),需要的朋友可以參考下2023-03-03
Java的靜態(tài)方法Arrays.asList()使用指南
Arrays.asList() 是一個(gè) Java 的靜態(tài)方法,它可以把一個(gè)數(shù)組或者多個(gè)參數(shù)轉(zhuǎn)換成一個(gè) List 集合,這個(gè)方法可以作為數(shù)組和集合之間的橋梁,方便我們使用集合的一些方法和特性,本文將介紹 Arrays.asList() 的語(yǔ)法、應(yīng)用場(chǎng)景、坑點(diǎn)和總結(jié)2023-09-09
解決springboot生成bean名稱沖突(AnnotationBeanNameGenerator)
這篇文章主要介紹了解決springboot生成bean名稱沖突(AnnotationBeanNameGenerator),具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-03-03
Springmvc如何返回xml及json格式數(shù)據(jù)
這篇文章主要介紹了Springmvc如何返回xml及json格式數(shù)據(jù),文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-09-09
Java 是如何利用接口避免函數(shù)回調(diào)的方法
本篇文章主要介紹了Java 是如何利用接口避免函數(shù)回調(diào)的方法,小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2018-02-02
JAVA正則表達(dá)式過(guò)濾文件的實(shí)現(xiàn)方法
這篇文章主要介紹了JAVA正則表達(dá)式過(guò)濾文件的實(shí)現(xiàn)方法的相關(guān)資料,希望通過(guò)本文大家能夠掌握理解這部分內(nèi)容,需要的朋友可以參考下2017-09-09
SWT(JFace)體驗(yàn)之Sash(活動(dòng)控件)
SWT(JFace)體驗(yàn)之Sash(活動(dòng)控件)2009-06-06
Mybatis模糊查詢及自動(dòng)映射實(shí)現(xiàn)詳解
這篇文章主要介紹了Mybatis模糊查詢及自動(dòng)映射實(shí)現(xiàn)詳解,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-02-02

