Velocity 文档(1)

来源：互联网发布：汉朝罗马知乎编辑：程序博客网时间：2024/05/16 07:32

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能为我们做什么？

        假设你是一家专门出售Mud的在线商店的页面设计人员，让我们暂且称它为“在线MUD商店”。你们的业务很旺，客户下了各种类型和数量的mud订单。他们都是通过输入用户名和密码后才登陆到你的网站，登陆后就允许他们查看订单并购买更多的mud。现在，一种非常流行的mud正在打折销售。另外有一些客户规律性的购买另外一种也在打折但是不是很流行的Bright Red Mud，由于购买的人并不多所以它被安置在页面的边缘。所有用户的信息都是被跟踪并存放于数据库中的，所以某天有一个问题可能会冒出来：为什么不使用velocity来使用户更好的浏览他们感兴趣的商品呢？
        Velocity使得web页面的个性化工作非常容易。作为一个web site的设计人员，你希望每个用户登陆时都拥有自己的页面。你会见了一些公司内的软件工程师，你发现他们每个人都同意客户应该拥有具有个性化的信息。那让我们把软件工程师应该作的事情发在一边，看一看你应该作些什么吧。
你可能在页面内嵌套如下的VTL声明：

01<html>
02    <body>
03        Hello $customer.Name!
04        <table>
05            #foreach( $mud in $nudsOnSpecial )
06               #if ( $customer.hasPurchased( $mud ) )
07               <tr>
08                   <td>$flogger.getPromo( $mud )</td>
09               </tr>
10               #end
11            #end
12         </table>
13    </body>
14</html>

Velocity Template Language(VTL)介绍
VTL意味着提供最简单、最容易并且最整洁的方式合并页面动态内容。
VTL使用引用（references）来在web site内嵌套动态内容。一个变量就是一种类型的reference。变量是某种类型的refreence。它可以指向java代码中定义的对象，或者在当前页面内使用VTL statement定义的变量。下面是一个VTL statement的例子，它可以被嵌套到HTML代码中：

1#set ( $a = “Velocity” )

和所有的VTL statement一样，这个statement以＃字符开始并且包含一个directive：set。当一个在线用户请求你的页面时，Velocity Templating Engine将查询整个页面以便发现所有＃字符，然后确定哪些是VTL statement，哪些不需要VTL作任何事情。＃字符后紧跟一个directive：set时，这个set directive 使用一个表达式（使用一对圆括号`(` , `)` 封闭）分配一个值给变量$a。变量被列在左边，而它的值被列在右边，最后他们之间使用＝号分割。

记住以下的规则：使用$字符开始的references用于得到什么；使用#字符开始的directives用于作些什么。

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

1<html>
2    <body>
3        #set ( $foo = “Velocity” )
4        Hello $foo World!
5    </body>
6</html>

上面的实现结果是在页面上打印“Hello Velocity World！”

为了使包含VTL directives的statement更具有可读性，我们建议在新行开始每个VTL statement，尽管你不是必须这么作。Set directive将在后面详细描述。

注释

单行注释：

1## This is a single line comment.

多行注释：

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

文档格式：

1#**
2   This is a VTL comment block and
3   may be used to store such information
4as the document author and versioning
5   information:
6   @version 5
7   @author
8  *#

References

在VTL中有三种类型的references：变量(variables)、属性(properties)、方法(methods)。

作为一个使用VTL的页面设计者，你和你的工程师必须就references的名称达成共识，以便你可以在你的template中使用它们。

        Everything coming to and from a reference被作为一个String对象处理。如果有一个对象$foo是一个Integer对象，那么Velocity将调用它的toString()方法将这个对象转型为String类型。
    变量
格式要求同java。
    属性
例子：

1$customer.Address
2$purchase.Total

其中$customer.Address有两种含义。它既可以表示查找hashtable对象customer中以Address为关键字的值，也可以表示调用customer对象的getAddress()方法。当你的页面被请求时，Velocity将确定以上两种方式选用那种，然后返回适当的值。

方法

一个方法就是被定义在java中的一段代码，并且它有完成某些有用工作的能力，例如一个执行计算和判断条件是否成立、满足等。方法是一个由$开始并跟随VTL标识符组成的References，一般还包括一个VTL方法体。例如：

1$customer.getAddress()
2$purchase.getTotal()
3$page.setTitle( “My Home Page” )
4$person.setAttributes( [“Strange”, “Weird”, “Excited”] )

前两个例子$customer.getAddress()和$purchase.getTotal()看起来挺想上面的属性$customer.Address 和 $purchase.Total。如果你觉得他们之间有某种联系的话，那你是正确的；因为VTL属性可以作为VTL方法的缩写。$customer.Address属性和使用$customer.getAddress()方法具有相同的效果。如果可能的话使用属性的方式是比较合理的。属性和方法的不同点在于你能够给一个方法指定一个参数列表。

Velocity利用了很多java规范以方便了设计人员的使用。例如

$foo.getBar() 等同于 $foo.Bar 等同于 ${foo.Bar}
$data.getUser(“jon”) 等同于 $data.User(“jon”) 等同于 ${data.User("join")}
$data.getRequest().getServerName() 等同于 $data.Request.ServerName 等同于 ${data.Request.ServerName}

需要明确的是VTL中不会将reference解释为对象的实例变量。例如：$foo.Name将被解释为Foo对象的getName（）方法（假如$foo所引用的对象不是Hashtale对象），而不是Foo对象的Name实例变量。

正式reference标记

reference的正是格式如下：

1${mudSlinger}        ##变量
2${customer.Address}    ##属性
3${purchase.getTotal()}    ##方法

但非正式格式更常见，但是有时还是使用正式格式比较好。例如：你希望通过一个变量$vice来动态的组织一个字符串:

1Jack is a $vicemaniac.

本来用意是是引用变量$vice，现在却变成了$vicemaniac，这样Veloctiy就不知道您到底要什么了。所以在这种情况下应该使用正式格式书写:

1Jack is a ${vice}maniac

现在Velocity知道你希望引用的变量是$vice而不是$vicemaniac，模板被渲染后的结果为：
Quiet reference notation

关于空值(null)的处理

当一个变量没有被定义或为空值（null) , velocity模板会将该变量名连同美元符号一起输出。考虑如下的html片段:

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

当页面的form被初始加载时，变量$email还没有值，这时你肯定是希望它能够显示一个空字符串("")来代替$email这样的字符串，那么就需要使用quiet reference notation，即$!标记

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

当然使用正式的quiet格式会更好：

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

关于特殊字符的处理
        Velocity使用特殊字符$和#来帮助它工作，所以如果要在template里使用这些特殊字符要格外小心。
        在VTL中，像$2.5这样的标识符不会被认为是一个reference，因为VTL中的reference总是以一个大写或者小写的字母开始.
        VTL中使用“\”作为转义符。
        例如：

1#set( $email = “foo” )
2$email
3\$email
4\\$email
5\\\$email

将被渲染为：
  foo
  $email
  \foo
  \\$email
如果email变量没有被定义则

1$email
2\$email
3\\$email
4\\\$email

将被渲染为:
  $email
  \$email
  \\$email
  \\\$email

指令（Directives）
      reference允许设计者使用动态的内容，而directive使得你可以控制显示逻辑，从而达到期望的显示效果。
          #set 指令
        #set directive被用于设置一个reference的值。例如：

1#set ( $primate = “monkey” )
2#set ( $customer.Behavior = $primate )

赋值左侧的（LHS）必须是一个变量或者属性reference。右侧（RHS）可以是以下类型中一种：
变量引用(variable reference）
字符串字面值（String literal）
属性引用(property reference)
方法调用(method reference)
数字字面值（ number literal)
数组列表(Array List)
下面是应用各种类型的RHS的例子：

1＃set ( $monkey = $bill )                 ## 变量引用(variable reference）
2＃set ( $monkey.Friend = “monica” )       ##字符串字面值（String literal）
3＃set ( $monkey.Blame = $whitehouse.Leak )## 属性引用(property reference)
4＃set ( $monkey.Plan = $spindoctor.weave($web) )##方法调用(method reference)
5＃set ( $monkey.Number = 123 )                    ## 数字字面值（ number literal)
6＃set ( $monkey.Say = [“Not”, $my, “fault”] )        ##数组列表(Array List)

注意：最后一个例子的取值方法为：$monkey.Say.get(0)
RHS也可以是一个简单的算术表达式：

1#set ( $value = $foo + 1 )
2#set ( $value = $bar -1 )
3#set ( $value = $foo * $bar )
4#set ( $value = $foo / $bar )

如果你的RHS是一个null，VTL的处理将比较特殊：它将指向一个已经存在的reference，这对初学者来讲可能是比较费解的。例如：

1#set ( $resut = $query.criteria(“name”) )
2The result of the first query is $result
3#set ( $resut = $query.criteria(“address”) )
4The 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
再看一个例子：

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

打印的结果将显示两次查询结果都成功了。

为什么会出现这种现象呢？其实当某个变量被赋值后，它就被保存到Velocity的context(added to the context)，并且buhui不能被设置回null（removed from the context）。

为了解决以上问题我们可以通过预先定义的方式：

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

关于字符串字面值（String Literals ）
当你使用#set 指令时，如果把字符串字面值(String literal)封闭在一对双引号内, 比如

1#set ( $directoryRoot = “www” )
2#set ( $templateName = “index.vm” )
3#set ( $template = “$directoryRoot/$tempateName” )
4$template

则渲染的结果为

www/index.vm

但是，当字符串字面值（String Literal）被封装在单引号内时，它将不被解析：

1#set ( $foo = “bar” )
2$foo
3#set ( $blargh = ‘$foo’ )
4$blargh

结果：
bar
$foo

这个特性可以通过修改velocity.properties文件的属性设置

stringliterals.interpolate = false

来改变上面的特性失效。

原文链接：http://my.oschina.net/aiguozhe/blog/39553

0 0