Velocity
能为我们作什么? The Mud Store Example 假设你是一家专门出售Mud的在线商店的页面设计人员,让我们暂且称它为
“在线MUD商店”。你们的业务很旺,客户下了各种类型和数量的mud订单。他们都是通过输入用户名和密码后才登陆到你的网站,登陆后就允许他们查看订单
并购买更多的mud。现在,一种非常流行的mud正在打折销售。另外有一些客户规律性的购买另外一种也在打折但是不是很流行的Bright Red
Mud,由于购买的人并不多所以它被安置在页面的边缘。所有用户的信息都是被跟踪并存放于数据库中的,所以某天有一个问题可能会冒出来:为什么不使用
velocity来使用户更好的浏览他们感兴趣的商品呢? Velocity使得web页面的客户化工作非常容易。作为一个web
site的设计人员,你希望每个用户登陆时都拥有自己的页面。 你会见了一些公司内的软件工程师,你发现他们每个人都同意客户应该拥有具有个性化的
信息。那让我们把软件工程师应该作的事情发在一边,看一看你应该作些什么吧。 你可能在页面内嵌套如下的VTL声明:
上
面的实现结果是在页面上打印“Hello Velocity World!” 为了使包含VTL
directives的statement更具有可读性,我们鼓励你在新行开始每个VTL statement,尽管你不是必须这么作。Set
directive将在后面详细描述。 注释 单行注释: ## 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. *# 文档格式: #** This is a VTL comment block and
may be used to store such information as the document author and
versioning information: @version 5 @author *#
References 在
VTL中有三种类型的references:变量(variables)、属性(properties)、方法(methods)。作为一个使用VTL的
页面设计者,你和你的工程师必须就references的名称达成共识,以便你可以在你的template中使用它们。 Everything
coming to and from a
reference被作为一个String对象处理。如果有一个对象$foo是一个Integer对象,那么Velocity将调用它的
toString()方法将这个对象转型为String类型。 变量 格式要求同java。 属性 例子: $customer.Address $purchase.Total $customer.Address
有两种含义。它可以表示:查找hashtable对象customer中以Address为关键字的值;也可以表示调用customer对象的
getAddress()方法。当你的页面被请求时,Velocity将确定以上两种方式选用那种,然后返回适当的值。 方法 一个方法就
是被定义在java中的一段代码,并且它有完成某些有用工作的能力,例如一个执行计算和判断条件是否成立、满足等。方法是一个由$开始并跟随VTL标识符
组成的References,一般还包括一个VTL方法体。例如: $customer.getAddress() $purchase.getTotal() $page.setTitle(
“My Home Page” ) $person.setAttributes( [“Strange”, “Weird”,
“Excited”] ) 前两个例子$customer.getAddress()和$purchase.getTotal()看起来挺想上面的
属性$customer.Address 和 $purchase.Total。如果你觉得他们之间有某种联系的话,那你是正确的。 VTL属性可
以作为VTL方法的缩写。$customer.Address属性和使用$customer.getAddress()方法具有相同的效果。如果可能的话
使用属性的方式是比较合理的。属性和方法的不同点在于你能够给一个方法指定一个参数列表。 正式reference标记 reference
的正是格式如下: ${mudSlinger} 变量 ${customer.Address} 属性 ${purchase.getTotal()} 方
法 非正是格式更见常用,但是有时还是使用正是格式比较适合。例如:你希望通过一个变量$vice来动态的组织一个字符串。 Jack
is a $vicemaniac. 本来变量是$vice现在却变成了$vicemaniac,这样Veloctiy就不知道您到底要什么了。所
以,应该使用正是格式书写 Jack is a ${vice}maniac 现在Velocity知道变量是$vice而不
是$vicemaniac。 Quiet reference notation 例如:
$data.getUser(“jon”) ##
is the same as $data.User(“jon”)
$data.getRequest().getServerName() #
is the same as $data.Request.ServerName ## is the same as ${data.Request.ServerName} 但
是,注意VTL中不会将reference解释为对象的实例变量。例如:$foo.Name将被解释为Foo对象的getName()方法,而不是Foo
对象的Name实例变量。 Directives Reference允许设计者使用动态的内容,而directive使得你可以应用
java代码来控制你的显示逻辑,从而达到你所期望的显示效果。 #set #set
directive被用于设置一个reference的值。例如: #set ( $primate = “monkey” ) #set
( $customer.Behavior = $primate ) 赋值左侧的(LHS)必须是一个变量或者属性reference。右侧
(RHS)可以是以下类型中一种: l 变量reference l String literal l 属性
reference l 方法reference l number literal l ArrayList 下面是应
用各种类型的RHS的例子: #set ( $monkey = $bill ) ##变量reference #set (
$monkey.Friend = “monica” ) ##String literal #set ( $monkey.Blame =
$whitehouse.Leak )##属性reference #set ( $monkey.Plan =
$spindoctor.weave($web) )##方法reference #set ( $monkey.Number = 123
)##Number literal #set ( $monkey.Say = [“Not”, $my, “fault”]
)##ArrayList 注意:最后一个例子的取值方法为:$monkey.Say.get(0) RHS也可以是一个简单的算术表达式: #set
( $value = $foo + 1 ) #set ( $value = $bar -1 ) #set ( $value =
$foo * $bar ) #set ( $value = $foo / $bar ) 如果你的RHS是一个null,VTL的处理
将比较特殊:它将指向一个已经存在的reference,这对初学者来讲可能是比较费解的。例如: #set ( $resut =
$query.criteria(“name”) ) The result of the first query is $result
#set
( $resut = $query.criteria(“address”) ) The result of the second
query is $result 如果$query.criteria(“name”)返回一个“bill”,
而$query.criteria(“address”)返回的是null,则显示的结果如下: The result of the
first query is bill The result of the first query is bill 看看下面的例
子: #set( $criteria = ["name", "address"] ) #foreach( $criterion
in $criteria ) #set( $result = $query.criteria($criterion) ) #if(
$result ) Query was successful #end #end 在上面的例子中,程序将
不能智能的根据$result的值决定查询是否成功。在$result被#set后(added to the
context),它不能被设置回null(removed from the
context)。打印的结果将显示两次查询结果都成功了,但是实际上有一个查询是失败的。 为了解决以上问题我们可以通过预先定义的方式: #set(
$criteria = [“name”, “address”] ) #foreach( $criterion in
$criteria ) #set( $result = false ) #set( $result =
$query.criteria( $criterion ) ) #if( $result ) Query was
successful #end #end String Literals 当你使用#set
directive,String literal封闭在一对双引号内。 #set ( $directoryRoot = “www” ) #set
( $templateName = “index.vm” ) #set ( $template =
“$directoryRoot/$tempateName” ) $template 上面这段代码的输出结果
为:www/index.vm 但是,当string literal被封装在单引号内时,它将不被解析: #set (
$foo = “bar” ) $foo #set ( $blargh = '$foo’ ) 结果: bar $foo 上
面这个特性可以通过修改velocity.properties文件的stringliterals.interpolate =
false的值来改变上面的特性是否有效。 条件语句 if/elseif/else 当一个web页面被生成时使用
Velocity的#if directrive,如果条件成立的话可以在页面内嵌入文字。例如: #if ( $foo ) Velocity! #end 上
例中的条件语句将在以下两种条件下成立: l $foo是一个boolean型的变量,且它的值为true l $foo变量的值不为
null 这里需要注意一点:Velocity
context仅仅能够包含对象,所以当我们说“boolean”时实际上代表的时一个Boolean对象。即便某个方法返回的是一个boolean
值,Velocity也会利用内省机制将它转换为一个Boolean的相同值。 如果条件成立,那么#if和#end之间的内容将被显示。 #elseif
和#else元素可以同#if一同使用。例如: #if( $foo < 10 ) Go
North #elseif( $foo == 10 )
Go East #elseif( $foo == 6 )
Go South #else Go West
#end 注意这里的Velocity的数字是作为Integer来比较的――其他类型的对象将使得条
件为false,但是与java不同它使用“==”来比较两个值,而且velocity要求等号两边的值类型相同。 关系、逻辑运算符 Velocity
中使用等号操作符判断两个变量的关系。例如: #set ( $foo = “deoxyribonucleic acid” ) #set
( $bar = “ribonucleic acid” ) #if ( $foo == $foo ) In this case
it’s clear they aren’t equivalent.So… #else They are not
equivalent and this will be the output. #end
Velocity有AND、OR和
NOT逻辑运算符。下面是一些例子: ## logical AND #if( $foo && $bar )
This AND that #end
## logical OR #if
( $foo || $bar ) This OR That #end
##logical
NOT #if ( !$foo ) NOT that #end 循
环 Foreach循环 例子:
Velocimacro
arguments Velocimacro可以使用以下任何元素作为参数: l Reference:任何以$开头的
reference l String literal: l Number literal: l IntegerRange:
[1….3]或者[$foo….$bar] l 对象数组:[“a”,”b”,”c”] l boolean值:true、false 当
将一个reference作为参数传递给Velocimacro时,请注意reference作为参数时是以名字的形式传递的。这就意味着参数的值在每次
Velocimacro内执行时才会被产生。这个特性使得你可以将一个方法调用作为参数传递给Velocimacro,而每次Velocimacro执行
时都是通过这个方法调用产生不同的值来执行的。例如: #macro ( callme $a ) $a $a $a #end #callme(
$foo.bar() ) 执行的结果是:reference $foo的bar()方法被执行了三次。 如果你不需要这样的特性可以通过
以下方法: #set ( $myval = $foo.bar() ) #callme ( $myval )
Velocimacro
properties Velocity.properties文件中的某几行能够使Velocimacros的实现更加灵活。注意更多的内容
可以看Developer Guide。 Velocity.properties文件中的velocimacro.libraary:一个以逗号
分隔的模板库列表。默认情况下,velocity查找唯一的一个库:VM_global_library.vm。你可以通过配置这个属性来指定自己的模板
库。 Velocity.properties文件中的velocimacro.permissions.allow.inline属性:有两个可
选的值true或者false,通过它可以确定Velocimacros是否可以被定义在regular
template内。默认值是ture――允许设计者在他们自己的模板中定义Velocimacros。 Velocity.properties
文件中的 velocimacro.permissions.allow.inline.replace.global属性有两个可选值true和
false,这个属性允许使用者确定inline的Velocimacro定义是否可以替代全局Velocimacro定义(比如在
velocimacro.library属性中指定的文件内定义的Velocimacro)。默认情况下,此值为false。这样就阻止本地
Velocimacro定义覆盖全局定义。 Velocity.properties文件中的 velocimacro.permissions.allow.inline.local.scale
属性也是有true和false两个可选值,默认是false。它的作用是用于确定你inline定义的Velocimacros是否仅仅在被定义的
template内可见。换句话说,如果这个属性设置为true,一个inline定义的Velocimacros只能在定义它的template内使
用。你可以使用此设置实现一个奇妙的VM敲门:a template can define a private implementation of
the second VM that will be called by the first VM when invoked by that
template. All other templates are unaffected。 Velocity.properties文件中的
velocimacro.context.localscope属性有true和false两个可选值,默认值为false。当设置为true时,任何在
Velocimacro内通过#set()对context的修改被认为是针对此velocimacro的本地设置,而不会永久的影响内容。 Velocity.properties
文件中的velocimacro.library.autoreload属性控制Velocimacro库的自动加载。默认是false。当设置为
ture时,对于一个Velocimacro的调用将自动检查原始库是否发生了变化,如果变化将重新加载它。这个属性使得你可以不用重新启动
servlet容器而达到重新加载的效果,就像你使用regular模板一样。这个属性可以使用的前提就是resource
loader缓存是off状态(file.resource.loader.cache = false)。注意这个属性实际上是针对开发而非产品的。 Velocimacro
Trivia Velocimacro必须被定义在他们被使用之前。也就是说,你的#macro()声明应该出现在使用
Velocimacros之前。 特别要注意的是,如果你试图#parse()一个包含#macro()的模板。因为#parse()发生在运行
期,但是解析器在parsetiem决定一个看似VM元素的元素是否是一个VM元素,这样#parse()-ing一组VM声明将不按照预期的样子工作。
为了得到预期的结果,只需要你简单的使用velocimacro.library使得Velocity在启动时加载你的VMs。 Escaping
VTL directives VTL directives can be escaped with
“\”号,使用方式跟VTL的reference使用逃逸符的格式差不多。 ## #include( “a.txt” ) renders
as (注释行) #include( “a.txt” )