非框架类总纲
https://www.jianshu.com/p/d0167f082cbf
友情链接：Velocity-后传
https://www.jianshu.com/p/056525422f2e
前言
说到Java 开发中模板引擎，常见有三：Thymeleaf 、Velocity、Freemarker
当然市面上有很多文章关于三者的区别，个人认为
Thymeleaf ：Springboot 官方支持，全栈 html 非常方便，若是前后端分离 vue 就完全不适用
Freemarker：很多老项目用看过大量使用，不支持多级编译(这是硬伤,同时也是有效的保护了代码），现在很多开源框架主流用它做代码生成器模板（elAdmin就是一款）
Velocity：类似的jsp语法，能多级编译，但文件名必须为vm，现在很多开源框架主流用它做代码生成器模板（人人fast就 是一款）
文章参考三者区别：
https://blog.csdn.net/mrleeapple/article/details/89883807
https://blog.csdn.net/qq_41720208/article/details/80891393
https://www.cnblogs.com/ywb-articles/p/10627398.html
1、velocity 简介
1、velocity 介绍
Velocity是一个基于Java的模板引擎，可以通过特定的语法获取在java对象的数据 , 填充到模板中，从而实现界面和java代码的分离 !
image.png
2、为什么学习velocity（应用场景）
- Web应用程序 : 作为为应用程序的视图, 展示数据。
- 源代码生成 : Velocity可用于基于模板生成Java源代码
- 自动电子邮件 : 网站注册 , 认证等的电子邮件模板
- 网页静态化 : 基于velocity模板 , 生成静态网页
3、velocity 组成原理
image.png
Velocity主要分为app、context、runtime和一些辅助util几个部分。
- app模块 : 主要封装了一些接口 , 暴露给使用者使用。主要有两个类，分别是Velocity(单例)和VelocityEngine。
- Context模块 : 主要封装了模板渲染需要的变量
- Runtime模块 : 整个Velocity的核心模块，Runtime模块会将加载的模板解析成语法树，Velocity调用mergeTemplate方法时会渲染整棵树，并输出最终的渲染结果。
- RuntimeInstance类为整个Velocity渲染提供了一个单例模式，拿到了这个实例就可以完成渲染过程了。
2、velocity引擎快速入门
1、创建工程、引入坐标、插件配置
image.png
org.apache.velocity
velocity-engine-core
2.2
junit
junit
4.12
test
org.apache.maven.plugins
maven-compiler-plugin
3.8.1
1.8
1.8
utf-8
2、编写模板
在项目resources目录下创建模板文件
image.png
Title
hello , ${name} !
3、加载模板、合并输出结果
@Test
public void test1() throws IOException {
//设置velocity资源加载器
Properties prop = new Properties ( );
prop.put ("file.resource.loader.class", "org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader");
Velocity.init (prop);
//创建Velocity容器
VelocityContext context = new VelocityContext ( );
context.put ("name", "阿K");
//加载模板
Template tpl = Velocity.getTemplate ("vms/01-quickstark.vm", "UTF-8");
FileWriter fw = new FileWriter ("D:\\work\\demo1.html");
//合并数据到模板
tpl.merge (context, fw);
//释放资源
fw.close ( );
}
4、运行原理分析
- Velocity解决了如何在后台程序和网页之间传递数据的问题，后台代码和视图之间相互独立，一方的修改不影响另一方 .
- 他们之间是通过环境变量（Context）来实现的，网页制作一方和后台程序一方相互约定好对所传递变量的命名约定，比如上个程序例子中的site, name变量，它们在网页上就是$name ,$site 。
-
只要双方约定好了变量名字，那么双方就可以独立工作了。无论页面如何变化，只要变量名不变，那么后台程序就无需改动，前台网页也可以任意由网页制作人员修改。这就是Velocity的工作原理。
image.png
3、vtl 模板语法
1、vtl介绍
Velocity Template Language (VTL) , 是Velocity 中提供的一种模版语言 , 旨在提供最简单和最干净的方法来将动态内容合并到网页中。简单来说VTL可以将程序中的动态数展示到网页中
VTL的语句分为4大类：注释 , 非解析内容 ** , 引用和指令**。
2、注释
2-1. 行注释
## 行注释内容
2-2. 块注释
#*
块注释内容1
块注释内容2
*#
2-3. 文档注释
#**
文档注释内容1
文档注释内容2
*#
2-4. 案例
Title
## 我是行注释
#*
* 我是块注释
* 呵呵呵
* *#
#**
* 我是文档注释
*
* *#
hello , ${name} !
3、非解析内容
所谓非解析内容也就是不会被引擎解析的内容。
3-1. 语法
#[[
非解析内容1
非解析内容2
]]#
3-2. 示例
Title
hello , ${name} !
非解析内容
#[[
直接输出的内容1
直接输出的内容2
${name}
]]#
4、变量语法
引用语句就是对引擎上下文对象中的属性进行操作。语法方面分为常规语法(`$属性`)和正规语法(${属性})。
4-1. 语法
$变量名, 若上下文中没有对应的变量，则输出字符串"$变量名"
${变量名},若上下文中没有对应的变量，则输出字符串"${变量名}"
$!变量名, 若上下文中没有对应的变量，则输出空字符串""
$!{变量名}, 若上下文中没有对应的变量，则输出空字符串""
4-2. 示例
Title
引用变量
常规语法 : $name
正规语法 : ${name}
## 如果获取的变量不存在, 表达式会原样展示 , 如果不想展示 , 可以使用 $!变量名
## 以下写法的含义代表么如果有变量, 那么获取变量值展示, 没有变量展示""
常规语法 : $!name
正规语法 : $!{name}
5、属性语法
5-1. 语法
$变量名.属性, 若上下文中没有对应的变量，则输出字符串"$变量名.属性"
${变量名.属性} 若上下文中没有对应的变量，则输出字符串"${变量名.属性}"
$!变量名.属性 若上下文中没有对应的变量，则输出字符串""
$!{变量名.属性} 若上下文中没有对应的变量，则输出字符串""
5-2. 示例
Title
引用属性
常规语法 : $user.username --- $user.password
正规语法 : ${user.username} --- ${user.password}
正规语法 : ${user.email} --- ${user.email}
正规语法 : $!{user.email} --- $!{user.email}
6、方法语法
方法引用实际就是指方法调用操作，关注点返回值和参数 , 方法的返回值将输出到最终结果中
6-1. 语法
$变量名.方法([入参1[, 入参2]*]?), 常规写法
${变量名.方法([入参1[, 入参2]*]?)}, 正规写法
$!变量名.方法([入参1[, 入参2]*]?), 常规写法
$!{变量名.方法([入参1[, 入参2]*]?)}, 正规写法
6-2. 示例
Title
引用属性
$str.split(" ")
${str.split(" ")}
$time.getTime()
${time.getTime()}
7、常用指令
流程控制
#set
#if/#elseif/#else
#foreach
#break
#stop
引入外部的模板
#parse
#include
#evaluate
#define
宏指令
7.1 #set
7-1-0. 作用：在页面中声明定义变量
7-1-1. 语法： #set($变量 = 值)
7-1-2. 示例
Title
set指令
#set($str = "hello world")
#set($int = 1)
#set($arr = [1,2])
#set($boolean = true)
#set($map = {"key1":"value1", "key2":"value2"})
## 在字符串中也可以引用之前定义过的变量
#set($str2 = "$str , how are you !")
#set($str3 = '$str , how are you !')
获取set指令定义的变量
${str}
${int}
${arr}
${boolean}
${map.key1}--${map.key2}
${str2}
${str3}
7.2 #if/#elseif/#else
7-2-0. 作用：进行逻辑判断
7-2-1. 语法：
#if(判断条件)
.........
#elseif(判断条件)
.........
#else
.........
#end
7-2-2. 示例
Title
if/elseif/else指令
#set($language="PHP")
#if($language.equals("JAVA"))
java开发工程师
#elseif($language.equals("PHP"))
php开发工程师
#else
开发工程师
#end
7.3 #foreach
7-3-0. 作用：遍历循环数组或者集合
7-3-1. 语法：
#foreach($item in $items)
..........
[#break]
#end
- $items : 需要遍历的对象或者集合
- 如果items的类型为map集合, 那么遍历的是map的value
- $item : 变量名称, 代表遍历的每一项
- #break : 退出循环
- 内置属性 :
- $foreach.index : 获取遍历的索引 , 从0开始
- $foreach.count : 获取遍历的次数 , 从1开始
7-3-2. 示例
Title
遍历数组
#foreach($str in $hobbies)
${foreach.index} -- ${str}
#end
变量对象集合
编号
用户名
密码
邮箱
年龄
操作
#foreach($user in $users)
${foreach.index}
${user.username}
${user.password}
${user.email}
${user.age}
编辑
删除
#end
遍历map集合
遍历值
#foreach($value in $map)
$value
#end
遍历键值对
#foreach($entry in $map.entrySet())
$entry.key -- $entry.value
#end
7.4 #include
7-4-0. 作用：引入外部资源 , 引入的资源不会被引擎所解析
7-4-1. 语法：#include(resource)
- resource可以为单引号或双引号的字符串，也可以为$变量，内容为外部资源路径。
-
注意 : 路径如果为相对路径，则以引擎配置的文件加载器加载路径作为参考（也就是 resource 的路径）
image.png
7-4-2. 示例
Title
#include("vms/01-quickstark.vm")
7.5 #parse
7-5-0. 作用：引入外部资源 , 引入的资源将被引擎所解析
7-5-1. 语法：#parse(resource)
- resource可以为单引号或双引号的字符串，也可以为$变量，内容为外部资源路径。
- 注意 : 路径如果为相对路径，则以引擎配置的文件加载器加载路径作为参考系
7-5-2. 示例
Title
#parse("vms/01-quickstark.vm")
7.6 #define
7-6-0. 作用：定义重用模块（不带参数）
7-6-1. 语法：
#define($模块名称)
模块内容
#end
7-6-2. 示例
Title
定义模块
#define($table)
编号
用户名
密码
年龄
操作
0
zhangsan
123456
18
编辑
删除
1
lisi
123456
18
编辑
删除
2
wangwu
123456
18
编辑
删除
#end
使用模块
$table
$table
$table
7.7 #evaluate
7-7-0. 作用：动态计算 , 动态计算可以让我们在字符串中使用变量
7-7-1. 语法：#evalute("计算语句")
7-7-2. 示例
后端：这样直接传过去的 $code，会被直接当做字符串解析，需要使用 #evaluate才不会被直接输出
//创建Velocity容器
VelocityContext context = new VelocityContext ( );
context.put ("code", "#if($language.equals(\"JAVA\"))\n" +
" java开发工程师\n" +
"#elseif($language.equals(\"PHP\"))\n" +
" php开发工程师\n" +
"#else\n" +
" 开发工程师\n" +
"#end");
vms：
Title
动态计算
#set($language= "java")
#evaluate($code)
7.8 宏指令
7-8-0. 作用：定义重用模块（可带参数）
7-8-1. 语法
7.8-1-1、定义语法：
#macro(宏名 [$arg]?)
.....
#end
7.8-1-1、调用语法：
#宏名([$arg]?)
7-8-2. 示例
Title
定义宏
#macro(table $list)
编号
用户名
密码
邮箱
年龄
操作
#foreach($item in $list)
${foreach.count}
${item.username}
${item.password}
${item.email}
${item.age}
编辑
删除
#end
#end
调用宏
#table($users)
4、.综合案例
1、代码生成介绍
在实际项目开发过程中, 编写基础的CRUD操作代码, 往往会花费我们大量的时间 , 而且这些CRUD代码的基础结构基本上是固定的 , 如果能有一个代码生成器 , 能够帮助我们把这些代码生成出来 , 我们就可以节省出大量的时间关注核心业务代码的开发, 大大提高了我们的开发效率 !
需求 : 使用velocity实现一个简单的代码生成器 , 生成项目开发过程中的基础CRUD代码
2、代码生成流程分析
- 创建项目
- 导入依赖
- 编写模板
- 生成代码
3、编写模板
一般我们的项目开发将项目分为三层 , 我们的代码生成器就基于传统的三层架构生成代码 , 所以我们需要为每一层的每一个类创建模板 , 所以需要有如下模板 :
- Controller.java.vm : 控制层模板
- Service.java.vm : 业务层接口模板
- ServiceImpl.java.vm : 业务层实现模板
- Dao.java.vm : 数据服务层模板(数据访问层基于通用Mpper实现)
Controller.java.vm：
package ${package}.controller;
import ${package}.pojo.${className};
import ${package}.service.${className}Service;
import ${package}.utils.Result;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
import java.util.Map;
@RestController
@RequestMapping("/${classname}")
public class ${className}Controller {
@Autowired
private ${className}Service ${classname}Service ;
/**
* 查询列表
* @return
*/
@RequestMapping("/list")
public Result list(){
List<${className}> ${classname}s = null;
try {
${classname}s = ${classname}Service.list();
return Result.ok(${classname}s);
} catch (Exception e) {
e.printStackTrace();
return Result.error("查询数据异常");
}
}
/**
* 保存
* @param ${classname}
* @return
*/
@RequestMapping("/save")
public Result save(@RequestBody ${className} ${classname}){
try {
${classname}Service.save(${classname});
return Result.ok("新增数据成功");
} catch (Exception e) {
e.printStackTrace();
return Result.error("新增数据异常");
}
}
/**
* 更新
* @param ${classname}
* @return
*/
@RequestMapping("/update")
public Result update(@RequestBody ${className} ${classname}){
try {
${classname}Service.update(${classname});
return Result.ok("修改数据成功");
} catch (Exception e) {
e.printStackTrace();
return Result.error("修改数据异常");
}
}
/**
* 删除
* @param ids
* @return
*/
@RequestMapping("/delete")
public Result delete(@RequestBody Integer[] ids){
try {
${classname}Service.delete(ids);
return Result.ok("删除数据成功");
} catch (Exception e) {
e.printStackTrace();
return Result.error("删除数据异常");
}
}
}
Service.java.vm
package ${package}.service;
import com.kk.pojo.${className};
import java.util.List;
import java.util.Map;
public interface ${className}Service {
/**
* 查询数据列表
* @return
*/
List<${className}> list();
/**
* 保存数据
* @param ${classname}
*/
void save(${className} ${classname});
/**
* 更新数据
* @param ${classname}
*/
void update(${className} ${classname});
/**
* 删除数据
* @param ids
*/
void delete(Integer[] ids);
}
ServiceImpl.java.vm
package ${package}.service.impl;
import ${package}.dao.${className}Dao;
import ${package}.pojo.${className};
import ${package}.service.${className}Service;
import org.springframework.beans.factory.annotation.Autowired;
import java.util.Arrays;
import java.util.List;
import java.util.stream.Stream;
public class ${className}ServiceImpl implements ${className}Service {
@Autowired
private ${className}Dao ${classname}Dao ;
public List<${className}> list() {
return ${classname}Dao.selectAll();
}
public void save(${className} ${classname}) {
${classname}Dao.insert(${classname});
}
public void update(${className} ${classname}) {
${classname}Dao.updateByPrimaryKey(${classname});
}
public void delete(Integer[] ids) {
Stream.of(ids).forEach(${classname}Dao::deleteByPrimaryKey);
}
}
Dao.java.vm
package ${package}.dao;
import com.kk.pojo.${className};
import tk.mybatis.mapper.common.Mapper;
public interface ${className}Dao extends Mapper<${className}> {
}
4、实现代码生成逻辑
package com.kk.utils;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.velocity.Template;
import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.Velocity;
import java.io.File;
import java.io.IOException;
import java.io.StringWriter;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.zip.ZipEntry;
import java.util.zip.ZipOutputStream;
/**
* 代码生成器 工具类
*/
public class GenUtils {
private static String currentTableName;
public static List getTemplates() {
List templates = new ArrayList();
templates.add("vms/Controller.java.vm");
templates.add("vms/Service.java.vm");
templates.add("vms/ServiceImpl.java.vm");
templates.add("vms/Dao.java.vm");
return templates;
}
/**
* 生成代码
*/
public static void generatorCode(Map data, List templates, ZipOutputStream zip) {
//设置velocity资源加载器
Properties prop = new Properties();
prop.put("file.resource.loader.class", "org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader");
Velocity.init(prop);
//封装模板数据
VelocityContext context = new VelocityContext(data);
//获取模板列表
for (String template : templates) {
//渲染模板
StringWriter sw = new StringWriter();
Template tpl = Velocity.getTemplate(template, "UTF-8");
tpl.merge(context, sw);
try {
//添加到zip
zip.putNextEntry(new ZipEntry(getFileName(template, data.get("className").toString(), data.get("package").toString())));
IOUtils.write(sw.toString(), zip, "UTF-8");
IOUtils.closeQuietly(sw);
} catch (IOException e) {
e.printStackTrace();
}
}
}
/**
* 获取文件名 , 每个文件所在包都不一样, 在磁盘上的文件名几路径也各不相同
*/
public static String getFileName(String template, String className,String packageName) {
String packagePath = "main" + File.separator + "java" + File.separator;
if (StringUtils.isNotBlank(packageName)) {
packagePath += packageName.replace(".", File.separator) + File.separator;
}
if (template.contains("Dao.java.vm")) {
return packagePath + "dao" + File.separator + className + "Dao.java";
}
if (template.contains("Service.java.vm")) {
return packagePath + "service" + File.separator + className + "Service.java";
}
if (template.contains("ServiceImpl.java.vm")) {
return packagePath + "service" + File.separator + "impl" + File.separator + className + "ServiceImpl.java";
}
if (template.contains("Controller.java.vm")) {
return packagePath + "controller" + File.separator + className + "Controller.java";
}
return null;
}
}
运行测试
public class GeneratorCodeTest {
public static void main(String[] args) throws IOException {
Map data = new HashMap();
data.put("className","Product");
data.put("classname","product");
data.put("package","com.itheima");
File file = new File("D:\\Users\\Desktop\\code.zip");
FileOutputStream outputStream = new FileOutputStream(file);
ZipOutputStream zip = new ZipOutputStream(outputStream);
GenUtils.generatorCode(data,GenUtils.getTemplates(),zip);
zip.close();
}
}