文档章节

Velocity 文档(1)

mj4738
 mj4738
发布于 2012/01/30 13:58
字数 2803
阅读 6074
收藏 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声明:
<html>
    <body>
        Hello $customer.Name!
        <table>
            #foreach( $mud in $nudsOnSpecial ) 
               #if ( $customer.hasPurchased( $mud ) ) 
               <tr>
                   <td>$flogger.getPromo( $mud )</td>
               </tr>
               #end
            #end
         </table>
    </body>
</html>


Velocity Template Language(VTL)介绍
        VTL意味着提供最简单、最容易并且最整洁的方式合并页面动态内容。
        VTL使用引用(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。变量被列在左边,而它的值被列在右边,最后他们之间使用=号分割。

记住以下的规则: 使用$字符开始的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()方法具有相同的效果。如果可能的话使用属性的方式是比较合理的。属性和方法的不同点在于你能够给一个方法指定一个参数列表 

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的正是格式如下:
${mudSlinger}        ##变量
${customer.Address}    ##属性
${purchase.getTotal()}    ##方法

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

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

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

     关于空值(null)的处理

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

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

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

 当然 使用正式的quiet格式会更好:
<input type=”text” name=”email” value=”$!{email}”/>

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

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

将被渲染为:
  $email
  \$email
  \\$email
  \\\$email
 
    指令(Directives)
        reference允许设计者使用动态的内容,而directive使得你可以控制显示逻辑,从而达到期望的显示效果。
          #set 指令
        #set directive被用于设置一个reference的值。例如:    
#set ( $primate = “monkey” )
#set ( $customer.Behavior = $primate )

赋值左侧的(LHS)必须是一个变量或者属性reference。右侧(RHS)可以是以下类型中一种:
  变量引用(variable reference)
  字符串字面值(String literal)
  属性引用(property reference)
  方法调用(method reference)
   数字字面值( number literal)
  数组列表(Array List)
下面是应用各种类型的RHS的例子:
#set ( $monkey = $bill )                 ## 变量引用(variable reference)
  #set ( $monkey.Friend = “monica” )       ##字符串字面值(String literal)
  #set ( $monkey.Blame = $whitehouse.Leak )## 属性引用(property reference)
  #set ( $monkey.Plan = $spindoctor.weave($web) )##方法调用(method reference)
  #set ( $monkey.Number = 123 )                    ## 数字字面值( number literal)
  #set ( $monkey.Say = [“Not”, $my, “fault”] )        ##数组列表(Array List)

注意:最后一个例子的取值方法为:$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

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

        为什么会出现这种现象呢?其实当某个变量被赋值后,它就被保存到Velocity的context(added to the context),并且buhui不能被设置回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 指令时,如果把字符串字面值(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’ )
$blargh

  结果:
    bar
    $foo

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

stringliterals.interpolate = false 

来改变上面的特性失效。


© 著作权归作者所有

mj4738

mj4738

粉丝 295
博文 489
码字总数 119327
作品 0
崇明
高级程序员
私信 提问
Velocity入门指南——第二章 注释

注释一向是一门编程语言的必须成员,没有注释的代码不能称之为好代码。注释允许放置描述文本在模板引擎中。注释通常用于提示自己和解释别人的VTL(Velocity Template Language)语句在做什么...

Leech
2015/12/03
175
0
《Apache RocketMQ用户指南》之简单消息示例

简单消息示例 原文链接 译者:小村长 通过三种方式来发送RocketMQ消息使用: 可靠的同步发送, 可靠的异步发送和单向传输。 这个页面举例说明了这三种消息发送方式. 根据示例找出最适合你的特定...

小村长
01/23
0
0
Velocity找不到模板

最近工作中需要用到模板解析的功能,找到了velocity,按照例子做了一遍,没有问题, 于是乎,直接用于工作环境,发现总是报Resource not found 的异常, 检查模板路径,并没有写错什么,但是...

穿越星辰
2010/05/13
295
0
Velocity找不到模板

最近工作中需要用到模板解析的功能,找到了velocity,按照例子做了一遍,没有问题, 于是乎,直接用于工作环境,发现总是报Resource not found 的异常, 检查模板路径,并没有写错什么,但是...

inferrrrrr
2010/05/11
1K
0
Velocity API文档管理查询工具使用心得

Mac上的Dash是一款非常出色的API文档管理工具,是程序开发的绝佳辅助工具。我曾经期望Dash会推出Windows版本,遗憾的是,作者Kapeli没有这个打算。而当时,他推荐了Zeal这个开源工程给我。 ...

yushulx
2014/08/20
0
8

没有更多内容

加载失败,请刷新页面

加载更多

NEO区块链-DAPP开发直通车-第零篇

什么是DAPP DAPP 是以太坊发明的词汇 Decentralized Application. 目前基于区块链技术开发的应用程序广泛的接受使用了这一名称。 NEL将为开发DAPP提供全面的服务 什么是NEL NEL是 “NewEcon...

NEO-FANS
6分钟前
0
0
可视化软件VisIt在Ubuntu18.04上的安装

可视化软件VisIt在Ubuntu18.04上的安装 参考文档及使用说明 1.下载 在官网下载页面下载合适版本的安装文件,Ubuntu有专用的 https://wci.llnl.gov/simulation/computer-codes/visit/executa...

佚文
12分钟前
0
0
GROUP BY GROUPING SETS

GROUPING SETS 子句是 SELECT 语句的 GROUP BY 子句的扩展。通过 GROUPING SETS 子句,您可采用多种方式对结果分组,而不必使用多个 SELECT 语句来实现这一目的。这就意味着,能够减少响应时...

hblt-j
21分钟前
2
0
selenium之表格的定位

真的勇士, 敢于直面惨淡的warning、 敢于正视淋漓的error 目录 被测试网页的HTML代码 1.遍历表格所有单元格 2.定位表格中的某个元素 3.定位表格中的子元素 总结 浏览器网页常常会包含各类表...

程序猿拿Q
26分钟前
1
0
adb命令启动展讯平台工厂模式

adb命令启动展讯工厂模式: adb shell am start com.sprd.engineermode/com.sprd.engineermode.EngineerModeActivity 其它系统应用启动命令: 其他的一些应用启动命令,如下所示: calendar...

东街小霸王
27分钟前
2
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部