使用代碼生成器自定義Entity的部分注解
代碼生成器自定義Entity部分注解
對(duì)mybatis-plus代碼生成器的entity模板進(jìn)行部分自定義
此文章觀看前提:已經(jīng)能用mybatis-plus自動(dòng)生成代碼
前因
因?yàn)樵心0遄詣?dòng)生成的entity為下面這樣,表字段為name,age,number,但我想生成圖2的樣子,在每個(gè)字段前面添加個(gè)注解@ApiModelProperty()


查找了我的代碼生成器那個(gè)配置類
debug了最后要生成模板的兩句,找到了我的entity的生成模板為/templates/entity.java.ftl(因?yàn)槟0逡媸莊reemarker,所以后綴為ftl)


隨后在templates/entity.java.ftl里
找到模板生成的代碼,然后在屬性模板前面加上這個(gè)代碼

<#if swagger2>
@ApiModelProperty(value = "${field.propertyName}",dataType = "${field.propertyType}",required = true)
</#if>還有一點(diǎn)
記得在配置類中設(shè)置開啟 swagger2 模式

代碼生成器最新版配置方案
因?yàn)樽罱鼘戫?xiàng)目使用到了MyBatis-Plus,所以去官網(wǎng)找到了一個(gè)代碼生成器的新版,現(xiàn)在網(wǎng)上能查到的都是之前的舊版生成器代碼,官方提供的快速生成沒有開啟Lombok、RestController還有很多自定義類名的策略。
新版對(duì)依賴版本有要求,適用版本:mybatis-plus-generator 3.5.1 及其以上版本,對(duì)歷史版本不兼容!
<dependency> ? ? <groupId>com.baomidou</groupId> ? ? <artifactId>mybatis-plus-generator</artifactId> ? ? <version>3.5.1</version> </dependency> <!--對(duì)MyBatisPlus代碼生成器進(jìn)行支持的模板引擎--> <dependency> ? ? ?<groupId>org.freemarker</groupId> ? ? ?<artifactId>freemarker</artifactId> ? ? ?<version>2.3.30</version> </dependency> <dependency> ? ? ?<groupId>com.baomidou</groupId> ? ? ?<artifactId>mybatis-plus-boot-starter</artifactId> ? ? ?<version>3.5.1</version> </dependency>
本著喜新厭舊的初心,我根據(jù)官方文檔配置了一個(gè)新版常用的快速生成器,修改數(shù)據(jù)庫配置并設(shè)計(jì)好表之后填入表名直接運(yùn)行使用就行了,如果要配置詳細(xì)的策略請(qǐng)去官網(wǎng)查文檔配置。MyBatis代碼生成器官方文檔
import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import xyz.tylt.controller.BaseController;
import java.util.Collections;
/*
* MyBatisPlus代碼生成器
*/
public class CodeGenerator {
public static void main(String[] args) {
String drive = "D://";
String xmlpath = drive + "xyz//resource//mapper";
String projectPath = System.getProperty("user.dir");
FastAutoGenerator.create("jdbc:mysql://localhost:3306/databasename?useSSl=ture&serverTimezone=UTC&useUnicode=true&characterEncoding=UTF-8", "root", "1234")
.globalConfig(builder -> {
builder.author("tylt6688")// 設(shè)置作者
.enableSwagger() // 開啟 swagger 模式
.fileOverride() // 覆蓋已生成文件
.outputDir(drive); // 指定輸出目錄
})
.packageConfig(builder -> {
builder.parent("xyz.tylt") // 設(shè)置父包名
// .moduleName("system") // 設(shè)置父包模塊名
.pathInfo(Collections.singletonMap(OutputFile.mapperXml, xmlpath)); // 設(shè)置mapperXml生成路徑
})
//實(shí)體策略配置
.strategyConfig(builder -> {
builder.entityBuilder()
//開啟Lombok,默認(rèn)生成@Get,@Set,可以手動(dòng)換成@Data
.enableLombok();
})
//控制類策略配置
.strategyConfig(builder -> {
builder.controllerBuilder()
//如果沒有父類請(qǐng)注釋掉
.superClass(BaseController.class)
.enableRestStyle();
})
//服務(wù)類策略配置
.strategyConfig(builder -> {
builder.serviceBuilder()
.formatServiceFileName("%sService")
.formatServiceImplFileName("%sServiceImp");
})
.strategyConfig(builder -> {
builder.addInclude("tb_teachplan")// 設(shè)置數(shù)據(jù)庫中表名,按其中屬性內(nèi)容進(jìn)行生成
// .addInclude("tb_floor")
// .addInclude("tb_room")
.addTablePrefix("tb_", "c_", "sys_"); // 設(shè)置過濾表前綴進(jìn)行生成
})
.templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板,默認(rèn)的是Velocity引擎模板
.execute();
}
}
以上為個(gè)人經(jīng)驗(yàn),希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
相關(guān)文章
在Web項(xiàng)目中手機(jī)短信驗(yàn)證碼實(shí)現(xiàn)的全過程記錄
這篇文章主要給大家介紹了關(guān)于在Web項(xiàng)目中實(shí)現(xiàn)短信驗(yàn)證碼的全過程記錄,文中通過示例代碼介紹的非常詳細(xì),在文末跟大家提供了源碼下載,需要的朋友可以參考借鑒,下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧。2017-12-12
解決springboot 2.x 里面訪問靜態(tài)資源的坑
這篇文章主要介紹了解決springboot 2.x 里面訪問靜態(tài)資源的坑,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-08-08
使用springboot通過spi機(jī)制加載mysql驅(qū)動(dòng)的過程
這篇文章主要介紹了使用springboot通過spi機(jī)制加載mysql驅(qū)動(dòng)的過程,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-07-07
Java Springboot之Spring家族的技術(shù)體系
今天帶大家來學(xué)習(xí)Spring家族的技術(shù)體系,文中有非常詳細(xì)的圖文介紹及代碼示例,對(duì)正在學(xué)習(xí)java的小伙伴們很有幫助,需要的朋友可以參考下2021-05-05
Java基于遞歸和循環(huán)兩種方式實(shí)現(xiàn)未知維度集合的笛卡爾積算法示例
這篇文章主要介紹了Java基于遞歸和循環(huán)兩種方式實(shí)現(xiàn)未知維度集合的笛卡爾積算法,結(jié)合實(shí)例形式分析了Java使用遞歸與循環(huán)兩種方式實(shí)現(xiàn)未知維度集合的笛卡爾積相關(guān)概念、原理與操作技巧,需要的朋友可以參考下2017-12-12

