Velocity知识点总结
Velocity知识点总结
1. 变量
(1)变量的定义：
#set($name = "hello") 说明：velocity中变量是弱类型的。
当使用#set 指令时，括在双引號中的字面字符串将解析和又一次解释，例如以下所看到的：
#set($directoryRoot = "www" )
#set($templateName = "index.vm" )
#set($template ="$directoryRoot/$templateName" )
$template
输出将会是：www/index.vm
注：在velocity中使用$2.5这种货币标识是没有问题得的，由于velocity中的变量总是以一个大写或者小写的字母開始的。
(2)变量规范的写法
${name} ，也能够写成：$name。提倡用前面的写法。
比如：你希望通过一个变量$vice来动态的组织一个字符串。
Jackis a $vicemaniac.
本来变量是$vice如今却变成了$vicemaniac，这样Veloctiy就不知道您究竟要什么了。所以，
应该使用规范的格式书写： Jack is a ${vice}maniac
如今Velocity知道变量是$vice而不是$vicemaniac。
注意：当引用属性的时候不能加{}
(3)变量的赋值:
$name="hello"
赋值的左边必须是一个变量或者是属性引用。右边能够是以下六种类型之中的一个：
变量引用,字面字符串,属性引用,方法引用,字面数字,数组列表。
以下的样例演示了上述的每种类型：
#set( $monkey = $bill ) ## variablereference
#set( $monkey.Friend = "monica" )## string
#set( $monkey.Blame = $whitehouse.Leak ) ##property reference
#set( $monkey.Plan =$spindoctor.weave($web) ) ## method reference
#set( $monkey.Number = 123 ) ##number
#set( $monkey.Say = ["Not", $my,"fault"] ) ## ArrayList
注意：①假设上述样例中的右值是null, 则左值不会被赋值，也就是说会保留曾经的值。
②velocity模板中未被定义的变量将被觉得是一个字符串。比如：
#set($foo = "gibbous")
$moon = $foo
输出结果为：
$moon = gibbous
③velocity模板中不会将reference解释为对象的实例变量。比如：$foo.Name将被解
释为Foo对象的getName（）方法。而不是Foo对象的Name实例变量。比如：
$foo.getBar() 等同于$foo.Bar 。
$data.getUser("jon") 等同于$data.User("jon")；
data.getRequest().getServerName() 等同于
$data.Request.ServerName等同于${data.Request.ServerName}
2. 循环
#foreach ($element in $list)
This is $element.
$velocityCount
#end
样例：
#set( $list = ["pine","oak", "maple"])
#foreach ($element in $list)
$velocityCount
This is $element.
#end
输出的结果为：
1 This is pine.
2 This is oak.
3 This is maple.
每次循环$list中的一个值都会赋给$element变量。
$list能够是一个Vector、Hashtable或者Array。分配给$element的值是一个java对象，而且能够通过变量被引用。
比如：假设$element t是一个java的Product类，而且这个产品的名字能够通过调用他的getName（）方法得到。
#foreach ( $key in $list.keySet())
Key: $key -> Value: $list.get($key)<br>
#end
提示：velocity中大写和小写敏感。
Velocity还特别提供了得到循环次数的方法，$velocityCount变量的名字是Velocity默认的名字。
样例：
First example:
#foreach ( $foo in [1..5] )
$foo
#end
Second example:
#foreach ( $bar in [2..-2] )
$bar
#end
Third example:
#set ( $arr = [0..1] )
#foreach ( $i in $arr )
$i
#end
上面三个样例的输出结果为：
First example：
1 23 4 5
Second example：
2 10 -1 -2
Third example：
0 1
3. 条件语句
#if (condition)
#elseif (condition)
#else
#end
4. 语句的嵌套
#foreach ($element in $list)
##inner foreach 内循环
#foreach ($element in $list)
This is $element. $velocityCount<br>inner<br>
#end
##inner foreach 内循环结束
##outer foreach
This is $element.
$velocityCount <br>outer<br>
#end
语句中也能够嵌套其它的语句。如#if…#else…#end等。
5. 凝视
(1)单行凝视：
##This is a single line comment.
(2)多行凝视：
#*
Thusbegins a multi-line comment. Online visitors won’t
seethis text because the Velocity Templating Engine will
ignore it.
*#
(3)文档格式：
#**
Thisis a VTL comment block and
maybe used to store such information
asthe document author and versioning
information:
@version 1.1
@author xiao
*#
6. 关系和逻辑操作符
Velocity 也具有逻辑AND, OR 和 NOT 操作符。
如
## example for AND
#if($foo && $bar)<strong>Thisand that</strong>
#end
样例中#if() 指令仅在$foo 和$bar 都为真的时候才为真。假设$foo 为假。则表达式也为假；
而且 $bar 将不被求值。
假设 $foo 为真，Velocity 模板引擎将继续检查$bar的值。假设 $bar
为真，则整个表达式为真。而且输出This AND that 。假设 $bar 为假，将没有输出由于整
个表达式为假。
7.Velocity 中的宏
Velocity中的宏我们能够理解为函数。
①宏的定义
#macro(宏的名称 $參数1 $參数2 …)
语句体(即函数体)
#end
②宏的调用
#宏的名称($參数1 $參数2 …)
说明：參数之间用空格隔开。
8．#stop
停止运行模板引擎并返回,把它应用于debug是非常有帮助的。
9．#include与#parse
#include和#parse的作用都是引入本地文件, 为了安全的原因。被引入的本地文件仅仅能在
TEMPLATE_ROOT文件夹下。
差别：
(1) 与#include不同的是。#parse仅仅能指定单个对象。而#include能够有多个
假设您须要引入多个文件，能够用逗号分隔即可：
#include ("one.gif","two.txt", "three.htm" )
在括号内能够是文件名称，可是很多其它的时候是使用变量的：
#include ( “greetings.txt”, $seasonalstock)
(2) #include被引入文件的内容将不会通过模板引擎解析；
而#parse引入的文件内容Velocity将解析当中的velocity语法并移交给模板，意思就是说
相当与把引入的文件copy到文件里。
#parse是能够递归调用的。比如：假设dofoo.vm包括例如以下行：
Count down.<br>
#set ($count = 8)
#parse ("parsefoo.vm")
<br>All done with dofoo.vm!
那么在parsefoo.vm模板中，你能够包括例如以下VTL：
$count
#set($count = $count - 1)
#if ( $count > 0 )<br>
#parse( "parsefoo.vm" )
#else
<br>All done with parsefoo.vm!
#end的显示结果为：
Count down.
8
7
6
5
4
3
2
1
0
All done with parsefoo.vm!
All done with dofoo.vm!
注意：在vm中使用#parse来嵌套另外一个vm时的变量共享问题。如：
->a.vm 里嵌套 b.vm。
->a.vm 里定义了变量 $param；
->b.vm 里能够直接使用$param。无不论什么限制。
但须要特别注意的是，假设b.vm里同一时候定义有变量$param，则b.vm里将使用b.vm里定义的值。
10．转义字符'\'的使用
假设reference被定义，两个’\’意味着输出一个’\’，假设未被定义，刚按原样输出。
如：
#set($email = "foo" )
\$emai
l\\$email
输出：
foo
\foo
假设$email 没有定义
输出：
11．内置对象
Velocity内置了一些对象，在vm模版里能够直接调用，列举例如以下：
$request、$response、$session。另外，模板内还能够使用$msg内的消息工具訪问 Struts 的国际化资源，达到简便实现国际化的方法。
12. 数组訪问
对数组的訪问在Velocity中存在问题，由于Velocity仅仅能訪问对象的方法，而数组
又是一个特殊的Array。所以尽管数组能够进行循环列举，但却不能定位訪问特定
位置的元素，如 strs[2]，数组对固定位置元素的訪问调用了Array的反射方法
get(Object array, int index)，而Velocity没能提供这种訪问，所以数组要么改成
List等其它类容器的方式来包装，要么就通过公用Util类的方式来提供。传入数组
对象和要訪问的位置參数，从而达到返回所需值的目的。
