NVelocity用法 Net版(完全整理)

 

原文：http://www.cnblogs.com/skykang/archive/2011/01/10/1931962.html

本文采用NVelocity 1.1.1最新版 下载地址http://sourceforge.net/projects/castleproject/files/NVelocity/1.1/CastleNVelocity-1.1.1.zip/download。

所有标签功能都经过测试通过。

一、NVelocity介绍
1.1 Velocity是什么
nVelocity是一个基于.NET的模板引擎（template engine）。它允许任何人仅仅简单的使用模板语言（template language）来引用由.NET代码定义的对象。
当nVelocity 应用于web开发时，界面设计人员可以和.NET程序开发人员同步开发一个遵循MVC架构的web站点，也就是说，页面设计人员可以只关注页面的显示效果，而由.NET程序开发人员关注业务逻辑编码。nVelocity将.NET代码从web页面中分离出来，这样为web站点的长期维护提供了便利，同时也为我们在aspx之外又提供了一种可选的方案。
nVelocity的能力远不止web站点开发这个领域，例如，它可以从模板（template）产生SQL和PostScript、XML，它也可以被当作一个独立工具来产生源代码和报告，或者作为其他系统的集成组件使用。nVelocity也可以为很多web开发架构提供模板服务（template service）。我们的系统就提供一个模板服务的方式允许一个web应用以一个真正的MVC模型进行开发。

1.2 nVelocity能为我们作什么？

1.1 VTL (nVelocity template language)
VTL意味着提供最简单、最容易并且最整洁的方式合并页面动态内容。 VTL 使用references来在站点内嵌套动态内容，一个变量就是一种类型的reference。变量是某种类型的reference，它可以指向.NET代码中的定义，或者从当前页面内定义的VTL statement得到值。下面是一个VTL statement的例子，它可以被嵌套到 HTML代码中：

#set ( $a = “Velocity” )
和所有的VTL statement一样，这个statement以＃字符开始并且包含一个directive：set。当一个在线用户请求你的页面时，nVelocity Template Engine将查询整个页面以便发现所有＃字符，然后确定哪些是VTL statement，哪些不需要VTL 作任何事情。
#字符后紧跟一个directive：set时，这个set directive使用一个表达式（使用括号封闭）将一个值设置给变量。变量被列在左边，而它的值被列在右边，最后他们之间使用＝号分割。
在上面的例子中，变量是$a，而它的值是Velocity。和其他的references一样以$字符开始，而值总是以双引号封闭。Velocity中仅有String可以被赋值给变量。
记住以下的规则：
使用$字符开始的references用于得到什么；使用#字符开始的directives用于作些什么
1.2 Hello nVelocity World
一旦某个变量被分配了一个值，那么你就可以在HTML文件的任何地方引用它。在下面的例子中，一个值被分配给$foo变量，并在其后被引用。
#set ( $foo = “nVelocity” )
Hello $foo World!

上面的实现结果是在页面上打印“Hello nVelocity World！”
为了使包含VTL directives的statement更具有可读性，我们鼓励你在新行开始一个VTL statement，尽管你不是必须这么作。Set directive将在后面详细描述。

1.1 注释
单行注释：
## This is a single line comment.
多行注释：
#*
Thus begins a multi-line comment. Online visitors won’t
see this text because the Velocity Template 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
*#
1.2 References
在VTL中有三种类型的references：变量(variables)、属性(properties)、方法 (methods)。作为一个使用VTL的页面设计者，你和你的工程师必须就references的名称达成共识，以便你可以在你的template中使用它们。

VTL中一切reference可以作为一个String对象处理。如果有一个对象$foo是一个Integer对象，那么Velocity将调用它的toString()方法将这个对象转型为String类型。

1.2.1 变量格式要求同.NET。

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

1.1.2 方法一个方法就是被定义在.NET中的一段代码，并且它有完成某些有用工作的能力，例如一个执行计算和判断条件是否成立、满足等。方法是一个由$开始并跟随VTL标识符组成的References，一般还包括一个VTL方法体。例如：
$customer.Address()
$purchase.Total()
$page.setTitle( “My Home Page” )
$person.setAttributes( [“Strange”, “Weird”, “Excited”] )
前两个例子$customer.Address()和$purchase.Total()看起来挺想上面的属性$customer.Address 和 $purchase.Total。如果你觉得他们之间有某种联系的话，那你是正确的。

VTL属性可以作为VTL方法的缩写。$customer.Address属性和使用$customer.Address()方法具有相同的效果。如果可能的话使用属性的方式是比较合理的。属性和方法的不同点在于你能够给一个方法指定一个参数列表。

1.1.1 正式reference标记reference的正式格式如下：
${mudSlinger}变量
${customer.Address}属性
${purchase.Total()}方法
非正式格式更见常用，但是有时还是使用正是格式比较适合。例如：你希望通过一个变量$vice来动态的组织一个字符串。

Jack is a $vicemaniac.
本来变量是$vice现在却变成了$vicemaniac，这样Veloctiy就不知道您到底要什么了。所以，应该使用正是格式书写
Jack is a ${vice}maniac
现在Velocity知道变量是$vice而不是$vicemaniac。

1.1.2 Quiet reference notation

例如：

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

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

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

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

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

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

1.1.1 Getting literal

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

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

VTL中使用“\”作为转义字符。

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

#set( $foo = “gibbous” )

$moon = $foo

的输出结果是：

$moon = gibbous

1.1.1 赋值#set

#set directive被用于设置一个reference的值。例如：

#set ( $primate = “monkey” )

#set ( $customer.Behavior = $primate )

赋值左侧的（LHS）必须是一个变量或者属性reference。右侧（RHS）可以是以下类型中一种：

变量reference

字符串

属性reference

方法reference

数字

ArrayList

 

下面是应用各种类型的RHS的例子：

#set ( $monkey = $bill ) ##变量reference

#set ( $monkeyFriend = “monica” ) ##字符串

#set ( $monkeyBlame = $whitehouse.Leak ) ##属性reference

#set ( $monkeyPlan = $spindoctor.weave($web) ) ##方法reference

#set ( $monkeyNumber = 123 ) ##数字

#set ( $monkeySay = [“Not”, $my, “fault”] ) ##ArrayList

注意：最后一个例子的取值方法为：$monkeySay.get_item(0)

RHS也可以是一个简单的算术表达式：

#set ( $value = $foo + 1 )

#set ( $value = $bar -1 ) (减号前必须有空格)

#set ( $value = $foo * $bar )

#set ( $value = $foo / $bar )

#set ( $value = $foo % $bar )

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

#set ( $resut = $query.criteria(“name”) )

结果是$result

#set ( $resut = $query.criteria(“address”) )

结果是$result

如果$query.criteria(“name”)返回一个“bill”，而$query.criteria(“address”)返回的是null，则显示的结果如下：

结果是bill

看看下面的例子：

#set( $criteria = ["name", "address"] )

#foreach( $criterion in $criteria )