若依代碼生成器原理velocity模板引擎（自用）

1.源碼分析

代碼生成器:導入表結構(預覽、編輯、刪除、同步)、生成前后端代碼

代碼生成器表結構說明：

若依提供了兩張核心表來存儲導入的業務表信息：

gen_table：存儲業務表的基本信息，它對應于配置代碼基本信息和生成信息的頁面

gen_table_column：存儲業務表的字段信息它對應于配置代碼字段信息的頁面。

這兩張表是一對多的關系，一張業務表可以有多個字段的信息，所以在字段信息表中有個外鍵table_id指向

代碼生成器目錄結構：

查詢數據庫列表

當管理員在界面上點擊導入按鈕時，會彈出一個對話框，此時，前端需要向后端發送請求，查詢數據庫并返回到前端，展示當前項目庫中所有待導入的業務表。

前端：

此功能涉及前端相關的代碼位于views/tool/index.vue這個視圖組件中，負責實現導入業務表的用戶界面和交互邏輯。

/** 打開導入表彈窗 */
function openImportTable() {proxy.$refs["importRef"].show();
}

后端：

后端處理邏輯則在代碼生成模塊的GenController中，負責接收前端的請求，處理業務邏輯，并返回查詢結果。

/*** 查詢數據庫列表*/
@PreAuthorize("@ss.hasPermi('tool:gen:list')")
@GetMapping("/db/list")
public TableDataInfo dataList(GenTable genTable)
{startPage();List<GenTable> list = genTableService.selectDbTableList(genTable);return getDataTable(list);
}

具體的執行流程如下圖：

導入表結構：

前端：此功能涉及前端相關的代碼位于views/tool/importTable.vue這個視圖組件中，負責實現導入業務表的用戶界面和交互邏輯。

/** 導入按鈕操作 */
function handleImportTable() {const tableNames = tables.value.join(",");if (tableNames == "") {proxy.$modal.msgError("請選擇要導入的表");return;}importTable({ tables: tableNames }).then(res => {proxy.$modal.msgSuccess(res.msg);if (res.code === 200) {visible.value = false;emit("ok");}});
}

后端:后端處理邏輯則在代碼生成模塊的GenController中，負責接收前端的請求，處理業務邏輯，保存業務表的基本信息和字段信息

/*** 導入表結構（保存）*/
@PreAuthorize("@ss.hasPermi('tool:gen:import')")
@Log(title = "代碼生成", businessType = BusinessType.IMPORT)
@PostMapping("/importTable")
public AjaxResult importTableSave(String tables)
{// 將表名字符串轉換為數組 tb_task_collect,tb_vendout_runningString[] tableNames = Convert.toStrArray(tables);// 查詢表信息List<GenTable> tableList = genTableService.selectDbTableListByNames(tableNames);// 導入表結構（保存）genTableService.importGenTable(tableList, SecurityUtils.getUsername());return success();
}

具體的執行的流程如下圖：

生成代碼

首先管理員，選中需要下載的業務表，并點擊生成按鈕來觸發代碼生成并下載的過程。

前端隨后向后端發送請求，這個請求會告知服務器需要生成代碼的業務表。

前端：

負責實現這一功能的前端代碼位于views/tool/index.vue這個視圖組件中，負責實現生成業務表的用戶界面和交互邏輯。

/** 生成代碼操作 */
function handleGenTable(row) {const tbNames = row.tableName || tableNames.value;if (tbNames == "") {proxy.$modal.msgError("請選擇要生成的數據");return;}if (row.genType === "1") {genCode(row.tableName).then(response => {proxy.$modal.msgSuccess("成功生成到自定義路徑：" + row.genPath);});} else {proxy.$download.zip("/tool/gen/batchGenCode?tables=" + tbNames, "ruoyi.zip");}
}

后端：后端的邏輯處理則在代碼生成模塊的GenController中，這里是處理前端請求、執行代碼生成邏輯，將生成的代碼字節流通過HTTP響應返回給客戶端。

/*** 批量生成代碼*/
@PreAuthorize("@ss.hasPermi('tool:gen:code')")
@Log(title = "代碼生成", businessType = BusinessType.GENCODE)
@GetMapping("/batchGenCode")
public void batchGenCode(HttpServletResponse response, String tables) throws IOException
{// 將表名字符串轉換為數組 tb_task_collect,tb_vendout_runningString[] tableNames = Convert.toStrArray(tables);// 根據表名下載生成的代碼字節數組byte[] data = genTableService.downloadCode(tableNames);// 將生成的代碼字節流通過HTTP響應返回給客戶端genCode(response, data);
}

具體的執行的流程如下圖：

問題分析

我們已經對代碼生成器的工作原理有了一定的了解，接下來我們解決一些項目中使用的問題，比如：

每次生成代碼都需要修改作者，去除實體類前綴過于繁瑣，現在我們可以修改generator.yml配置文件來調整為自己項目的

# 代碼生成
gen:# 作者author: itheima# 默認生成包路徑 system 需改成自己的模塊名稱 如 system monitor toolpackageName: com.dkd.manage# 自動去除表前綴，默認是falseautoRemovePre: true# 表前綴（生成類名不會包含表前綴，多個用逗號分隔）tablePrefix: sys_,tb_

velocity模板引擎

Velocity官網:https://velocity.apache.org
Velocitv是一個|ava模板引擎，它使用特定語法在模板中嵌入lava對象數據，實現界面與代碼的分離

常見的應用場景：

Web內容生成 : 生成動態Web頁面。
代碼生成 : 生成Java源代碼、SQL腳本、XML配置文件等。
網頁靜態化 : 生成靜態網頁。

入門

<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>velocity快速入門</title>
</head>
<body><h3>心懷夢想，堅持不懈，成功即在前方。加油少年！！</h3></body>
</html>

準備模板

<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>velocity快速入門</title>
</head>
<body><h3>心懷夢想，堅持不懈，成功即在前方。${message}</h3></body>
</html>

上述代碼中的加油少年修改為了 ${message} 這是一個動態變量（占位符），方便動態填充數據

數據填充

編寫java代碼實現數據填充，并生成文件

package com.dkd.test;import com.dkd.generator.util.VelocityInitializer;
import org.apache.velocity.Template;
import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.Velocity;import java.io.FileWriter;
import java.util.List;public class VelocityDemoTest {public static void main(String[] args) throws Exception {//1. 初始化模板引擎VelocityInitializer.initVelocity();//2. 準備數據模型VelocityContext velocityContext = new VelocityContext();velocityContext.put("message", "加油朋友！！");//3. 讀取模板Template template = Velocity.getTemplate("vm/index.html.vm", "UTF-8");//4. 渲染模板FileWriter fileWriter = new FileWriter("D:\\workspace\\index.html");template.merge(velocityContext, fileWriter);fileWriter.close();}
}

基礎語法-變量

Velocity中的變量有兩類

在模板中定義變量： #set開頭，比如 #set($name = "velocity")
獲取變量的的值： $name 或者 ${name}

下面是案例，基于剛才的入門案例模板改進

##雙#號是vm的注釋

<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>velocity快速入門</title>
</head>
<body><h3>心懷夢想，堅持不懈，成功即在前方。${message}</h3>
##定義變量
#set ($name = "velocity")##輸出變量
第一種情況:${name} <br>
第二種情況:$name## 第三種情況：orderService#set($column = "order")
字符串拼接：${column}Service <br>
</body>
</html>

對象的定義獲取

在ruoyi-generator模塊下新增一個區域的實體類

package com.dkd.test;import com.dkd.common.annotation.Excel;
import com.dkd.common.core.domain.BaseEntity;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;/*** 區域管理對象 tb_region** @author itheima* @date 2024-06-05*/
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Region extends BaseEntity {private static final long serialVersionUID = 1L;/*** 主鍵ID*/private Long id;/*** 區域名稱*/@Excel(name = "區域名稱")private String regionName;}

準備模型數據

package com.dkd.test;import com.dkd.generator.util.VelocityInitializer;
import org.apache.velocity.Template;
import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.Velocity;import java.io.FileWriter;
import java.util.List;public class VelocityDemoTest {public static void main(String[] args) throws Exception {//1. 初始化模板引擎VelocityInitializer.initVelocity();//2. 準備數據模型VelocityContext velocityContext = new VelocityContext();velocityContext.put("message", "加油朋友！！");// 創建區域對象Region region = new Region(1L, "北京北五環");velocityContext.put("region", region);//3. 讀取模板Template template = Velocity.getTemplate("vm/index.html.vm", "UTF-8");//4. 渲染模板FileWriter fileWriter = new FileWriter("D:\\workspace\\index.html");template.merge(velocityContext, fileWriter);fileWriter.close();}
}

動態模板展示數據

<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>velocity快速入門</title>
</head>
<body><h3>心懷夢想，堅持不懈，成功即在前方。${message}</h3>## 定義變量
#set($name = "velocity")## 輸出變量
第一種情況：${name} <br>
第二種情況：$name <br>## 第三種情況：orderService
#set($column = "order")
字符串拼接：${column}Service <br>
<hr>## 獲取區域對象中的數據
區域ID:$region.id <br>
區域名稱:${region.regionName} <br>
<hr>
</body>
</html>

基礎語法-循環

循環的語法：#foreach(...) ... #end

##定義一個集合
#set($list = ["春", "夏", "秋", "冬"])    ## 遍歷循環
#foreach($item in $list)序號[$foreach.count] $item <br> ## count從1開始 index從0開始
#end

準備模型數據

// 創建區域對象
Region region1 = new Region(1L, "北京北五環");
Region region2 = new Region(2L, "北京北四環");
velocityContext.put("region", region1);
List<Region> regionList = List.of(region1, region2);
velocityContext.put("regionList", regionList);

動態模板展示數據

## 遍歷區域
#foreach($item in $regionList)序號[$foreach.count],區域ID:$item.id,區域名稱:$item.regionName <br>
#end
</br>

基礎語法-if判斷

判斷的語法：#if(condition) ... #elseif(condition) ... #else ... #end

##定義變量
#set($score=80)## if判斷
#if($score>=80)優秀
#elseif($score>=60)及格
#else不及格
#end

## 對象obj不為空才會執行里面的邏輯
#if($obj) ..... #end## 對象obj為空才會執行里面的邏輯
#if(!$obj) ..... #end

模板閱讀

我們不需要使用velocity去開發新的模板，若依已經提供好了，在它基礎上進行調整即可

下面這個是關于實體類的模板

package ${packageName}.domain;## 根據列類型獲取導入包
#foreach ($import in $importList)
import ${import};
#end
## 導入Apache Commons Lang庫，用于對象的toString方法
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.apache.commons.lang3.builder.ToStringStyle;
## 導入項目自定義的Excel注解，用于生成Excel文檔
import com.dkd.common.annotation.Excel;
#if($table.crud || $table.sub)
## 如果表具有CRUD操作或子表，繼承BaseEntity
import com.dkd.common.core.domain.BaseEntity;
#elseif($table.tree)
## 如果表是樹形結構，繼承TreeEntity
import com.dkd.common.core.domain.TreeEntity;
#end/*** ${functionName}對象 ${tableName}** @author ${author}* @date ${datetime}*/
#if($table.crud || $table.sub)#set($Entity="BaseEntity")
#elseif($table.tree)#set($Entity="TreeEntity")
#end
public class ${ClassName} extends ${Entity}{   ## 定義類的序列化版本ID
private static final long serialVersionUID = 1L;
## 根據表的列定義實體類的屬性
#foreach ($column in $columns)## 如果不是父類的屬性，則生成屬性#if(!$table.isSuperColumn($column.javaField))/** $column.columnComment */## 如果字段需要在列表中展示，使用Excel注解標記#if($column.list)#set($parentheseIndex=$column.columnComment.indexOf("（"))#if($parentheseIndex != -1)#set($comment=$column.columnComment.substring(0, $parentheseIndex))#else#set($comment=$column.columnComment)#end#if($parentheseIndex != -1)@Excel(name = "${comment}", readConverterExp = "$column.readConverterExp()")#elseif($column.javaType == 'Date')@JsonFormat(pattern = "yyyy-MM-dd")@Excel(name = "${comment}", width = 30, dateFormat = "yyyy-MM-dd")#else@Excel(name = "${comment}")#end#endprivate $column.javaType $column.javaField;#end
#end
## 如果表有子表，定義子表信息的集合
#if($table.sub)
/** $table.subTable.functionName信息 */
private List<${subClassName}> ${subclassName}List;#end
## 為每個屬性字段生成getter和setter方法
#foreach ($column in $columns)#if(!$table.isSuperColumn($column.javaField))#if($column.javaField.length() > 2 && $column.javaField.substring(1,2).matches("[A-Z]"))#set($AttrName=$column.javaField)#else#set($AttrName=$column.javaField.substring(0,1).toUpperCase() + ${column.javaField.substring(1)})#endpublic void set${AttrName}($column.javaType $column.javaField){this.$column.javaField = $column.javaField;}public $column.javaType get${AttrName}(){return $column.javaField;}#end
#end
## 如果表有子表，生成子表信息的getter和setter方法
#if($table.sub)
public List<${subClassName}> get${subClassName}List(){return ${subclassName}List;}public void set${subClassName}List(List<${subClassName}> ${subclassName}List){this.${subclassName}List = ${subclassName}List;}#end
## 重寫toString方法，使用Apache Commons Lang的ToStringBuilder
@Override
public String toString() {return new ToStringBuilder(this,ToStringStyle.MULTI_LINE_STYLE)#foreach ($column in $columns)#if($column.javaField.length() > 2 && $column.javaField.substring(1,2).matches("[A-Z]"))#set($AttrName=$column.javaField)#else#set($AttrName=$column.javaField.substring(0,1).toUpperCase() + ${column.javaField.substring(1)})#end.append("${column.javaField}", get${AttrName}())#end#if($table.sub).append("${subclassName}List", get${subClassName}List())#end.toString();}}

Lombok集成

目前，我們已經基本熟悉了velocity的作用和一些語法，那接下來，我們就通過這些知識來去改造若依框架的代碼生成部分

在common模塊的pom.xml中添加lombok坐標

<!--  lombok工具-->
<dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId>
</dependency>

修改模板

在enerator模塊的domain.java.vm模板中添加lombok注解

package ${packageName}.domain;## 根據列類型獲取導入包
#foreach ($import in $importList)
import ${import};
#end
## 導入項目自定義的Excel注解，用于生成Excel文檔
import com.dkd.common.annotation.Excel;
#if($table.crud || $table.sub)
## 如果表具有CRUD操作或子表，繼承BaseEntity
import com.dkd.common.core.domain.BaseEntity;
#elseif($table.tree)
## 如果表是樹形結構，繼承TreeEntity
import com.dkd.common.core.domain.TreeEntity;
#end
## 注意lombok導包
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;/*** ${functionName}對象 ${tableName}** @author ${author}* @date ${datetime}*/
#if($table.crud || $table.sub)
#set($Entity="BaseEntity")
#elseif($table.tree)
#set($Entity="TreeEntity")
#end
@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class ${ClassName} extends ${Entity}{   ## 定義類的序列化版本ID
private static final long serialVersionUID=1L;
## 根據表的列定義實體類的屬性
#foreach ($column in $columns)## 如果不是父類的屬性，則生成屬性#if(!$table.isSuperColumn($column.javaField))/** $column.columnComment */## 如果字段需要在列表中展示，使用Excel注解標記#if($column.list)#set($parentheseIndex=$column.columnComment.indexOf("（"))#if($parentheseIndex != -1)#set($comment=$column.columnComment.substring(0, $parentheseIndex))#else#set($comment=$column.columnComment)#end#if($parentheseIndex != -1)@Excel(name = "${comment}", readConverterExp = "$column.readConverterExp()")#elseif($column.javaType == 'Date')@JsonFormat(pattern = "yyyy-MM-dd")@Excel(name = "${comment}", width = 30, dateFormat = "yyyy-MM-dd")#else@Excel(name = "${comment}")#end#endprivate $column.javaType $column.javaField;#end
#end
## 如果表有子表，定義子表信息的集合
#if($table.sub)
/** $table.subTable.functionName信息 */
private List<${subClassName}> ${subclassName}List;#end
}

正常添加了關于lombok的注解

刪除了set 、 get 、toString 等方法

可以把生成后的代碼，拷貝到項目中，如果訂單管理能夠正常訪問和操作，就算修改成功了，后期再次生成的代碼，全部都支持lombok

Swagger集成

在generator模塊的 controller.java.vm模板中添加Swagger注解

package ${packageName}.controller;import java.util.List;
import javax.servlet.http.HttpServletResponse;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import com.dkd.common.annotation.Log;
import com.dkd.common.core.controller.BaseController;
import com.dkd.common.core.domain.AjaxResult;
import com.dkd.common.enums.BusinessType;
import ${packageName}.domain.${ClassName};
import ${packageName}.service.I${ClassName}Service;
import com.dkd.common.utils.poi.ExcelUtil;
#if($table.crud || $table.sub)
import com.dkd.common.core.page.TableDataInfo;
#elseif($table.tree)
#end
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;/*** ${functionName}Controller** @author ${author}* @date ${datetime}*/
@Api(tags = "${functionName}Controller")
@RestController
@RequestMapping("/${moduleName}/${businessName}")
public class ${ClassName}Controller extends BaseController
{@Autowiredprivate I${ClassName}Service ${className}Service;/*** 查詢${functionName}列表*/@ApiOperation("查詢${functionName}列表")@PreAuthorize("@ss.hasPermi('${permissionPrefix}:list')")@GetMapping("/list")
#if($table.crud || $table.sub)public TableDataInfo list(${ClassName} ${className}){startPage();List<${ClassName}> list = ${className}Service.select${ClassName}List(${className});return getDataTable(list);}
#elseif($table.tree)public AjaxResult list(${ClassName} ${className}){List<${ClassName}> list = ${className}Service.select${ClassName}List(${className});return success(list);}
#end/*** 導出${functionName}列表*/@ApiOperation("導出${functionName}列表")@PreAuthorize("@ss.hasPermi('${permissionPrefix}:export')")@Log(title = "${functionName}", businessType = BusinessType.EXPORT)@PostMapping("/export")public void export(HttpServletResponse response, ${ClassName} ${className}){List<${ClassName}> list = ${className}Service.select${ClassName}List(${className});ExcelUtil<${ClassName}> util = new ExcelUtil<${ClassName}>(${ClassName}.class);util.exportExcel(response, list, "${functionName}數據");}/*** 獲取${functionName}詳細信息*/@ApiOperation("獲取${functionName}詳細信息")@PreAuthorize("@ss.hasPermi('${permissionPrefix}:query')")@GetMapping(value = "/{${pkColumn.javaField}}")public AjaxResult getInfo(@PathVariable("${pkColumn.javaField}") ${pkColumn.javaType} ${pkColumn.javaField}){return success(${className}Service.select${ClassName}By${pkColumn.capJavaField}(${pkColumn.javaField}));}/*** 新增${functionName}*/@ApiOperation("新增${functionName}")@PreAuthorize("@ss.hasPermi('${permissionPrefix}:add')")@Log(title = "${functionName}", businessType = BusinessType.INSERT)@PostMappingpublic AjaxResult add(@RequestBody ${ClassName} ${className}){return toAjax(${className}Service.insert${ClassName}(${className}));}/*** 修改${functionName}*/@ApiOperation("修改${functionName}")@PreAuthorize("@ss.hasPermi('${permissionPrefix}:edit')")@Log(title = "${functionName}", businessType = BusinessType.UPDATE)@PutMappingpublic AjaxResult edit(@RequestBody ${ClassName} ${className}){return toAjax(${className}Service.update${ClassName}(${className}));}/*** 刪除${functionName}*/@ApiOperation("刪除${functionName}")@PreAuthorize("@ss.hasPermi('${permissionPrefix}:remove')")@Log(title = "${functionName}", businessType = BusinessType.DELETE)@DeleteMapping("/{${pkColumn.javaField}s}")public AjaxResult remove(@PathVariable ${pkColumn.javaType}[] ${pkColumn.javaField}s){return toAjax(${className}Service.delete${ClassName}By${pkColumn.capJavaField}s(${pkColumn.javaField}s));}
}