velocity自定义标签和指令

最新推荐文章于 2016-09-07 13:38:12 发布
最新推荐文章于 2016-09-07 13:38:12 发布
阅读量274 收藏
点赞数
文章标签： xhtml runtime java
本文介绍如何在Velocity模板引擎中自定义指令和标签，包括创建自定义指令的具体步骤、实现示例及如何在velocity.properties文件中配置自定义指令。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

velocity本身支持自定义标签和指令的扩展，

在 Velocity 模板语言的语法中，以美元符 $ 开头的为变量的声明或者引用，而以井号 # 开头的语句则为 Velocity 的指令（Directive）。

velocity支持的指令有：#set,#foreach,#if #else #end,#parse,#include,#evaluate,#define，#macro，

在velocity的jar包中的directive.properties中定义了这些实现：

[html] view plain copy print ?
  1. directive.1=org.apache.velocity.runtime.directive.Foreach
  2. directive.2=org.apache.velocity.runtime.directive.Include
  3. directive.3=org.apache.velocity.runtime.directive.Parse
  4. directive.4=org.apache.velocity.runtime.directive.Macro
  5. directive.5=org.apache.velocity.runtime.directive.Literal
  6. directive.6=org.apache.velocity.runtime.directive.Evaluate
  7. directive.7=org.apache.velocity.runtime.directive.Break
  8. directive.8=org.apache.velocity.runtime.directive.Define
directive.1=org.apache.velocity.runtime.directive.Foreach
directive.2=org.apache.velocity.runtime.directive.Include
directive.3=org.apache.velocity.runtime.directive.Parse
directive.4=org.apache.velocity.runtime.directive.Macro
directive.5=org.apache.velocity.runtime.directive.Literal
directive.6=org.apache.velocity.runtime.directive.Evaluate
directive.7=org.apache.velocity.runtime.directive.Break
directive.8=org.apache.velocity.runtime.directive.Define

自定义标签和指定，比如我们定义了下面的remoteVelocity指令

[html] view plain copy print ?
  1. <!DOCTYPEhtmlPUBLIC"-//W3C//DTDXHTML1.0Transitional//EN""http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <htmlxmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <metahttp-equiv="Content-Type"content="text/html;charset=gbk"/>
  5. <title>clickokpage</title>
  6. </head>
  7. <body>
  8. Thisapprunswell
  10. #set($monkey={"banana":"good","roastbeef":"bad"})
  12. #remoteVelocity("namespace","velocityname",$monkey)
  13. </body>
  14. </html> 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=gbk" />
<title>click ok page</title>
</head>
<body>
  This app runs well
  
  #set($monkey= {"banana" : "good", "roast beef" : "bad"})

  #remoteVelocity("namespace","velocityname",$monkey)
</body>
</html>

要对这个指令的实现要继承 Directive这个类，这个宏我们可以从其他服务获取vm的内容，动态渲染，这种方式可以统一管理公共模板，

[java] view plain copy print ?
  1. importjava.io.IOException;
  2. importjava.io.Serializable;
  3. importjava.io.StringWriter;
  4. importjava.io.Writer;
  5. importjava.util.HashMap;
  6. importjava.util.Map;
  8. importorg.apache.velocity.VelocityContext;
  9. importorg.apache.velocity.app.VelocityEngine;
  10. importorg.apache.velocity.context.InternalContextAdapter;
  11. importorg.apache.velocity.exception.MethodInvocationException;
  12. importorg.apache.velocity.exception.ParseErrorException;
  13. importorg.apache.velocity.exception.ResourceNotFoundException;
  14. importorg.apache.velocity.runtime.directive.Directive;
  15. importorg.apache.velocity.runtime.parser.node.Node;
  16. importorg.apache.velocity.runtime.parser.node.SimpleNode;
  17. importorg.springframework.beans.factory.annotation.Autowired;
  19. importcom.alibaba.citrus.service.template.TemplateService;
  20. importcom.alibaba.click.util.HostUtil;
  22. publicclassRemoteVelocityextendsDirective{
  24. @Autowired
  25. TemplateServicetemplateService;
  27. privatestaticfinalVelocityEnginevelocityEngine=newVelocityEngine();
  29. @Override
  30. publicStringgetName(){
  31. return"remoteVelocity";
  32. }
  34. @Override
  35. publicintgetType(){
  36. returnLINE;
  37. }
  39. @Override
  40. publicbooleanrender(InternalContextAdaptercontext,Writerwriter,
  41. Nodenode)throwsIOException,ResourceNotFoundException,
  42. ParseErrorException,MethodInvocationException{
  43. SimpleNodesn_region=(SimpleNode)node.jjtGetChild(0);
  44. Stringregion=(String)sn_region.value(context);
  45. SimpleNodesn_key=(SimpleNode)node.jjtGetChild(1);
  46. Serializablekey=(Serializable)sn_key.value(context);
  48. SimpleNodesn_data=(SimpleNode)node.jjtGetChild(2);
  49. Objectdata=sn_data.value(context);
  50. Mapmap=newHashMap();
  51. map.put("data",data);
  52. //Stringvel=HostUtil.getResponseText("http://127.0.0.1/index.html");
  53. Stringvel="#foreach($memberin$data.entrySet())<li>$member.key-$member.value</li>#end";
  54. writer.write(renderTemplate(map,vel));
  55. returntrue;
  56. }
  58. publicstaticStringrenderTemplate(Mapparams,StringvimStr){
  59. VelocityContextcontext=newVelocityContext(params);
  60. StringWriterwriter=newStringWriter();
  61. try{
  62. velocityEngine.evaluate(context,writer,"",vimStr);
  63. }catch(ParseErrorExceptione){
  64. //TODOAuto-generatedcatchblock
  65. e.printStackTrace();
  66. }catch(MethodInvocationExceptione){
  67. //TODOAuto-generatedcatchblock
  68. e.printStackTrace();
  69. }catch(ResourceNotFoundExceptione){
  70. //TODOAuto-generatedcatchblock
  71. e.printStackTrace();
  72. }catch(IOExceptione){
  73. //TODOAuto-generatedcatchblock
  74. e.printStackTrace();
  75. }//渲染模板
  76. returnwriter.toString();
  77. }
  79. }
import java.io.IOException;
import java.io.Serializable;
import java.io.StringWriter;
import java.io.Writer;
import java.util.HashMap;
import java.util.Map;

import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.VelocityEngine;
import org.apache.velocity.context.InternalContextAdapter;
import org.apache.velocity.exception.MethodInvocationException;
import org.apache.velocity.exception.ParseErrorException;
import org.apache.velocity.exception.ResourceNotFoundException;
import org.apache.velocity.runtime.directive.Directive;
import org.apache.velocity.runtime.parser.node.Node;
import org.apache.velocity.runtime.parser.node.SimpleNode;
import org.springframework.beans.factory.annotation.Autowired;

import com.alibaba.citrus.service.template.TemplateService;
import com.alibaba.click.util.HostUtil;

public class RemoteVelocity extends Directive{
	
	@Autowired
	TemplateService templateService;
	
	private static final VelocityEngine velocityEngine = new VelocityEngine();

	@Override
	public String getName() {
		return "remoteVelocity";
	}

	@Override
	public int getType() {
		return LINE;
	}

	@Override
	public boolean render(InternalContextAdapter context, Writer writer,
			Node node) throws IOException, ResourceNotFoundException,
			ParseErrorException, MethodInvocationException {
		SimpleNode sn_region = (SimpleNode) node.jjtGetChild(0);   
        String region = (String)sn_region.value(context);   
        SimpleNode sn_key = (SimpleNode) node.jjtGetChild(1);   
        Serializable key = (Serializable)sn_key.value(context);   

		SimpleNode sn_data = (SimpleNode) node.jjtGetChild(2); 
		Object data = sn_data.value(context);   
		Map map = new HashMap();
		map.put("data", data);
//		String vel = HostUtil.getResponseText("http://127.0.0.1/index.html");
		String vel="#foreach($member in $data.entrySet())<li>$member.key - $member.value</li>#end ";
		writer.write(renderTemplate(map,vel));
        return true;
	}
	
	public static String renderTemplate(Map params,String vimStr){
        VelocityContext context = new VelocityContext(params);
        StringWriter writer = new StringWriter();
        try {
			velocityEngine.evaluate(context, writer, "", vimStr);
		} catch (ParseErrorException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (MethodInvocationException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (ResourceNotFoundException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (IOException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}//渲染模板
        return writer.toString();
	}

}

node.jjtGetChild(2) 这个方法可以获取对应指令的参数，下标从0开始，

在web工程的WEB-INF下面定义velocity.properties这个配置文件，用户扩展的指令最好放到这个文件里面，velocity的jar包里面提供了默认实现，我们可以覆盖重新定义自己的扩展，类就是对应自己的扩展类的类名

#自定义标签


[html] view plain copy print ?
  1. userdirective=com.alibaba.click.test.RemoteVelocity
userdirective=com.alibaba.click.test.RemoteVelocity

这样启动后就可以正常使用了。

Directive的三个方法：

[html] view plain copy print ?
  1. getName：指令的名称
  2. getType:当前有LINE,BLOCK两个值，line行指令，不要end结束符，block块指令，需要end结束符
  3. publicbooleanrender(InternalContextAdaptercontext,Writerwriter,
  4. Nodenode)具体处理过程
getName：指令的名称
getType:当前有LINE,BLOCK两个值，line行指令，不要end结束符，block块指令，需要end结束符
public boolean render(InternalContextAdapter context, Writer writer,
			Node node) 具体处理过程

iteye_14984
关注
Velocity语法
Alex的专栏
12-23 3596
<br /><br />一、基本语法1、"#"用来标识Velocity的脚本语句，包括#set、#if 、#else、#end、#foreach、#end、#iinclude、#parse、#macro等；<br />如:<br />#if($info.imgs)<br /><img src="$info.imgs" border=0><br />#else<br /><img src="noPhoto.jpg"><br />#end<br /><br />2、"$"用来标识一个对象(或理解为变量)；如<b
volicity 自定义指令 Directive 并获取ApplicationContext
TimerBin的博客
10-29 242
背景说明：在基于spring MVC、volicity的WEB项目中，需要在volicity页面中读取远程配置信息(zookeeper)。   第一步：编写读取远程配置信息工具类(具体不做说明)   详情可参阅：http://timerbin.iteye.com/blog/2252372   第二步：编写自定义指令(Directive)   package cn.timerbi...
Velocity 的自定义指令
weixin_34232363的博客
07-08 175
为什么80%的码农都做不了架构师？>>> ...
要学velocity了，先用自定义标签实现模块展示问题
feiyan35488的专栏
09-14 237
velocity 和freemarker 基本一致，就是不如freemarker 的 语法强，但是挺简单的 自定义标签的实现过程，        定义标签实现类，继承 tagsupport 类 ，继承tag也行   类里面定义了一些 常用变量 很方便。         然后实现startTag（） 和 endTag（） 方法，          编辑tld 文件   里面属性名 和 标签类...
java 中配置 velocity 自定义标签
06-07
要在 Java 中配置 Velocity 自定义标签，你需要完成以下几个步骤： 1. 定义 Velocity 的引擎和上下文： ``` VelocityEngine engine = new VelocityEngine(); engine.init(); VelocityContext context = new ...
Velocity自定义指令开发：业务逻辑与模板分离的艺术
Velocity自定义指令开发概述 在当今的Web开发中，模板引擎被广泛用于生成动态网页内容，而Velocity作为其中的佼佼者，不仅能够提供模板渲染的基础功能，还允许开发者通过自定义指令来扩展其核心能力。本章将概览...
velocity 自定义指令 , 在render方法中, 除了获取指令的参数, 如何获取指令的内容?
06-09
在 render 方法中，可以通过 `props` 属性获取传递...在 `MyComponent` 中，使用了自定义的 `Velocity` 指令，并将参数和内容传递给该组件。在 `Velocity` 的 `render` 方法中，可以使用这些参数和内容进行处理和渲染。
如何使用groovy给velocity添加自定义指令？
最新发布
04-03
2. **指令类型**：准确区分`LINE`（行级，无闭合标签）和`BLOCK`（块级，需要`#end`闭合） 3. **异常处理**：在render()方法中妥善处理可能出现的异常 通过以上步骤，即可利用Groovy的简洁语法高效扩展Velocity模板...
velocity 自定义指令 使用block, 即需要结尾 #end , 但是在解析的时候, 如果自定义指令写在#if指令中, 那么自定义指令的#end会被判断为#if的#end, 该如何解决, 我使用Java进行开发, 不能使用#macro和#parse指令解决,请给出示例
06-09
如果不能使用`#parse`和`#macro`指令解决这个问题，你可以考虑使用Velocity的`#evaluate`指令来实现自定义指令。 在使用`#evaluate`指令时，可以将自定义指令的内容作为一个字符串，然后将它传递给`#evaluate`指令...
velocity 基础指令
jueshengtianya的专栏
09-07 639
参考：http://wiki.hotoo.me/Velocity-Notes.html
velocity常用指令
ch3c_es的专栏
02-16 268
常用指令和例子 1、$!obj 　直接返回对象结果。 　　 如：在html标签中显示java对象msg的值。$!msg 　 在html标签中显示经过HtmlUtil对象处理过后的msg对象的值　　$!HtmlUtil.doSomething($!msg) 2、#if($!obj) #else #end 判断语句 　　 如：在EasyJWeb各种开源应用中，我们经常看到的...
实现自定义Velocity Context
乐影天海
12-18 1007
Webwork的WebWorkVelocityContext默认提供了 req,res.stack,webwork,action几个内置对象，但不一定能满足我们的需要，往往，我们需要自己定义一些工具类，在velocity页面中调用，比如说，webwork并没有提供一个数据处理的内置对象，Math类使用静态方法，我们不能用简单的直接访问方式访问其中的函数，作为替代方法，我们可以写一个类，创建Math...
[Velocity二]自定义Velocity指令
bit1129的博客
08-19 664
什么是Velocity指令 在Velocity中，#set,#if, #foreach, #elseif, #parse等，以#开头的称之为指令，Velocity内置的这些指令可以用来做赋值，条件判断，循环控制等脚本语言必备的逻辑控制等语句，Velocity的指令是可扩展的，即用户可以根据实际的需要自定义Velocity指令   自定义指令(Directive)的一般步骤  1.定义自...
velocity自定义指令示例
Hesper100的专栏
03-20 1274
本文将简单举例如何创建velocity的自定义指令。     本示例的目的，使用自定义指令把字符串修整成定长（此处使用的是左边补零法），例如，源字符串为“56”，目标长度为6，则修整后的结果为“000056”。     本示例的准备工作，诸如安装环境导入velocity的jar包之类的就不说了，这一步不是本文的重点，大家参考其他资料很容易获得。以下直接上码。     第一步：编写自定义指令类
Velocity工具-渲染自定义模板
老牛啊
04-27 398
自从有了Maven，一直在想使用模板技术搭建项目工程，其中之一就是日志的配置文件Log4j.xml，因为项目不同，日志的输出路径也是不同的。   因此，想在程序启动之前，以渲染的方式配置Log4j.xml文件内容，这样就实现了日志管理的模板化。   Velocity便是理想的选择，因此，写了个Velocity工具类VelocityHelper，专门用于渲染模板，并完成了测试。   /*...
Velocity语法强化5之指令符号
Anders 的专栏(Talk is cheap, show me the code！)
07-26 3113
模板设计者使用“引用“生成动态内容, 指令(directives) – 简单的说就是设计者在模板中操作java对象—让视图设计者全面控制输出内容的格式.  指令总是以 #开头后面紧跟具体的指令符. 就像引用一样（指令的一种）,可以将指令理解为”表示这里是一个什么东东).如下例生成一个出错提示:  #if($a==1)true enough#elseno way!#end
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值