所有标签功能都经过测试通过。
下载地址： http://sourceforge.net/projects/nvelocity/?source=recommended
一、NVelocity介绍
1.1Velocity是什么
nVelocity是一个基于.NET的模板引擎（templateengine）。它允许任何人仅仅简单的使用模板语言（templatelanguage）来引用由.NET代码定义的对象。
当nVelocity应用于web开发时，界面设计人员可以和.NET程序开发人员同步开发一个遵循MVC架构的web站点，也就是说，页面设计人员可以只关注页面的显示效果，而由.NET程序开发人员关注业务逻辑编码。nVelocity将.NET代码从web页面中分离出来，这样为web站点的长期维护提供了便利，同时也为我们在aspx之外又提供了一种可选的方案。
nVelocity的能力远不止web站点开发这个领域，例如，它可以从模板（template）产生SQL和PostScript、XML，它也可以被当作一个独立工具来产生源代码和报告，或者作为其他系统的集成组件使用。nVelocity也可以为很多web开发架构提供模板服务（templateservice）。我们的系统就提供一个模板服务的方式允许一个web应用以一个真正的MVC模型进行开发。
1.2nVelocity能为我们作什么？
1.1VTL(nVelocitytemplatelanguage)
VTL意味着提供最简单、最容易并且最整洁的方式合并页面动态内容。VTL使用references来在站点内嵌套动态内容，一个变量就是一种类型的reference。变量是某种类型的reference，它可以指向.NET代码中的定义，或者从当前页面内定义的VTLstatement得到值。下面是一个VTLstatement的例子，它可以被嵌套到HTML代码中：
|
1
|
#
set
($a=
"Velocity"
)
|
和所有的VTLstatement一样，这个statement以＃字符开始并且包含一个directive：set。当一个在线用户请求你的页面时，nVelocityTemplateEngine将查询整个页面以便发现所有＃字符，然后确定哪些是VTLstatement，哪些不需要VTL作任何事情。
#字符后紧跟一个directive：set时，这个setdirective使用一个表达式（使用括号封闭）将一个值设置给变量。变量被列在左边，而它的值被列在右边，最后他们之间使用＝号分割。
在上面的例子中，变量是$a，而它的值是Velocity。和其他的references一样以$字符开始，而值总是以双引号封闭。Velocity中仅有String可以被赋值给变量。
记住以下的规则：
使用$字符开始的references用于得到什么；使用#字符开始的directives用于作些什么
1.2HellonVelocityWorld
一旦某个变量被分配了一个值，那么你就可以在HTML文件的任何地方引用它。在下面的例子中，一个值被分配给$foo变量，并在其后被引用。
|
1
2
|
#
set
($foo=
"nVelocity"
)
Hello$fooWorld!
|
上面的实现结果是在页面上打印"HellonVelocityWorld！"
为了使包含VTLdirectives的statement更具有可读性，我们鼓励你在新行开始一个VTLstatement，尽管你不是必须这么作。Setdirective将在后面详细描述。
1.1注释
单行注释：
|
1
|
##Thisisasinglelinecomment.
|
多行注释：
|
1
2
3
4
|
#*
Thusbeginsamulti-linecomment.Onlinevisitorswon’t
seethistextbecausetheVelocityTemplateEnginewillignoreit.
*#
|
文档格式：
|
1
2
3
4
5
6
7
|
#**
ThisisaVTLcommentblockandmaybeusedtostoresuchinformationasthedocumentauthor
andversioninginformation:
@version5
@author
*#
|
1.2References
在VTL中有三种类型的references：变量(variables)、属性(properties)、方法(methods)。作为一个使用VTL的页面设计者，你和你的工程师必须就references的名称达成共识，以便你可以在你的template中使用它们。
VTL中一切reference可以作为一个String对象处理。如果有一个对象$foo是一个Integer对象，那么Velocity将调用它的toString()方法将这个对象转型为String类型。
1.2.1变量格式要求同.NET。
1.1.1属性例子：
|
1
2
|
$customer.Address
$purchase.Total
|
$customer.Address有两种含义。它可以表示：查找hashtable对象customer中以Address为关键字的值；也可以表示调用customer对象的Address()方法。当你的页面被请求时，Velocity将确定以上两种方式选用那种，然后返回适当的值。
1.1.2方法一个方法就是被定义在.NET中的一段代码，并且它有完成某些有用工作的能力，例如一个执行计算和判断条件是否成立、满足等。方法是一个由$开始并跟随VTL标识符组成的References，一般还包括一个VTL方法体。例如：
|
1
2
3
4
|
$customer.Address()
$purchase.Total()
$page.setTitle(
"MyHomePage"
)
$person.setAttributes([
"Strange"
,
"Weird"
,
"Excited"
])
|
前两个例子$customer.Address()和$purchase.Total()看起来挺想上面的属性$customer.Address和$purchase.Total。如果你觉得他们之间有某种联系的话，那你是正确的。
VTL属性可以作为VTL方法的缩写。$customer.Address属性和使用$customer.Address()方法具有相同的效果。如果可能的话使用属性的方式是比较合理的。属性和方法的不同点在于你能够给一个方法指定一个参数列表。
1.1.1正式reference标记reference的正式格式如下：
|
1
2
3
|
${mudSlinger}
//变量
${customer.Address}
//属性
${purchase.Total()}
//方法
|
非正式格式更见常用，但是有时还是使用正是格式比较适合。例如：你希望通过一个变量$vice来动态的组织一个字符串。
|
1
|
Jackisa$vicemaniac.
|
本来变量是$vice现在却变成了$vicemaniac，这样Veloctiy就不知道您到底要什么了。所以，应该使用正是格式书写
|
1
|
Jackisa${vice}maniac
|
现在Velocity知道变量是$vice而不是$vicemaniac。
1.1.2Quietreferencenotation
例如：
|
1
|
<
inputtype
=
"text"
name
=
"email"
value
=
"$email"
/>
|
当页面的form被初始加载时，变量$email还没有值，这时你肯定是希望它能够显示一个空白来代替输出"$email"这样的字段。那么使用quietreferencenotation就比较合适。
|
1
|
<inputtype=
"text"
name=
"email"
value=
"$!email"
/>
|
这样文本框的初始值就不会是email而是空值了。
正式和quiet格式的referencenotation也可一同使用，像下面这样：
|
1
|
<inputtype=
"text"
name=
"email"
value=
"$!{email}"
/>
|
1.1.1Gettingliteral
nVelocity使用特殊字符$和#来帮助它工作，所以如果要在template里使用这些特殊字符要格外小心。本节将讨论$字符。
在VTL中使用$2.5这样的货币标识是没有问题得的，VTL不会将它错认为是一个reference，因为VTL中的reference总是以一个大写或者小写的字母开始。
VTL中使用"\"作为转义字符。
注意：VTL中未被定义的变量将被认为是一个字符串，所以以下例子：
|
1
2
|
#
set
($foo=
"gibbous"
)
$moon=$foo
|
输出结果是：
|
1
|
$moon=gibbous
|
1.1.1赋值#set
#setdirective被用于设置一个reference的值。例如：
|
1
2
|
#
set
($primate=
"monkey"
)
#
set
($customer.Behavior=$primate)
|
赋值左侧的（LHS）必须是一个变量或者属性reference。右侧（RHS）可以是以下类型中一种：
变量reference
字符串
属性reference
方法reference
数字
ArrayList
下面是应用各种类型的RHS的例子：
|
1
2
3
4
5
6
|
#
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也可以是一个简单的算术表达式：
|
1
2
3
4
5
|
#
set
($value=$foo+
1
)
#
set
($value=$bar-
1
)
//(减号前必须有空格)
#
set
($value=$foo*$bar)
#
set
($value=$foo/$bar)
#
set
($value=$foo%$bar)
|
如果你的RHS是一个null，VTL的处理将比较特殊：它将指向一个已经存在的reference，这对初学者来讲可能是比较费解的。例如：
|
1
|
#
set
($resut=$query.criteria(
"name"
))
|
结果是$result
|
1
|
#
set
($resut=$query.criteria(
"address"
))
|
结果是$result
如果$query.criteria("name")返回一个"bill"，而$query.criteria("address")返回的是null，则显示的结果如下：
结果是bill
看看下面的例子：
|
1
2
3
4
5
6
7
|
#
set
($criteria=[
"name"
,
"address"
])
#foreach($criterionin$criteria)
#
set
($result=$query.criteria($criterion))
#
if
($result)
Querywassuccessful
#end
#end
|
在上面的例子中，程序将不能智能的根据$result的值决定查询是否成功。在$result被#set后（addedtothecontext），它不能被设置回null（removedfromthecontext）。打印的结果将显示两次查询结果都成功了，但是实际上有一个查询是失败的。
为了解决以上问题我们可以通过预先定义的方式：
|
1
2
3
4
5
6
7
8
|
#
set
($criteria=[
"name"
,
"address"
])
#foreach($criterionin$criteria)
#
set
($result=
false
)
#
set
($result=$query.criteria($criterion))
#
if
($result)
Querywassuccessful
#end
#end
|
1.1.1字符串
当你使用#setdirective，字符串封闭在一对双引号内。
|
1
2
3
4
|
#
set
($directoryRoot=
"www"
)
#
set
($templateName=
"index.vm"
)
#
set
($template=
"$directoryRoot/$tempateName"
)
$template
|
上面这段代码的输出结果为：
|
1
|
www/index.vm
|
但是，当字符串被封装在单引号内时，它将不被解析：
|
1
2
3
|
#
set
($foo=
"bar"
)
$foo
#
set
($blargh=
'$foo'
)
|
结果：
|
1
2
|
bar
$foo
|
1.1.2条件语句
|
1
|
if
/elseif/
else
|
当一个web页面被生成时使用Velocity的#ifdirectrive，如果条件成立的话可以在页面内嵌入文字。例如：
|
1
2
3
|
#
if
($foo)
<strong>nVelocity!</strong>
#end
|
上例中的条件语句将在以下两种条件下成立：
$foo是一个boolean型的变量，且它的值为true
$foo变量的值不为null
这里需要注意一点：Velocitycontext仅仅能够包含对象，所以当我们说"boolean"时实际上代表的时一个Boolean对象。即便某个方法返回的是一个boolean值，Velocity也会利用内省机制将它转换为一个Boolean的相同值。
如果条件成立，那么#if和#end之间的内容将被显示。
#elseif和#else元素可以同#if一同使用。例如：
|
1
2
3
4
5
6
7
8
9
|
#
if
($foo<
10
)
<strong>GoNorth</strong>
#elseif($foo==
10
)
<strong>GoEast</strong>
#elseif($foo==
6
)
<strong>GoSouth</strong>
#
else
<strong>GoWest</strong>
#end
|
注意这里的nVelocity的数字是作为Integer来比较的――其他类型的对象将使得条件为false，它使用"＝＝"来比较两个值，而且nVelocity要求等号两边的值类型相同。
二、NVelocity标签语详解
1.变量
(1)变量的定义：
#set($name="hello")说明：velocity中变量是弱类型的。
当使用#set指令时，括在双引号中的字面字符串将解析和重新解释，如下所示：
|
1
2
3
4
|
#
set
($directoryRoot=
"www"
)
#
set
($templateName=
"index.vm"
)
#
set
($template=
"$directoryRoot/$templateName"
)
$template
|
输出将会是：
|
1
|
www/index.vm
|
注：在velocity中使用$2.5这样的货币标识是没有问题得的，因为velocity中的变量总是以一个大写或者小写的字母开始的。
(2)变量规范的写法
${name}，也可以写成：$name。提倡用前面的写法。
(3)变量的赋值:
|
1
|
$name=
"hello"
|
赋值的左边必须是一个变量或者是属性引用。右边可以是下面六种类型之一：
变量引用,字面字符串,属性引用,方法引用,字面数字,数组列表。
#set($monkeySay=["Not",$my,"fault"])##ArrayList
通过索引取值方法：$monkeySay.get_item(0)
2.循环
例子：
|
1
2
3
4
5
|
#
set
($list=[
"pine"
,
"oak"
,
"maple"
])
#foreach($elementin$list)
$element index
is
$velocityCount
This
is
$element.<br>
#end
|
输出的结果为：
|
1
2
3
|
1pineis1.
2oakis2.
3mapleis3.
|
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
//集合数据
List<
object
> users =
new
List<
object
>()
{
new
{Name =
"张三"
, age=20},
new
{Name =
"李四"
, age=24},
new
{Name =
"王五"
, age=30}
};
vc.Put(
"dtdataist"
,users);
调用：
#foreach($Item in $dtdataist)
$Item.name</br>
$Item.age</br>
#end
System.Data.DataTable userTable =
new
System.Data.DataTable();
userTable.Columns.Add(
"Name"
,
typeof
(
string
));
userTable.Columns.Add(
"Age"
,
typeof
(
int
));
userTable.Rows.Add(
"张三"
, 20);
userTable.Rows.Add(
"李四"
, 24);
userTable.Rows.Add(
"王五"
, 30);
vc.Put(
"dtdataist"
,userTable);
|
调用：
|
1
2
3
4
|
#foreach($Item
in
$dtdataist.Rows)
$Item.name</br>
$Item.age</br>
#end
|
|
1
2
3
4
5
6
7
|
//字典
//注: 进入foreach循环后的数据是KeyValuePair<T,T>对象.所以模板里是通过Key与Value属性取得键与值.
Dictionary<string,
int
> userDict =
new
Dictionary<string,
int
>();
userDict.Add(
"name"
,
20
);
userDict.Add(
"李四"
,
24
);
userDict.Add(
"王五"
,
30
);
vc.Put(
"dtdataist"
,userDict);
|
调用：
|
1
|
$dtSubSortList.name
|
|
1
2
3
4
5
6
7
|
//数组
object
[] userArray =
new
object
[]{
new
{Name =
"张三"
, age=20},
new
{Name =
"李四"
, age=24},
new
{Name =
"王五"
, age=30}
};
vc.Put(
"dtdataist"
, userArray);
|
调用：
|
1
2
3
4
|
#foreach($Item
in
$dtdataist)
$Item.name</br>
$Item.age</br>
#end
|
支持加载对象多级属性调用 如：
|
1
|
vc.Put(
"monkey"
,
new
{ Say =
new
string[] {
"Not"
,
"Yes"
,
"fault"
} });
|
调用：
|
1
|
$monkey.Say.get_item(
0
)
|
显示：
|
1
|
Not
|
支持加载多个对象数组 如：
|
1
2
|
#
set
($tdata=[[
"Name:王风"
,
"age:100"
],[
"Name:wangfeng"
,
"age:100"
]])
$tdata.get_item(
0
).Name
|
显示：王风
|
1
2
|
#
set
($tdataa=[[
"Name王志康"
,
"age100"
],[
"Namewangfeng"
,
"age100"
]])
$tdataa.get_item(
0
).get_item(
1
)
|
显示:age100
提示：velocity中大小写敏感,不支持属性为汉字 如:$dtdataList.张三。
Velocity还特别提供了得到循环次数的方法，$velocityCount变量的名字是Velocity默认的名字。
这样可以通过$velocityCount%2==0 判断奇数偶数行。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
each
($data
in
$datas)
#before
this
before</br> #before--数据的开始处
#odd
$data
is
odd</br>#odd--数据的奇数处
#even
$data
is
even</br>#even--数据的偶数处
#
each
$data
is
even</br>#
each
--可以循环美行数据
#between
this
is
between</br>每行数据的间隔处，如：
1
-
2
之间，
2
-
3
之间。
#after
after</br>--#after数据的结束处
#end
|
3. 条件语句
|
1
2
3
4
|
#
if
(condition)
#elseif (condition)
#
else
#end
|
4. 语句的嵌套
|
1
2
3
4
5
6
7
8
9
10
|
#foreach ($element
in
$list)
## inner foreach 内循环
#foreach ($element
in
$list)
This
is
$element. $velocityCount <br>inner<br>
#end
## inner foreach 内循环结束
## outer foreach
This
is
$element.
$velocityCount <br>outer<br>
#end
|
语句中也可以嵌套其他的语句，如#if…#else…#end等。
5. 关系和逻辑操作符
Velocity 也具有逻辑AND, OR 和 NOT 操作符。
如
|
1
2
3
4
5
6
7
8
9
10
11
12
|
## example
for
AND
#
if
($foo && $bar)
<strong> This AND that</strong>
#end
## example
for
OR
#
if
($foo || $bar)
<strong> This OR that</strong>
#end
## example
for
NOT
#
if
(!$foo)
<strong> This NOTthat</strong>
#end
|
例子中#if() 指令仅在$foo 和$bar 斗为真的时候才为真。如果$foo 为假，则表达式也为假；并且 $bar 将不被求值。如果 $foo 为真，Velocity 模板引擎将继续检查$bar的值，如果 $bar 为真，则整个表达式为真。并且输出This AND that 。如果 $bar 为假，将没有输出因为整个表达式为假。
6.Velocity 中的宏
Velocity中的宏我们可以理解为函数。
①宏的定义
|
1
2
3
|
#macro(宏的名称 $参数
1
$参数
2
…)
语句体(即函数体)
#end
|
②宏的调用
|
1
|
#宏的名称($参数
1
$参数
2
…)
|
说明：参数之间用空格隔开。
7．#stop
停止执行模板引擎并返回,把它应用于debug是很有帮助的。
8．#include与#parse
#include和#parse的作用都是引入本地文件, 为了安全的原因，被引入的本地文件只能在TEMPLATE_ROOT目录下。
区别：
(1) 与#include不同的是，#parse只能指定单个对象。而#include可以有多个
如果您需要引入多个文件，可以用逗号分隔就行：
|
1
|
#
include
(
"template/one.gif"
"template/two.txt"
"template/three.htm"
)
|
在括号内可以是文件名，但是更多的时候是使用变量的：
|
1
2
|
#
set
($seasonalstock =
"template/test.htm"
)
#
include
(
"template/greetings.txt"
$seasonalstock)
//(注意中间没有分隔符)
|
(2) #include被引入文件的内容将不会通过模板引擎解析；
而#parse引入的文件内容Velocity将解析其中的velocity语法并移交给模板，意思就是说相当与把引入的文件copy到文件中。
#parse是可以递归调用的，例如：如果dofoo.vm包含如下行：
|
1
2
3
4
|
Count down.<br>
#
set
($count =
8
)
#parse (
"parsefoo.vm"
)
<br>All done
with
dofoo.vm!
|
那么在parsefoo.vm模板中，你可以包含如下VTL：
|
1
2
3
4
5
6
7
|
$count
#
set
($count = $count -
1
)
#
if
( $count >
0
)<br>
#parse(
"parsefoo.vm"
)
#
else
<br>All done
with
parsefoo.vm!
#end
|
显示结果为：
|
1
2
3
4
5
6
7
8
9
10
11
12
|
Count down.
8
7
6
5
4
3
2
1
0
All done
with
parsefoo.vm!
All done
with
dofoo.vm!
|
注意：在vm中使用#parse来嵌套另外一个vm时的变量共享问题。如：
->a.vm 里嵌套 b.vm；
->a.vm 里定义了变量 $param；
->b.vm 里可以直接使用$param，无任何限制。
但需要特别注意的是，如果b.vm里同时定义有变量$param，则b.vm里将使用b.vm里定义的值。
9．转义字符'\'的使用
如果reference被定义，两个’\’意味着输出一个’\’，如果未被定义，刚按原样输出。如：
|
1
2
3
4
5
|
#
set
($email =
"foo"
)
$email
\$email
\\$email
\\\$email
|
输出：
|
1
2
3
4
|
foo
$email
\foo
\$email
|
如果$email 未定义
|
1
2
3
4
|
$email
\$email
\\$email
\\\$email
|
输出：
|
1
2
3
4
|
$email
\$email
\\$email
\\$email
|
11．内置对象
Velocity内置了一些对象，在vm模版里可以直接调用，列举如下：
$request、$response、$session,目前还不清楚怎么调用。
12. 方法调用
|
1
2
3
4
5
6
7
8
9
10
11
12
|
public
class
Tool
{
public
string ConvertToString(string source)
{
return
html +
"_convert"
;
}
public
static
string C2()
{
return
"test"
+
"_c2"
;
}
}
vc.Put(
"toolobj"
, tool);
|
调用方法：
|
1
2
|
$toolobj.ConvertHtml(
"123456"
);
$toolobj.C2();
|
多参数方法调用
|
1
2
3
4
|
public
static
string SomeMethod(params
String
[] args)
{
return
String
.Join(
'-'
, args);
}
|
调用方法：
|
1
|
$instance.SomeMethod(
'arg1'
,
'arg2'
)
|
模版文件调用方法，详见：.Net之NVelocity的三种用法
原文地址： http://www.trendzu.com/csharp/24.html
3800
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
