NVelocity用法 Net版(完全整理)

时间：2022-11-17 16:40:12

一、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 )

#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

1.1.1 字符串

  当你使用#set directive，字符串封闭在一对双引号内。

#set ( $directoryRoot = “www” )

#set ( $templateName = “index.vm” )

#set ( $template = “$directoryRoot/$tempateName” )

$template

上面这段代码的输出结果为：www/index.vm

但是，当字符串被封装在单引号内时，它将不被解析：

#set ( $foo = “bar” )

$foo

#set ( $blargh = ‘$foo' )

结果：

bar

$foo

1.1.2 条件语句

 

if/elseif/else

当一个web页面被生成时使用Velocity的#if directrive，如果条件成立的话可以在页面内嵌入文字。例如：

#if ( $foo )

<strong>nVelocity!</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

注意这里的nVelocity的数字是作为Integer来比较的――其他类型的对象将使得条件为false，它使用“＝＝”来比较两个值，而且nVelocity要求等号两边的值类型相同。
二、NVelocity标签语详解

1. 变量
   (1) 变量的定义：
   #set($name = "hello") 说明：velocity中变量是弱类型的。
   当使用#set 指令时，括在双引号中的字面字符串将解析和重新解释，如下所示：
   #set($directoryRoot = "www" )
   #set($templateName = "index.vm" )
   #set($template = "$directoryRoot/$templateName" )
   $template
  输出将会是：www/index.vm
  注：在velocity中使用$2.5这样的货币标识是没有问题得的，因为velocity中的变量总是以一个大写或者小写的字母开始的。

 (2) 变量规范的写法
      ${name} ，也可以写成：$name。提倡用前面的写法。

(3) 变量的赋值:  
       $name="hello"
       赋值的左边必须是一个变量或者是属性引用。右边可以是下面六种类型之一：
       变量引用,字面字符串,属性引用,方法引用,字面数字,数组列表。

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

   通过索引取值方法：$monkeySay.get_item(0)

 2. 循环
　　　例子：

 #set( $list = ["pine", "oak", "maple"])
    #foreach ($element in $list)
     $element index is $velocityCount
     This is $element.<br>
     #end
    输出的结果为：
    1 pine is 1.
    2 oak is 2.
    3 maple is 3.

 

NVelocity用法 Net版(完全整理)NVelocity用法 Net版(完全整理) 代码

 

 提示：velocity中大小写敏感,不支持属性为汉字 如:$dtdataList.张三。
Velocity还特别提供了得到循环次数的方法，$velocityCount变量的名字是Velocity默认的名字。

 

这样可以通过$velocityCount%2==0 判断奇数偶数行。
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. 条件语句
#if (condition)
#elseif (condition)
#else
#end

4. 语句的嵌套
#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 操作符。
如
## 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中的宏我们可以理解为函数。
①宏的定义
#macro(宏的名称 $参数1 $参数2 …)
 语句体(即函数体)
#end
②宏的调用
#宏的名称($参数1 $参数2 …)
说明：参数之间用空格隔开。

7．#stop
 停止执行模板引擎并返回,把它应用于debug是很有帮助的。

8．#include与#parse
#include和#parse的作用都是引入本地文件, 为了安全的原因，被引入的本地文件只能在TEMPLATE_ROOT目录下。
区别：
(1) 与#include不同的是，#parse只能指定单个对象。而#include可以有多个
如果您需要引入多个文件，可以用逗号分隔就行：
#include ("template/one.gif" "template/two.txt" "template/three.htm" )
在括号内可以是文件名，但是更多的时候是使用变量的：

#set($seasonalstock ="template/test.htm")
#include ("template/greetings.txt" $seasonalstock)(注意中间没有分隔符)

(2) #include被引入文件的内容将不会通过模板引擎解析；
而#parse引入的文件内容Velocity将解析其中的velocity语法并移交给模板，意思就是说相当与把引入的文件copy到文件中。
#parse是可以递归调用的，例如：如果dofoo.vm包含如下行：
Count down.<br>
#set ($count = 8)
#parse ("parsefoo.vm")
<br>All done with dofoo.vm!
那么在parsefoo.vm模板中，你可以包含如下VTL：
$count
#set($count = $count - 1)
#if ( $count > 0 )<br>
#parse( "parsefoo.vm" )
#else
<br>All done with parsefoo.vm!
#end的显示结果为：
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被定义，两个’/’意味着输出一个’/’，如果未被定义，刚按原样输出。如：
#set($email = "foo" )
$email
/$email
//$email
///$email
输出：
foo
$email
/foo
/$email
如果$email 未定义
$email
/$email
//$email
///$email
输出：
$email
/$email
//$email
//$email

 

11．内置对象
Velocity内置了一些对象，在vm模版里可以直接调用，列举如下：
$request、$response、$session,目前还不清楚怎么调用。

12. 方法调用

 

NVelocity用法 Net版(完全整理)NVelocity用法 Net版(完全整理)代码 
 
  
 
    
   public 
     
   class 
    Tool
{
 
   public 
     
   string 
    ConvertToString( 
   string 
    source)
 {
 
   return 
    html  
   + 
     
   " 
   _convert 
   " 
   ;
 }
 
   public 
     
   static 
     
   string 
    C2()
 {
 
   return 
     
   " 
   test 
   " 
     
   + 
     
   " 
   _c2 
   " 
   ;
 }
}
 vc.Put( 
   " 
   toolobj 
   " 
   , tool);
调用方法：
$toolobj.ConvertHtml( 
   " 
   123456 
   " 
   );
$toolobj.C2();
多参数方法调用public  
   static 
     
   string 
    SomeMethod( 
   params 
    String[] args)
{
 
   return 
    String.Join( 
   ' 
   - 
   ' 
   , args);
}
调用方法：$instance.SomeMethod( 
   ' 
   arg1 
   ' 
   ,  
   ' 
   arg2 
   ' 
   ) 
  
 
 
 

 

 
 

 12.模板文件调用
 

 
 

 
 NVelocity用法 Net版(完全整理)NVelocity用法 Net版(完全整理)代码 

标签：
相关文章