velocity.properties 的一些配置项
- velocimcro.library属性:指定自己的模板库,多个模板库以逗号分隔。默认情况下,velocity查找唯一的一个库:VM_global_library.vm
- velocimacro.permissions.allow.inline属性:是否允许开发者在普通模板内定义Velocity宏。ho
- velocimacro.permissions.allow.inline.replace.global属性: 是否允许设计者使用本地的inline的 宏替代全局的宏(全局的宏是指在velocimacro.library属性中指定的文件内定义的宏)。默认情况下,此值为false。这样就阻止本地的宏覆盖全局的。
- velocimacro.permissions.allow.inline.local.scale属性: inline定义的宏是否仅仅在被定义的template内可见. 默认是false。 换句话说,如果这个属性设置为true,一个inline定义的宏只能在定义它的template内使用。
- velocimacro.context.localscope属性: 默认值为false。当设置为true时,任何在宏内通过#set()对context的修改被认为是针对此宏的本地设置,而不会永久的影响内容。
- velocimacro.library.autoreload属性: 控制宏库的自动加载。默认是false。当设置为ture时,对于一个宏的调用将自动检查原始库是否发生了变化,如果变化将重新加载它。这个属性使得你可以不用重新启动servlet容器而达到重新加载的效果,就像你使用regular模板一样。这个属性可以使用的前提就是resource loader缓存是off状态(file.resource.loader.cache = false)。注意这个属性实际上是针对开发而非产品的。
Velocity宏的一些说明
Velocity宏必须定义在它们被使用之前,也就是说,你的#macro()声明应该出现在使用宏之前。特别要注意的是,当你试图#parse()一个包含#macro()的模板时候。因为#parse()发生在运行期,但是解析器在parsetiem决定一个看似VM元素的元素是否是一个VM元素,这样#parse()-ing一组VM声明将不按照预期的样子工作。为了得到预期的结果,只需要你简单的使用velocimacro.library使得Velocity在启动时加载你的VMs。
再说Velocity的转义符
我们已经知道使用反斜杠(\)进行转义。下面总结一下:
1 | ## #include( “a.txt” ) renders as < ontents of a.txt>(注释行) |
2 | #include( “a.txt” ) |
3 |
4 | ## \#include( “a.txt” ) renders as \#include( “a.txt” ) |
5 | \#include( “a.txt” ) |
6 |
7 | ## \\#include ( “a.txt” ) renders as \< contents of a.txt> |
8 | \\#include( “a.txt” ) |
在对在一个directive内包含多个script元素的VTL directives, 使用逃逸符时要特别小心(比如在一个if-else-end statement内)。下面是VTL的if-statement的典型应用:
1 | #if ( $jazz ) |
2 | Vyacheslav Ganelin |
3 | #end |
如果$jazz是ture,输出将是:
Vyacheslav Ganelin
如果$jazz是false,将没有输出。使用逃逸符将改变输出。考虑一下下面的情况:
1 | \#if ( $jazz ) |
2 | Vyacheslav Ganelin |
3 | \#end |
现在无论$jazz是true还是false,输出结果都是:
#if ( $jazz )
Vyacheslav Ganelin
#end
事实上,由于你使用了逃逸符,$jazz根本就没有被解析为boolean型值。在逃逸符前使用逃逸符是合法的,例如:
1 | \\#if ( $jazz ) |
2 | Vyacheslav Ganelin |
3 | \\#end |
以上程序的显示结果为:
\ Vyacheslav Ganelin
\
但是如果$jazz为false,那么将没有输出。(书上说会没有输出,但是我觉得应该还有有“\”字符被输出。)
VTL:Formatting issues
尽管在此用户手册中VTL通常都开始一个新行,如下所示:
1 | #set ( $imperial = [ “Munetaka”, “Koreyasu”, “Hisakira”, “Morikune” ] ) |
2 | #foreach ( $shogun in $imperial ) |
3 | $shogun |
4 | #end |
但是像下面这种写法也是可以的:
1 | Send me #set($foo = [“$10 and”,”a cake”])#foreach($a in $foo)$a #end please. |
上面的代码可以被改写为:
1 | Send me |
2 | #set ( $foo = [“$10 and “,”a cake”] ) |
3 | #foreach ( $a in $foo ) |
4 | $a |
5 | #end |
6 | please. |
或者
1 | Send me |
2 | #set($foo = [“$10 and “,”a cake”]) |
3 | #foreach ($a in $foo )$a |
4 | #end please. |
这两种的输出结构将一样。
其他特性和杂项
- 在模板中可以使用Velocity内建的算术函数,如:加、减、乘、除
1 | #set ( $foo = $bar + 3 ) |
2 | #set ( $foo = $bar - 4 ) |
3 | #set ( $foo = $bar * 6 ) |
4 | #set ( $foo = $bar / 2 ) |
当执行除法时将返回一个Integer类型的结果。而余数你可以使用%来得到:
1 | #set ( $foo = $bar % 5 ) |
在Velocity内使用数学计算公式时,只能使用像-n,-2,-1,0,1,2,n这样的整数,而不能使用其它类型数据。当一个非整型的对象被使用时它将被logged并且将以null作为输出结果。
Range Operator
Range operator可以被用于与#set和#foreach statement联合使用。对于处理一个整型数组它是很有用的,Range operator具有以下构造形式:
1 | [n..m] |
m和n都必须是整型,而m是否大于n则无关紧要。例子:
First example:
1 | #foreach ( $foo in [1..5] ) |
2 | $foo |
3 | #end |
Second example:
1 | #foreach ( $bar in [2..-2] ) |
2 | $bar |
3 | #end |
Third example:
1 | #set ( $arr = [0..1] ) |
2 | #foreach ( $i in $arr ) |
3 | $i |
4 | #end |
Fourth example:
1 | [1..3] |
上面四个例子的输出结果为:
First example:
1 2 3 4 5
Second example:
2 1 0 -1 -2
Third example:
0 1
Fourth example:
[1..3]
注意:range operator只在#set和#foreach中有效。
Advanced Issue:Escaping and!
当一个reference被“!”分隔时,并且在它之前有逃逸符时,reference将以特殊的方式处理。注意这种方式与标准的逃逸方式时不同的。对照如下:
1 | #set ( $foo = “bar” ) |
特殊形式 标准格式
Render前 Render后 Render前 Render后
$\!foo $!foo \$foo \$foo
$\!{foo} $!{foo} \$!foo \$!foo
$\\!foo $\!foo \$!{foo} \$!{foo}
$\\\!foo $\\!foo \\$!{foo} \bar
Velocimacro杂记
- Can I user a directive or another VM as an argument to a VM? For example, #center ( #bold( “hello” ) )
不可以。
一个directive的参数使用另外一个directive是不合法的。
但是,还是有些事情你可以作的。最简单的方式就是使用双引号:
1 | #set ( $stuff = "#bold( 'hello' )" ) |
2 | #center ( $stuff ) |
上面的格式也可以缩写为一行:
1 | #center ("#bold('hello')") |
请注意在下面的例子中参数被evaluated在Velocimacro内部,而不是在calling level。例子:
01 | #macro ( inner $foo ) |
02 | inner : $foo |
03 | #end |
04 |
05 | #macro ( outer $foo ) |
06 | #set ( $bar = "outerlala" ) |
07 | outer : $foo |
08 | #end |
09 | |
10 | #set ( $bar = 'calltimelala' ) |
11 | #outer( "#inner($bar)" ) |
输出结果为:
outer : inner : outerlala
记住Veloctiy的特性:参数的传递是By Name的。例如:
1 | #macro ( foo $color ) |
2 | < tr bgcolor = $color >< td >Hi</ td ></ tr > |
3 | < tr bgcolor = $color >< td >There</ td ></ tr > |
4 | #end |
5 |
6 | #foo ( $bar.rowColor() ) |
以上代码将导致rowColor()方法两次调用,而不是一次。为了避免这种现象的出现,我们可以按照下面的方式执行:
1 | #set ( $color = $bar.rowColor() ) |
2 | #foo ( $color ) |
- can I register velocimacros via #parse()?
目前,Velocimacros必须在第一次被模板调用前被定义。这就意味着
你的#macro()声明应该出现在使用Velocimacros之前。如果你试图#parse()一个包含#macro() directive的模板,这一点是需要牢记的:因为#parse()发生在运行期,但是解析器在parsetiem决定一个看似VM元素的元素是否是一个VM元素,这样#parse()-ing一组VM声明将不按照预期的样子工作。为了得到预期的结果,只需要你简单的使用velocimacro.library使得Velocity在启动时加载你的VMs。
- What is velocimacro autoreloading?
velocimacro.library.autoreload是专门为开发而非产品使用的一个属性。此属性的默认值是false。
String concatenation
开发人员最常问的问题是我如何作字符拼接?在java中是使用“+”号来完成的。
在VTL里要想实现同样的功能你只需要将需要联合的reference放到一起就行了。例如:
1 | #set ( $size = “Big” ) |
2 | #set ( $name = “Ben” ) |
3 | The clock is $size$name. |
输出结果将是:The clock is BigBen.。更有趣的情况是:
1 | #set ( $size = “Big” ) |
2 | #set ( $name = “Ben” ) |
3 | #set ( $clokc = “$size$name” ) |
4 | The clock is $clock. |
上例也会得到同样的结果。最后一个例子,当你希望混合固定字段到你的reference时,你需要使用标准格式:
1 | #set ( $size = "Big" ) |
2 | #set ( $name = "Ben" ) |
3 | #set ( $clock = "${size}Tall$name" ) |
4 | The clock is $clock. |
输出结果是:The clock is BigTallBen.。使用这种格式主要是为了使得$size不被解释为$sizeTall。