模板语言，Velocity

什么是Velocity

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

当Velocity应用于web开发时，界面设计人员可以和java程序开发人员同步开发一个遵循MVC架构的web站点，也就是说，页面设计人员可以只关注页面的显示效果，而由java程序开发人员关注业务逻辑编码。Velocity将java代码从web页面中分离出来，这样为web站点的长期维护提供了便利，同时也为我们在JSP和PHP之外又提供了一种可选的方案。

Velocity的能力远不止web站点开发这个领域，例如，它可以从模板（template）产生SQL和PostScript、XML，它也可以被当作一个独立工具来产生源代码和报告，或者作为其他系统的集成组件使用。Velocity也可以为Turbine web开发架构提供模板服务（template service）。Velocity+Turbine提供一个模板服务的方式允许一个web应用以一个真正的MVC模型进行开发。

Velocity能为我们作什么？

The Mud Store Example

假设你是一家专门出售Mud的在线商店的页面设计人员，让我们暂且称它为“在线MUD商店”。你们的业务很旺，客户下了各种类型和数量的mud订单。他们都是通过输入用户名和密码后才登陆到你的网站，登陆后就允许他们查看订单并购买更多的mud。现在，一种非常流行的mud正在打折销售。另外有一些客户规律性的购买另外一种也在打折但是不是很流行的Bright Red Mud，由于购买的人并不多所以它被安置在页面的边缘。所有用户的信息都是被跟踪并存放于数据库中的，所以某天有一个问题可能会冒出来：为什么不使用velocity来使用户更好的浏览他们感兴趣的商品呢？

Velocity使得web页面的客户化工作非常容易。作为一个web site的设计人员，你希望每个用户登陆时都拥有自己的页面。

你会见了一些公司内的软件工程师，你发现他们每个人都同意客户应该拥有具有个性化的信息。那让我们把软件工程师应该作的事情发在一边，看一看你应该作些什么吧。

你可能在页面内嵌套如下的VTL声明：

<html> 
<body> 
	Hello $customer.Name! 
<table> 
#foreach( $mud in $nudsOnSpecial ) 
	#if ( $customer.hasPurchased( $mud ) ) 
		<tr><td>$flogger.getPromo( $mud )</td></tr> 
	#end 
#end 
</table> 

##Velocity Template Language(VTL)

VTL意味着提供最简单、最容易并且最整洁的方式合并页面动态内容。

语法

references and directives overview

TL使用references来在web site内嵌套动态内容，一个变量就是一种类型的reference。变量是某种类型的refreence，它可以指向java代码中的定义，或者从当前页面内定义的VTL statement得到值。下面是一个VTL statement的例子，它可以被嵌套到HTML代码中：

#set ( $a = “Velocity” )

和所有的VTL statement一样，这个statement以＃字符开始并且包含一个指令（directive）：set。当一个在线用户请求你的页面时，Velocity Templating Engine将查询整个页面以便发现所有＃字符，然后确定哪些是VTL statement，哪些不需要VTL作任何事情。

＃字符后紧跟一个directive：set时，这个set directive使用一个表达式（使用括号封闭）――一个方程式分配一个值给变量。变量被列在左边，而它的值被列在右边，最后他们之间使用＝号分割。

在上面的例子中，变量是$a，而它的值是Velocity。和其他的references一样以$字符开始，而值总是以双引号封闭。Velocity中仅有String可以被赋值给变量。

记住以下的规则：

使用$字符开始的references用于得到什么；使用#字符开始的directives用于作些什么。

一旦某个变量被分配了一个值，那么你就可以在HTML文件的任何地方引用它。在下面的例子中，一个值被分配给$foo变量，并在其后被引用。

<html> 
<body> 
#set ( $foo = “Velocity” ) 
Hello $foo World! 
</body> 
</html> 

上面的实现结果是在页面上打印“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

例如：

<input type=”text” name=”email” value=”$email” />

当页面的form被初始加载时，变量$email还没有值，这时你肯定是希望它能够显示一个blank text来代替输出”$email”这样的字段。那么使用quiet reference notation就比较合适。

<input type=”text” name=”email” value=”$!email”/>

这样文本框的初始值就不会是email而是空值了。

正式和quiet格式的reference notation也可一同使用，像下面这样：

<input type=”text” name=”email” value=”$!{email}”/>

Getting literal

Velocity使用特殊字符$和#来帮助它工作，所以如果要在template里使用这些特殊字符要格外小心。本节将讨论$字符。

货币字符

在VTL中使用$2.5这样的货币标识是没有问题得的，VTL不会将它错认为是一个reference，因为VTL中的reference总是以一个大写或者小写的字母开始。

Escaping valid VTL reference

VTL中使用“\”作为逃逸符。例如：

#set( $email = “foo” ) 
$email 
\$email 
\\$email 
\\\$email 

将render为：

foo 
$email 
\foo 
\\$email

如果email变量没有被定义则

$email 
\$email 
\\$email 
\\\$email

将被render为：

$email 
\$email 
\\$email 
\\\$email 

注意：VTL中未被定义的变量将被认为是一个字符串，所以以下例子：

#set( $foo = “gibbous” ) 
$moon = $foo 

的输出结果是：

$moon = gibbous

Case substitution

现在你已经对reference比较熟悉了，你可以将他们高效的应用于你的template了。Velocity利用了很多java规范以方便了设计人员的使用。例如：

$foo 
$foo.getBar() 
## is the same as 
$foo.Bar 

$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）可以是以下类型中一种：

变量reference
String literal
属性reference
方法reference
number literal
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 ) 
  <strong>Velocity!</strong> 
#end 

上例中的条件语句将在以下两种条件下成立：

$foo是一个boolean型的变量，且它的值为true
$foo变量的值不为null

这里需要注意一点：Velocity context仅仅能够包含对象，所以当我们说“boolean”时实际上代表的时一个Boolean对象。即便某个方法返回的是一个boolean值，Velocity也会利用内省机制将它转换为一个Boolean的相同值。

如果条件成立，那么#if和#end之间的内容将被显示。

#elseif和#else元素可以同#if一同使用。例如：

#if( $foo < 10 ) 
  <strong> Go North </strong> 
#elseif( $foo == 10 ) 
  <strong> Go East </strong> 
#elseif( $foo == 6 ) 
  <strong> Go South </strong> 
#else 
  <strong> Go West </strong> 
#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 ) 
  <strong> This AND that </strong> 
#end 

## logical OR 
#if ( $foo || $bar ) 
  <strong>This OR That </strong> 
#end 

##logical NOT 
#if ( !$foo ) 
  <strong> NOT that </strong> 
#end 

循环

Foreach循环

例子：

<ul> 
  #foreach ( $product in $allProducts ) 
    <li> $product </li> 
  #end 
</ul> 

每次循环$allProducts中的一个值都会赋给$product变量。 $allProducts可以是一个Vector、Hashtable或者Array。分配给$product的值是一个java对象，并且可以通过变量被引用。例如：如果$product是一个java的Product类，并且这个产品的名字可以通过调用他的getName（）方法得到。

现在我们假设$allProducts是一个Hashtable，如果你希望得到它的key应该像下面这样：

<ul> 
#foreach ( $key in $allProducts.keySet() ) 
<li>Key: $key -> Value: $allProducts.get($key) </li> 
#end 
</ul> 

Velocity还特别提供了得到循环次数的方法，以便你可以像下面这样作：

<table> 
#foreach ( $customer in $customerList ) 
<tr><td>$velocityCount</td><td>$customer.Name</td></tr> 
#end 
</table> 

$velocityCount变量的名字是Velocity默认的名字，你也可以通过修改velocity.properties文件来改变它。默认情况下，计数从“1”开始，但是你可以在velocity.properties设置它是从“1”还是从“0”开始。下面就是文件中的配置：

# Default name of loop counter 
# variable reference 
directive.foreach.counter.name = velocityCount 

# Default starting value of the loop 
# counter variable reference 
directive.foreach.counter.initial.value = 1 

Include

#include script element允许模板设计者引入本地文件。被引入文件的内容将不会通过模板引擎被render。为了安全的原因，被引入的本地文件只能在TEMPLATE_ROOT目录下。

#inclued ( “one.txt” )

如果您需要引入多个文件，可以用逗号分隔就行：

#include ( “one.gif”, “two.txt”, “three.htm” )

在括号内可以是文件名，但是更多的时候是使用变量的：

#inclue ( “greetings.txt”, $seasonalstock )

Parse

#parse script element允许模板设计者一个包含VTL的本地文件。Velocity将解析其中的VTL并render模板。

#parse( “me.vm” )

就像#include，#parse接受一个变量而不是一个模板。任何由#parse指向的模板都必须包含在TEMPLATE_ROOT目录下。与#include不同的是，#parse只能指定单个对象。你可以通过修改velocity.properties文件的parse_direcive.maxdepth的值来控制一个template可以包含的最多#parse的个数――默认值是10。#parse是可以递归调用的，例如：如果dofoo.vm包含如下行：

Count down. 
#set ( $count = 8 ) 
#parse ( “parsefoo.vm” ) 
All done with dofoo.vm! 

那么在parsefoo.vm模板中，你可以包含如下VTL：

$count 
#set ( $count = $count – 1 ) 
#if ( $count > 0 ) 
  #parse( “parsefoo.vm” ) 
#else 
  All done with parsefoo.vm! 
#end 

的显示结果为：

Count down. 









All done with parsefoo.vm! 
All done with dofoo.vm! 

Stop

#stop script element允许模板设计者停止执行模板引擎并返回。把它应用于debug是很有帮助的。

#stop

Velocimacros

#macro script element允许模板设计者定义一段可重用的VTL template。例如：

#macro ( d ) 
	<tr><td></td></tr> 
#end 

在上面的例子中Velocimacro被定义为d，然后你就可以在任何VTL directive中以如下方式调用它：

#d()

当你的template被调用时，Velocity将用<tr><td></td></tr>替换为#d()。每个Velocimacro可以拥有任意数量的参数――甚至0个参数，虽然定义时可以随意设置参数数量，但是调用这个Velocimacro时必须指定正确的参数。下面是一个拥有两个参数的Velocimacro，一个参数是color另一个参数是array：

#macro ( tablerows $color $somelist ) 
#foreach ( $something in $somelist ) 
	<tr><td bgcolor=$color>$something</td</tr> 
#end 
#end 

调用#tablerows Velocimacro：

#set ( $greatlakes = [ “Superior”, “Michigan”, “Huron”, “Erie”, “Ontario” ] ) 
#set ( $color = “blue” ) 
<table> 
	#tablerows( $color $greatlakes ) 
</table> 

经过以上的调用将产生如下的显示结果：

<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>

Velocimacros可以在Velocity模板内实现行内定义（inline），也就意味着同一个web site内的其他Velocity模板不可以获得Velocimacros的定义。定义一个可以被所有模板共享的Velocimacro显然是有很多好处的：它减少了在一大堆模板中重复定义的数量、节省了工作时间、减少了出错的几率、保证了单点修改。

上面定义的#tablerows( $color $list )Velocimacro被定义在一个Velocimacros模板库(在velocity.properties中定义)里，所以这个macro可以在任何规范的模板中被调用。它可以被多次应用并且可以应用于不同的目的。例如下面的调用：

#set ( $parts = [ “volva”, “stipe”, “annulus”, “gills”, “pileus” ] ) 
#set ( $cellbgcol = “#CC00FF” ) 
<table> 
	#tablerows( $cellbgcol $parts ) 
</table>

上面VTL将产生如下的输出：

<table> 
  <tr><td bgcolor=”#CC00FF”> volva </td</tr> 
  <tr><td bgcolor=”#CC00FF”> stipe </td</tr> 
  <tr><td bgcolor=”#CC00FF”> annulus </td</tr> 
  <tr><td bgcolor=”#CC00FF”> gills </td</tr> 
  <tr><td bgcolor=”#CC00FF”> pileus </td</tr> 
</table> 

Velocimacro arguments

Velocimacro可以使用以下任何元素作为参数：

Reference：任何以$开头的reference
String literal：
Number literal：
IntegerRange：[1….3]或者[$foo….$bar]
对象数组：[“a”,”b”,”c”]
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。

Naiteluo