Java 如何使用Velocity引擎生成代码
作者：虚怀若谷 发布时间：2023-10-19 23:15:34
标签：Java,Velocity,代码生成
目录
原理
实战
原理
其原理如图：
1.配置数据源信息（包括表名）
2.读取数据表字段信息：列名、类型、字段注释、表注释
3.编写代码模板，并将该模板加载到内存
4.根据模板所需，组装Velocity引擎渲染所需字段Map
5.创建Velocity上下文，将代码模板和替换字段传入
6.velocity上下文创建引擎，执行merge合并替换并将最终代码写入文件
实战
1.通过maven构建项目，引入依赖：
<dependency>
<artifactId>velocity</artifactId>
<groupId>org.apache.velocity</groupId>
<exclusions>
<exclusion>
<artifactId>commons-collections</artifactId>
<groupId>commons-collections</groupId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
</dependency>
2.在resources/templates/codegenerator目录下面编写代码模板：
VO:
package ${basePackage}.module.${modulePackage}.domain.vo;
import lombok.Data;
#foreach ($dtoImport in $dtoImports)
$dtoImport
#end
import com.fasterxml.jackson.annotation.JsonFormat;
import io.swagger.annotations.ApiModelProperty;
/**
* [ ${tableDesc} ]
*
* @author ${author}
* @version 1.0
* @company ${company}
* @copyright (c) ${company}Inc. All rights reserved.
* @date ${date}
* @since JDK1.8
*/
@Data
public class ${moduleClass}VO {
#foreach ($column in $columnList)
#if($column.fieldType == 'Date')
@ApiModelProperty("${column.columnDesc}")
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
private $column.fieldType $column.fieldName;
#else
@ApiModelProperty("${column.columnDesc}")
private $column.fieldType $column.fieldName;
#end
#end
}
SERVICE:
package ${basePackage}.module.${modulePackage}.service;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import ${basePackage}.common.domain.PageResultDTO;
import ${basePackage}.common.domain.ResponseDTO;
import ${basePackage}.module.${modulePackage}.dao.${moduleClass}Dao;
import ${basePackage}.module.${modulePackage}.domain.dto.${moduleClass}AddDTO;
import ${basePackage}.module.${modulePackage}.domain.dto.${moduleClass}UpdateDTO;
import ${basePackage}.module.${modulePackage}.domain.dto.${moduleClass}QueryDTO;
import ${basePackage}.module.${modulePackage}.domain.entity.${moduleClass}Entity;
import ${basePackage}.module.${modulePackage}.domain.vo.${moduleClass}VO;
import ${basePackage}.module.${modulePackage}.domain.vo.${moduleClass}ExcelVO;
import ${basePackage}.util.SmartPageUtil;
import ${basePackage}.util.SmartBeanUtil;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
import java.util.List;
/**
* [ ${tableDesc} ]
*
* @author ${author}
* @version 1.0
* @company ${company}
* @copyright (c) ${company}Inc. All rights reserved.
* @date ${date}
* @since JDK1.8
*/
@Service
public class ${moduleClass}Service {
@Autowired
private ${moduleClass}Dao ${moduleVar}Dao;
/**
* 根据id查询
*/
public ${moduleClass}Entity getById(Long id){
return ${moduleVar}Dao.selectById(id);
}
/**
* 分页查询
* @author ${author}
* @date ${date}
*/
public ResponseDTO<PageResultDTO<${moduleClass}VO>> queryByPage(${moduleClass}QueryDTO queryDTO) {
Page page = SmartPageUtil.convert2QueryPage(queryDTO);
IPage<${moduleClass}VO> voList = ${moduleVar}Dao.queryByPage(page, queryDTO);
PageResultDTO<${moduleClass}VO> pageResultDTO = SmartPageUtil.convert2PageResult(voList);
return ResponseDTO.succData(pageResultDTO);
}
/**
* 添加
* @author ${author}
* @date ${date}
*/
public ResponseDTO<String> add(${moduleClass}AddDTO addDTO) {
${moduleClass}Entity entity = SmartBeanUtil.copy(addDTO, ${moduleClass}Entity.class);
${moduleVar}Dao.insert(entity);
return ResponseDTO.succ();
}
/**
* 编辑
* @author ${author}
* @date ${date}
*/
@Transactional(rollbackFor = Exception.class)
public ResponseDTO<String> update(${moduleClass}UpdateDTO updateDTO) {
${moduleClass}Entity entity = SmartBeanUtil.copy(updateDTO, ${moduleClass}Entity.class);
${moduleVar}Dao.updateById(entity);
return ResponseDTO.succ();
}
/**
* 删除
* @author ${author}
* @date ${date}
*/
@Transactional(rollbackFor = Exception.class)
public ResponseDTO<String> deleteByIds(List<Long> idList) {
${moduleVar}Dao.deleteByIdList(idList);
return ResponseDTO.succ();
}
/**
* 查询全部导出对象
* @author ${author}
* @date ${date}
*/
public List<${moduleClass}ExcelVO> queryAllExportData(${moduleClass}QueryDTO queryDTO) {
return ${moduleVar}Dao.queryAllExportData( queryDTO);
}
/**
* 批量查询导出对象
* @author ${author}
* @date ${date}
*/
public List<${moduleClass}ExcelVO> queryBatchExportData(List<Long> idList) {
return ${moduleVar}Dao.queryBatchExportData(idList);
}
}
Mapper:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="${basePackage}.module.${modulePackage}.dao.${moduleClass}Dao">
<resultMap id="${moduleClass}VO" type="${basePackage}.module.${modulePackage}.domain.vo.${moduleClass}VO"></resultMap>
<resultMap id="${moduleClass}ExcelVO" type="${basePackage}.module.${modulePackage}.domain.vo.${moduleClass}ExcelVO"></resultMap>
<select id="queryByPage" resultMap="${moduleClass}VO">
select
#foreach($column in $columnList)
#if($velocityCount != $columnList.size())
$column.columnName,
#else
$column.columnName
#end
#end
from ${tableName}
<where>
#foreach($queryField in $queryFieldList)
#if ($queryField.sqlOperate == 'like')
<if test="queryDTO.${queryField.fieldName} != null and queryDTO.${queryField.fieldName} != ''">
AND INSTR($queryField.columnName,#{queryDTO.$queryField.fieldName})
</if>
#end
#if ($queryField.sqlOperate == 'equals')
#if ($queryField.fieldType == 'String')
<if test="queryDTO.${queryField.fieldName} != null and queryDTO.${queryField.fieldName} != ''">
AND $queryField.columnName = #{queryDTO.$queryField.fieldName}
</if>
#else
<if test="queryDTO.${queryField.fieldName} != null">
AND $queryField.columnName = #{queryDTO.$queryField.fieldName}
</if>
#end
#end
#if ($queryField.sqlOperate == 'in')
<if test="queryDTO.${queryField.fieldName}List !=null and queryDTO.${queryField.fieldName}List.size() > 0">
and $queryField.columnName in
<foreach collection="queryDTO.${queryField.fieldName}List" open="(" index="index" separator="," close=")" item="item">
#{item}
</foreach>
</if>
#end
#end
<if test="queryDTO.createTimeBegin != null ">
AND create_time >= #{queryDTO.createTimeBegin}
</if>
<if test="queryDTO.createTimeEnd != null ">
AND create_time <= #{queryDTO.createTimeEnd}
</if>
<if test="queryDTO.updateTimeBegin != null ">
AND update_time >= #{queryDTO.updateTimeBegin}
</if>
<if test="queryDTO.updateTimeEnd != null ">
AND update_time <= #{queryDTO.updateTimeEnd}
</if>
</where>
</select>
<select id="queryAllExportData" resultMap="${moduleClass}ExcelVO">
select
#foreach($column in $columnList)
#if($velocityCount != $columnList.size())
$column.columnName,
#else
$column.columnName
#end
#end
from ${tableName}
<where>
#foreach($queryField in $queryFieldList)
#if ($queryField.sqlOperate == 'like')
<if test="queryDTO.${queryField.fieldName} != null and queryDTO.${queryField.fieldName} != ''">
AND INSTR($queryField.columnName,#{queryDTO.$queryField.fieldName})
</if>
#end
#if ($queryField.sqlOperate == 'equals')
#if ($queryField.fieldType == 'String')
<if test="queryDTO.${queryField.fieldName} != null and queryDTO.${queryField.fieldName} != ''">
AND $queryField.columnName = #{queryDTO.$queryField.fieldName}
</if>
#else
<if test="queryDTO.${queryField.fieldName} != null">
AND $queryField.columnName = #{queryDTO.$queryField.fieldName}
</if>
#end
#end
#if ($queryField.sqlOperate == 'in')
<if test="queryDTO.${queryField.fieldName}List !=null and queryDTO.${queryField.fieldName}List.size() > 0">
and $queryField.columnName in
<foreach collection="queryDTO.${queryField.fieldName}List" open="(" index="index" separator="," close=")" item="item">
#{item}
</foreach>
</if>
#end
#end
<if test="queryDTO.createTimeBegin != null ">
AND create_time >= #{queryDTO.createTimeBegin}
</if>
<if test="queryDTO.createTimeEnd != null ">
AND create_time <= #{queryDTO.createTimeEnd}
</if>
<if test="queryDTO.updateTimeBegin != null ">
AND update_time >= #{queryDTO.updateTimeBegin}
</if>
<if test="queryDTO.updateTimeEnd != null ">
AND update_time <= #{queryDTO.updateTimeEnd}
</if>
</where>
</select>
<select id="queryBatchExportData" resultMap="${moduleClass}ExcelVO">
select
#foreach($column in $columnList)
#if($velocityCount != $columnList.size())
$column.columnName,
#else
$column.columnName
#end
#end
from ${tableName}
where id in
<foreach collection="idList" open="(" close=")" separator="," item="item">
#{item}
</foreach>
</select>
<delete id="deleteById">
delete from ${tableName} where id = #{id}
</delete>
<delete id="deleteByIdList">
delete from ${tableName} where id in
<foreach collection="idList" open="(" close=")" separator="," item="item">
#{item}
</foreach>
</delete>
</mapper>
3.查询表信息：
<select id="selectTableDesc" resultType="String">
select
table_comment
from information_schema.tables
where table_schema = (select database()) and table_name = #{tableName}
</select>
<select id="selectTableColumn" resultMap="ColumnDTO">
select
column_name as columnName,
data_type as columnType,
column_comment as columnDesc
from information_schema.columns
where table_schema = (select database()) AND table_name = #{tableName} order by ordinal_position
</select>
4.加载模板、组装数据
public Map<String, String> codeTemplates(String moduleClass, String basePackage, String modulePackage) {
String basePath = basePackage.replaceAll("\\.", File.separator );
String modulePath = modulePackage.replaceAll("\\.", File.separator );
String javaPackagePath = "java" + File.separator + basePath + File.separator + modulePath + File.separator;
String xmlPackagePath = "mapper" + File.separator + modulePath + File.separator;
String frontPackagePath = "web" + File.separator;
Map<String, String> templateMap = new HashMap<>();
//后端
templateMap.put("templates/codegenerator/java/Controller.java.vm", javaPackagePath + "controller" + File.separator + moduleClass + "Controller.java" );
templateMap.put("templates/codegenerator/java/Dao.java.vm", javaPackagePath + "dao" + File.separator + moduleClass + "Dao.java" );
templateMap.put("templates/codegenerator/java/Dao.xml.vm", xmlPackagePath + moduleClass + "Mapper.xml" );
templateMap.put("templates/codegenerator/java/AddDTO.java.vm", javaPackagePath + "domain" + File.separator + "dto" + File.separator + moduleClass + "AddDTO.java" );
templateMap.put("templates/codegenerator/java/UpdateDTO.java.vm", javaPackagePath + "domain" + File.separator + "dto" + File.separator + moduleClass + "UpdateDTO.java" );
templateMap.put("templates/codegenerator/java/Entity.java.vm", javaPackagePath + "domain" + File.separator + "entity" + File.separator + moduleClass + "Entity.java" );
templateMap.put("templates/codegenerator/java/VO.java.vm", javaPackagePath + "domain" + File.separator + "vo" + File.separator + moduleClass + "VO.java" );
templateMap.put("templates/codegenerator/java/ExcelVO.java.vm", javaPackagePath + "domain" + File.separator + "vo" + File.separator + moduleClass + "ExcelVO.java" );
templateMap.put("templates/codegenerator/java/QueryDTO.java.vm", javaPackagePath + "domain" + File.separator + "dto" + File.separator + moduleClass + "QueryDTO.java" );
templateMap.put("templates/codegenerator/java/Service.java.vm", javaPackagePath + "service" + File.separator + moduleClass + "Service.java" );
//前端
String webPackageName = CaseFormat.LOWER_CAMEL.to(CaseFormat.LOWER_UNDERSCORE, moduleClass).replaceAll("_", "-" );
templateMap.put("templates/codegenerator/web/Api.js.vm", frontPackagePath + "api" + File.separator + webPackageName + ".js" );
templateMap.put("templates/codegenerator/web/Router.js.vm", frontPackagePath + "router" + File.separator + webPackageName + ".js" );
templateMap.put("templates/codegenerator/web/List.vue.vm", frontPackagePath + webPackageName + File.separator + webPackageName + "-list.vue" );
templateMap.put("templates/codegenerator/web/ListForm.vue.vm", frontPackagePath + webPackageName + File.separator + "components" + File.separator + webPackageName + "-list-form.vue" );
return templateMap;
}
Properties p = new Properties();
p.put("file.resource.loader.class", "org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader");
p.put("directive.foreach.counter.name", "velocityCount");
p.put("directive.foreach.counter.initial.value", "1");
Velocity.init(p);
Map<String, Object> map = new HashMap<>();
map.put("company", codeGenerator.getCompany());
map.put("tableName", codeGenerator.getTableName());
map.put("basePackage", basePackage);
map.put("modulePackage", modulePackage);
map.put("moduleClass", moduleClass);
map.put("tableDesc", tableDesc);
map.put("author", author);
map.put("date", date);
map.put("moduleVar", moduleVar);
map.put("columnList", columnList);
map.put("queryFieldList", queryFieldList);
map.put("queryImports", queryImports);
map.put("dtoImports", dtoImports);
map.put("entityImports", entityImports);
map.put("webModuleName", CaseFormat.LOWER_CAMEL.to(CaseFormat.LOWER_UNDERSCORE, moduleClass).replaceAll("_", "-"));
map.put("upperCamel", CaseFormat.LOWER_CAMEL.to(CaseFormat.UPPER_CAMEL, moduleClass));
//前端的变量
map.put("ViewUIMessage", "$Message");
map.put("VueRefs", "$refs");
5.创建Velocity上下文，生成代码
VelocityContext context = new VelocityContext(map);
private void codeGenerator(VelocityContext context, Map<String, String> codeTemplates) throws Exception {
String projectPath = getOutputDir();
Velocity.setProperty("input.encoding", "UTF-8");
Velocity.setProperty("output.encoding", "UTF-8");
for (Entry<String, String> entry : codeTemplates.entrySet()) {
String template = entry.getKey();
String filePath = projectPath + entry.getValue();
String fileName = filePath.substring(filePath.lastIndexOf(File.separator) + 1);
String fileDir = filePath.replace(fileName, "");
File directory = new File(fileDir);
if (!directory.exists()) {
directory.mkdirs();
}
FileWriter writer;
try {
writer = new FileWriter(filePath);
Template tpl = Velocity.getTemplate(template, "UTF-8");
tpl.merge(context, writer);
writer.flush();
writer.close();
} catch (Exception e) {
log.error("", e);
}
}
}
来源：https://www.zhoujunwen.com/2021/via-velocity-engine-generate-code/
0
投稿猜你喜欢
- 很多方法请看官网地址：hutool官网地址脚本之家下载：https://www.jb51.net/softs/549331.html简介Hu
- 背景原生的TextView是支持跑马灯效果的，但是在项目中实际用了之后，达不到需求，原因是内容滚动太慢，速度无法调节。因此，需要自定义一个可
在学习C#语言的时候，首先要学习控制台的应用程序，这样才能专注于语言的学习，减少学习的梯度，也有利于输出自己需要输出的内容。因此第一步学习C- 菜单控制：可以用来判断这个用户是不是有这些角色，没有的话就不展示数据控制：由于数据都是从后端查的，在后端控制权限就可以了<!-- &n
- c# chart缩放,局部放大效果：左键划选放大区域，右键恢复 /// <sum
- 属性问题引入前面我们已经在父工程中的dependencyManagement标签中对项目中所使用的jar包版本进行了统一的管理，但是如果在标
- Spring @Async无法实现异步问题原因项目中存在2个配置文件：springMVC.xml和beanDefines.xml，它们都配置
- 1 需求Mybatis-plus使用@TableLogic注解进行逻辑删除数据后，在某些场景下，又需要查询该数据时，又不想写SQ
- 一、需要自定义登录结果的场景在我之前的文章中，做过登录验证流程的源码解析。其中比较重要的就是当我们登录成功的时候，是由Authenticat
- .Net的System.Net.Sockets.TcpClient和System.Net.Sockets.Socket都没有直接为Conne
- 引言对于Nacos大家应该都不太陌生，出身阿里名声在外，能做动态服务发现、配置管理，非常好用的一个工具。然而这样的技术用的人越多面试被问的概
- 一篇小白也能看懂的查找游戏物体的方式解析 – Unity 之 查找物体的几种方式。本文通过实际测试得出使用结论，大家进行简单记录，在使用时想
- Mybatis 逆向工程 逆向工程通常包括由数据库的表生成 Java 代码 和 通过 Java 代码生成数据库表。而Mybatis 逆向工
- android的快捷方式比较简单，就是发一个系统的广播，然后为快捷方式设置Intent---package com.xikang.andro
- 说明Flutter原生是没有支持数据库操作的，它使用SQLlit插件来使应用具有使用数据库的能力。其实就是Flutter通过插件来与原生系统
- 首先对图片进行UUID 防止图片被覆盖以及爬图UUID的生成规则：日期时间，MAC地址，HashCode,随机数(多种之一)开发上传接口,两
- android通过toast实现悬浮通知效果，如图：实现的功能： 自定义悬浮弹窗；点击其他地方该布局不受影响；可自定义显示时间；可
- 前言 因为自己在做的一个小软件里面需要用到从A-Z排序的ListView，所以自然而然的想到了微信的联系人，我想要的就是那样的效果。本来没
- 简介最近花了两天时间研究使用Flutter开发一个抖音国际版. 个人感觉使用Flutter开发app快得不要不要的额. 两天就基本可以开发个
- 方式1. 使用HashtableMap<String,Object> hashtable=new Hashtable
