velocity(VM)模板的语法简要汇总

/ 后端 / 无站内评论 / 402浏览
转自:http://blog.csdn.net/whereismatrix/article/details/50063581

What’s velocity

Velocity是一个基于java的模板引擎(template engine)。它允许任何人仅仅简单的使用模板语言(template language)来引用由java代码定义的对象。

符号

  1. “#”用来标识Velocity的脚本语句,包括#set、#if 、#else、#end、#foreach、#end、#iinclude、#parse、#macro等; 
    如:
#if($info.imgs)
<img src="$info.imgs" border=0>
#else
<img src="noPhoto.jpg">
#end
  • 1
  • 2
  • 3
  • 4
  • 5
  1. ()i、msgTagUtil.options(…)等。

  2. “{}”用来明确标识Velocity变量; 
    比如在页面中,页面中有一个someonenameVelocitysomeonenamesomeonename{someone}name。

  3. “!”用来强制把不存在的变量显示为空白。 
    如当页面中包含msgmsgmsgmsgmsg字符。这是我们不希望的,为了把不存 在的变量或变量值为null的对象显示为空白,则只需要在变量名前加一个“!”号即可。 
    如:$!msg

变量定义

#set($maxValue=5)
#set($name="Bob")
#set($arrayName=["element1","element2",...])
  • 1
  • 2
  • 3

注释

## This is a single line comment.
#*
Thus begins a multi-line comment. Online visitors won't
see this text because the Velocity Templating Engine will
ignore it.
*#
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6

还有一个文档注释

(3)文档格式:
  #**
   This is a VTL comment block and
   may be used to store such information
  as the document author and versioning
   information:
   @version 1.1
   @author  xiao
  *#
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9

静态引用输出

Velocity 遇到一个不能处理的引用时,一般他会直接输出这个引用email,email,如下例,我们可以在$后面加上一个!号,那么就会输出空白:

<input type="text" name="email" value="$email"/>
<input type="text" name="email" value="$!email"/>
  • 1
  • 2

关系和逻辑操作符

Velocity 也具有逻辑AND, OR 和 NOT 操作符。 

## example for AND
#if($foo && $bar)
   <strong> This AND that</strong>
#end
  • 1
  • 2
  • 3
  • 4

例子中#if()指令仅在$foo$bar斗为真的时候才为真。如果$foo为假,则表达式也为假;并且 $bar将不被求值。如果 $foo 为真,Velocity 模板引擎将继续检查$bar的值,如果 $bar 为真,则整个表达式为真。并且输出This AND that 。如果 $bar为假,将没有输出因为整个表达式为假。

转义字符

如果email 己定义了(比如它的值是foo),而这里你却想输出$email. 这样一个字符串,就需要使用转义字符”\”.

## The following line defines $email in this template:
#set( $email = "foo" )
$email
\$email
\\$email
\\\$email
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6

上面的模板在web 页面上的输出将是:

foo
$email
\foo
\$email
  • 1
  • 2
  • 3
  • 4

关于null

但注意:如果右边的操作数是一个属性或命令的引用而返回null,那么赋值将不会成功,且在随后也不能再取出使用. 如下例:

#set( $result = $query.criteria("name"))
The result of the first query is $result
#set( $result = $query.criteria("address"))
The result of the second query is $result
  • 1
  • 2
  • 3
  • 4

如果query.criteria("name")"bill",query.criteria(“address”) 返回null,上面的输出结果将是:

The result of the first query is bill
The result of the second query is bill
  • 1
  • 2

又如下例:

#set( $criteria = ["name", "address"] )
#foreach($criterion in $criteria )
    #set($result=$query.criteria($criterion) )
    #if($result)
        Query was successful
#end
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6

在上例中,就不能依赖if($result)来决定查询是否成功. #set右边如果是null会 它将不能被赋其它值.一个解决办法是,每次都将$result设为false:

#set( $criteria = ["name", "address"] )
#foreach($criterion in $criteria )
    #set($result = false)
    #set($result=$query.criteria($criterion) )
    #if($result)
        Query was successful
#end
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7

条件判断

#if($foo<10)
    <strong>Go North</strong>
#elseif($foo==10)
    <strong>Go East</strong>
#elseif($bar==6)
    <strong>Go South</strong>
#else
    <strong>Go West</strong>
#end
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9

循环和计数

通过引用变量$velocityCount可以访问到Velocity 提供的计数器:

<table>
#foreach( $customer in $customerList )
    <tr><td>$velocityCount</td><td>$customer.Name</td></tr>
#end
</table>
  • 1
  • 2
  • 3
  • 4
  • 5

$velocityCount是默认的计数器引用,你可以在配置velocity.properties 中改成你喜欢的:

include

include脚本元素让模板设计者可以在模板中引入一个本地文件, 这个被引入的文件将不会经过Velocity 的解析. 安全起见,可以引放的文件只是是配置参数TEMPLATE_ROOT所定义目录下的,默认为当前目录下.

#include( "one.txt" )
  • 1

多个文件或者用变量名代替:

#include( "greetings.txt", $seasonalstock )
  • 1

parse

parse元素指示可以引入一个包含TVL 的本地文件,这个文件将被Veloict engine 解析输出。

#parse( "me.vm" )
  • 1

与#include 指令不同, #parse 可以从引入的模板中得到变量引用.但#parse 指令只能接受一个参数.

VTL templates 被#parse 的模板中还可以再包含#parse 声明,默认的深度为10,这是由配置参数directive.parse.max.depth 在文件velocity.properties 中决定的,你可以修改它以适合项目要求

stop

stop指令用来指示在模板的某处,engine 停止解析,这一般用来调用。用法很简单.

#stop
  • 1

宏调用

macro指令让模板设计者可以将些重复、相关的的脚本版断定义为一个功能块.

#macro( tablerows $color $somelist )
  #foreach( $something in $somelist )
    <tr><td bgcolor=$color>$something</td></tr>
  #end
#end
  • 1
  • 2
  • 3
  • 4
  • 5

然后,我们在页面中来使用:

#set( $greatlakes = ["Superior","Michigan","Huron","Erie","Ontario"] )
#set( $color = "blue" )
<table>
    #tablerows( $color $greatlakes )
</table>
  • 1
  • 2
  • 3
  • 4
  • 5

输出结果:

<table>
    <tr><td bgcolor="blue">Superior</td></tr>
    <tr><td bgcolor="blue">Michigan</td></tr>
    <tr><td bgcolor="blue">Huron</td></tr>
    <tr><td bgcolor="blue">Erie</td></tr>
    <tr><td bgcolor="blue">Ontario</td></tr>
</table>
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7

如果将宏#tablerows($color $list)定义到一个模板库中(Velocimacros template library), 其它模板就都可以访问它了.

尽量不要直接在模板中使用#parse() 包含#macro() 指令.因为#parse() 动作在运行时执行,时会有一个在VM 中查找元素的过程.

内置对象

Velocity内置了一些对象,在vm模版里可以直接调用,列举如下: 
$request$response$session,另外,模板内还可以使用 $msg内的消息工具访问 Struts 的国际化资源,达到简便实现国际化的方法。

数组访问

对数组的访问在Velocity中存在问题,因为Velocity只能访问对象的方法,而数组又是一个特殊的Array,所以虽然数组可以进行循环列举,但却不能定位访问特定位置的元素,如 strs[2],数组对固定位置元素的访问调用了Array的反射方法get(Object array, int index),而Velocity没能提供这样的访问,所以数组要么改成List等其他类容器的方式来包装,要么就通过公用Util类的方式来提供,传入数组对象和要访问的位置参数,从而达到返回所需值的目的。

召唤蕾姆
琼ICP备18000156号

鄂公网安备 42011502000211号