前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >velocity定义_velocity模板

velocity定义_velocity模板

作者头像
全栈程序员站长
发布2022-11-02 17:54:34
1.1K0
发布2022-11-02 17:54:34
举报
文章被收录于专栏:全栈程序员必看

大家好,又见面了,我是你们的朋友全栈君。

文章目录

基本用法

导入依赖

代码语言:javascript
复制
<dependency>
  	<groupId>org.apache.velocity</groupId>
    <artifactId>velocity</artifactId>
    <version>1.7</version>
</dependency>

创建一个公共方法,它是通过类路径来获取模板的,接下来就可以开始测试了!

代码语言:javascript
复制
public class VelocityUtils { 

/** * 执行模板渲染 * @param inputPath 输入路径 * @param velocityContext 内容 */
public static String replace(String inputPath ,VelocityContext velocityContext){ 

if(!inputPath.startsWith("\\")){ 

inputPath="\\"+inputPath;
}
// 初始化模板引擎
VelocityEngine ve = new VelocityEngine();
ve.setProperty(Velocity.INPUT_ENCODING, "UTF-8");
ve.setProperty(Velocity.OUTPUT_ENCODING, "UTF-8");
ve.setProperty(RuntimeConstants.RESOURCE_LOADER, "classpath");
ve.setProperty("classpath.resource.loader.class", ClasspathResourceLoader.class.getName());
//TODO 绝对路径
// ve.setProperty(Velocity.FILE_RESOURCE_LOADER_PATH, System.getProperty("user.dir") + "\\config\\" );
ve.init();
// 获取模板文件
Template t = ve.getTemplate(inputPath);
StringWriter sw = new StringWriter();
t.merge(velocityContext,sw);
//测试查看
System.out.println(sw.toString());
return sw.toString();
}
}

测试类

代码语言:javascript
复制
public class Test { 

//获取模板
private VelocityContext get(){ 

VelocityContext context = new VelocityContext();
context.put("name","王尼玛");
Student stu = new Student();
stu.setAge(23);
stu.setName("王小二");
stu.setBirth(new Date());
context.put("stu",stu);
return context;
}
@Test
public void test1(){ 

VelocityContext context = get();
//放在resources目录下
VelocityUtils.replace("/test/test1.html.vm",context);
}
}

1.基本用法

1.1 注释

代码语言:javascript
复制
##注释
#**
* TODO 多行注释
*#

1.2 替换变量

代码语言:javascript
复制
## 基础
hello, ${name}  $name
## 若有数据则输出,无则输出空串
H$!{ 
name}H   无$!{ 
name2}无

这里要注意:尽量用标准的写法${},否则容易导致语法错误

这里要注意:
这里要注意:

1.3 不解析,原文输出

代码语言:javascript
复制
## 不解析
#[[------
非解析内容
${name}
-----]]#

输出结果

代码语言:javascript
复制
	非解析内容
${name}

1.4 调用对象方法

代码语言:javascript
复制
${stu.name}  ${stu.getStr()}
#set($name = "abc def")
$name.split(" ")[0]   --结果是abc

vtl 指令

set (String、int、Boolean、List、Map)

在这里插入图片描述
在这里插入图片描述

结果:

代码语言:javascript
复制
王尼玛 18
[1, 2, 3, 4, 5]  2
true
{ 
name=Mike, age=12, isBoy=true}  Mike

if 、else

这个简单理解

代码语言:javascript
复制
#if($prop.name!='username' && $prop.name!='password')
..
#elseif($prop.name=='id')
..
#else
..
#end

其中,if可以识别为true的内容为:非null(java的String空串,也是识别为true!)、Boolean=true

foreach

#break可以终止循环

代码语言:javascript
复制
#循环遍历List 
#foreach($prop in $struct.cppPropList)
$prop
#end

遍历map

在这里插入图片描述
在这里插入图片描述

循环内部$foreach的属性使用:

在这里插入图片描述
在这里插入图片描述

include 、 parse

基于类路径(在VelocityEngine 中设置读取的基本路径)

#include 包含,不会被velocity解析

#parse 会被velocity解析

代码语言:javascript
复制
#include("/template/utils/compare.vm")
#parse("/template/component/menu.vm")

define

用于定义某个公共模块,在调用之前我们可以提前定义好一些参数,然后通过模块名去调用

代码语言:javascript
复制
#set($name = "小白")
#define($common)
hello,$name,你好呀!
#end
#set($name = "王尼玛")
$common
#set($name = "张三")
$common
在这里插入图片描述
在这里插入图片描述

evaluate

可以后端保存velocity语句,传入解析:

比如我们在java中:

代码语言:javascript
复制
context.put("v","#set($name = \"王尼玛\")");

模板内容如下:

代码语言:javascript
复制
#evaluate($v)
$name

解析结果:王尼玛

macro

代码语言:javascript
复制
#macro(method $name $age)
hello!  $name, your age:$age
#end
## 调用宏,结果:hello! Mike, your age:13
#method("Mike",13)
在这里插入图片描述
在这里插入图片描述
macro的注意

在使用中,有时候会用到嵌套循环,看一个例子。

java中定义一个list,内有 w1 w2 ccc 3个字符串

代码语言:javascript
复制
List<String> authRoleFind = new ArrayList<String>();
authRoleFind.add("w1");
authRoleFind.add("w2");
authRoleFind.add("ccc");
context.put("list",authRoleFind);

首先定义一个宏

在这里插入图片描述
在这里插入图片描述

这个时候,在一个和宏内调用了相同的List的循环,想当然的预想结果应该是:

代码语言:javascript
复制
w1 -> w1
w1 -> w2
w1 -> ccc
w2 -> w1
w2 -> w2
w2 -> ccc

但是它的结果却是这样的.auth ->

或许它是将 #macro 的内容,直接copy过去再进行 编译/执行 ?

解决:在引入时,我们要防止调用时参数的名字 和 #macro中的变量名冲突!

像上面那个例子,#macro 内容中,就已经使用了$name这个参数了,所以在调用的时候#methodFind()中不要再有$name

在这里插入图片描述
在这里插入图片描述

小结:我们在调用一个宏的时候 例#macro(methodFind a b) ,尽量以相同的参数名去调用#methodFind(a b),以防止参数名冲突

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

发布者:全栈程序员栈长,转载请注明出处:https://javaforall.cn/180158.html原文链接:https://javaforall.cn

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2022年10月19日,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 文章目录
  • 基本用法
    • 导入依赖
      • 1.基本用法
        • 1.1 注释
        • 1.2 替换变量
        • 1.3 不解析,原文输出
        • 1.4 调用对象方法
      • vtl 指令
        • set (String、int、Boolean、List、Map)
        • if 、else
        • foreach
        • include 、 parse
        • define
        • evaluate
        • macro
    领券
    问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档