Velocity详解初学者建议看.docx

Velocity详解初学者建议看.docx

《Velocity详解初学者建议看.docx》由会员分享，可在线阅读，更多相关《Velocity详解初学者建议看.docx（31页珍藏版）》请在冰点文库上搜索。

Velocity详解初学者建议看

Velocity教程

关键字:

velocity教程

Velocity是一个基于java的模板引擎（templateengine）。

它允许任何人仅仅简单的使用模板语言（templatelanguage）来引用由java代码定义的对象。

当Velocity应用于web开发时，界面设计人员可以和java程序开发人员同步开发一个遵循MVC架构的web站点，也就是说，页面设计人员可以只关注页面的显示效果，而由java程序开发人员关注业务逻辑编码。

Velocity将java代码从web页面中分离出来，这样为web站点的长期维护提供了便利，同时也为我们在JSP和PHP之外又提供了一种可选的方案。

官方网站：

http:

//jakarta.apache.org/velocity/

Velocity脚本摘要

1、声明:

#set（$var=XXX）

左边可以是以下的内容

Variablereference

Stringliteral

Propertyreference

Methodreference

Numberliteral#set（$i=1）

ArrayList#set（$arr=["yt1","t2"]）

技持算术运算符

2、注释:

单行##XXX

多行#*xxx

xxxx

xxxxxxxxxxxx*#

References引用的类型

3、变量Variables

以"$"开头，第一个字符必须为字母。

characterfollowedbyaVTLIdentifier.（a..z

orA..Z）.

变量可以包含的字符有以下内容：

alphabetic（a..z,A..Z）

numeric（0..9）

hyphen（"-"）

underscore（"_"）

4、Properties

$Identifier.Identifier

$user.name

hashtableuser中的的name值.类似：

user.get（"name"）

5、Methods

objectuser.getName（）=$user.getName（）

6、FormalReferenceNotation

用{}把变量名跟字符串分开

如

#set（$user="csy"}

${user}name

返回csyname

$username

$!

username

$与$!

的区别

当找不到username的时候，$username返回字符串"$username"，而$!

username返回空字符串""

7、双引号与引号

#set（$var="helo"）

test"$var"返回testhello

test'$var'返回test'$var'

可以通过设置stringliterals.interpolate=false改变默认处理方式

8、条件语句

#if（$foo）

Velocity!

#end

#if（$foo）

#elseif（）

#else

#end

当$foo为null或为Boolean对象的false值执行.

9、逻辑运算符:

==&&||!

10、循环语句#foreach（$varin$arrays）//集合包含下面三种Vector,aHashtableoranArray

#end

#foreach（$productin$allProducts）

#end

#foreach（$keyin$allProducts.keySet（））

#end

#foreach（$customerin$customerList）

$velocityCount

$customer.Name

#end

11、velocityCount变量在配置文件中定义

#Defaultnameoftheloopcounter

#variablereference.

directive.foreach.counter.name=velocityCount

#Defaultstartingvalueoftheloop

#countervariablereference.

directive.foreach.counter.initial.value=1

12、包含文件

#include（"one.gif","two.txt","three.htm"）

13、Parse导入脚本

#parse（"me.vm"）

14、#stop停止执行并返回

15、定义宏Velocimacros,相当于函数支持包含功能

#macro（d）

#end

调用

#d（）

16、带参数的宏

#macro（tablerows$color$somelist）

#foreach（$somethingin$somelist）

$something

#end

#end

17、RangeOperator

#foreach（$fooin[1..5]）

Velocity用户手册---中文版（来源网络）

Velocity是什么？

Velocity是一个基于java的模板引擎（templateengine）。

它允许任何人仅仅简单的使用模板语言（templatelanguage）来引用由java代码定义的对象。

当Velocity应用于web开发时，界面设计人员可以和java程序开发人员同步开发一个遵循MVC架构的web站点，也就是说，页面设计人员可以只关注页面的显示效果，而由java程序开发人员关注业务逻辑编码。

Velocity将java代码从web页面中分离出来，这样为web站点的长期维护提供了便利，同时也为我们在JSP和PHP之外又提供了一种可选的方案。

Velocity的能力远不止web站点开发这个领域，例如，它可以从模板（template）产生SQL和PostScript、XML，它也可以被当作一个独立工具来产生源代码和报告，或者作为其他系统的集成组件使用。

Velocity也可以为Turbineweb开发架构提供模板服务（templateservice）。

Velocity+Turbine提供一个模板服务的方式允许一个web应用以一个真正的MVC模型进行开发。

Velocity能为我们作什么？

TheMudStoreExample

Velocity使得web页面的客户化工作非常容易。

作为一个website的设计人员，你希望每个用户登陆时都拥有自己的页面。

你会见了一些公司内的软件工程师，你发现他们每个人都同意客户应该拥有具有个性化的信息。

那让我们把软件工程师应该作的事情发在一边，看一看你应该作些什么吧。

你可能在页面内嵌套如下的VTL声明：

Hello$customer.Name!

#foreach（$mudin$nudsOnSpecial）

#if（$customer.hasPurchased（$mud））

#end

#end

VelocityTemplateLanguage（VTL）:

ANintroduction

VTL意味着提供最简单、最容易并且最整洁的方式合并页面动态内容。

VTL使用references来在website内嵌套动态内容，一个变量就是一种类型的reference。

变量是某种类型的refreence，它可以指向java代码中的定义，或者从当前页面内定义的VTLstatement得到值。

下面是一个VTLstatement的例子，它可以被嵌套到HTML代码中：

#set（$a=“Velocity”）

和所有的VTLstatement一样，这个statement以＃字符开始并且包含一个directive：

set。

当一个在线用户请求你的页面时，VelocityTemplatingEngine将查询整个页面以便发现所有＃字符，然后确定哪些是VTLstatement，哪些不需要VTL作任何事情。

＃字符后紧跟一个directive：

set时，这个setdirective使用一个表达式（使用括号封闭）――一个方程式分配一个值给变量。

变量被列在左边，而它的值被列在右边，最后他们之间使用＝号分割。

在上面的例子中，变量是$a，而它的值是Velocity。

和其他的references一样以$字符开始，而值总是以双引号封闭。

Velocity中仅有String可以被赋值给变量。

记住以下的规则：

使用$字符开始的references（参考，引用）用于得到什么；使用#字符开始的directives（指令）用于作些什么。

HelloVelocityWorld!

一旦某个变量被分配了一个值，那么你就可以在HTML文件的任何地方引用它。

在下面的例子中，一个值被分配给$foo变量，并在其后被引用。

#set（$foo=“Velocity”）

Hello$fooWorld!

上面的实现结果是在页面上打印“HelloVelocityWorld！

”

为了使包含VTLdirectives的statement（语句）更具有可读性，我们鼓励你在新行开始每个VTLstatement，尽管你不是必须这么作。

Setdirective将在后面详细描述。

注释

单行注释：

##Thisisasinglelinecomment.

多行注释：

#*

Thusbeginsamulti-linecomment.Onlinevisitorswon't

seethistextbecausetheVelocityTemplatingEnginewill

ignoreit.

*#

文档格式：

#**

ThisisaVTLcommentblockand

maybeusedtostoresuchinformation

asthedocumentauthorandversioning

information:

@version5

@author

*#

References

在VTL中有三种类型的references：

变量（variables）、属性（properties）、方法（methods）。

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

Everythingcomingtoandfromareference被作为一个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（“MyHomePage”）

$person.setAttributes（[“Strange”,“Weird”,“Excited”]）

前两个例子$customer.getAddress（）和$purchase.getTotal（）看起来挺想上面的属性$customer.Address和$purchase.Total。

如果你觉得他们之间有某种联系的话，那你是正确的。

VTL属性可以作为VTL方法的缩写。

$customer.Address属性和使用$customer.getAddress（）方法具有相同的效果。

如果可能的话使用属性的方式是比较合理的。

属性和方法的不同点在于你能够给一个方法指定一个参数列表。

正式reference标记

reference的正是格式如下：

${mudSlinger}变量

${customer.Address}属性

${purchase.getTotal（）}方法

非正是格式更见常用，但是有时还是使用正是格式比较适合。

例如：

你希望通过一个变量$vice来动态的组织一个字符串。

Jackisa$vicemaniac.

本来变量是$vice现在却变成了$vicemaniac，这样Veloctiy就不知道您到底要什么了。

所以，应该使用正是格式书写

Jackisa${vice}maniac

现在Velocity知道变量是$vice而不是$vicemaniac。

Quietreferencenotation

例如：

当页面的form被初始加载时，变量$email还没有值，这时你肯定是希望它能够显示一个blanktext来代替输出”$email”这样的字段。

那么使用quietreferencenotation就比较合适。

email”/>

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

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

{email}”/>

Gettingliteral

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

本节将讨论$字符。

货币字符

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

EscapingvalidVTLreference

VTL中使用“\\”作为逃逸符。

例如：

#set（$email=“foo”）

$email

\\$email

\\\\$email

\\\\\\$email

将render为：

foo

$email

\\foo

\\\\$email

如果email变量没有被定义则

$email

\\$email

\\\\$email

\\\\\\$email

将被render为：

$email

\\$email

\\\\$email

\\\\\\$email

注意：

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

#set（$foo=“gibbous”）

$moon=$foo

的输出结果是：

$moon=gibbous

Casesubstitution

现在你已经对reference比较熟悉了，你可以将他们高效的应用于你的template了。

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

例如：

$foo

$foo.getBar（）

##isthesameas

$foo.Bar

$data.getUser（“jon”）

##isthesameas

$data.User（“jon”）

$data.getRequest（）.getServerName（）

#isthesameas

$data.Request.ServerName

##isthesameas

${data.Request.ServerName}

但是，注意VTL中不会将reference解释为对象的实例变量。

例如：

$foo.Name将被解释为Foo对象的getName（）方法，而不是Foo对象的Name实例变量。

Directives

Reference允许设计者使用动态的内容，而directive使得你可以应用java代码来控制你的显示逻辑，从而达到你所期望的显示效果。

#set

#setdirective被用于设置一个reference的值。

例如：

#set（$primate=“monkey”）

#set（$customer.Behavior=$primate）

赋值左侧的（LHS）必须是一个变量或者属性reference。

右侧（RHS）可以是以下类型中一种：

l变量reference

lStringliteral

l属性reference

l方法reference

lnumberliteral

lArrayList

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

＃set（$monkey=$bill）##变量reference

＃set（$monkey.Friend=“monica”）##Stringliteral

＃set（$monkey.Blame=$whitehouse.Leak）##属性reference

＃set（$monkey.Plan=$spindoctor.weave（$web））##方法reference

＃set（$monkey.Number=123）##Numberliteral

＃set（$monkey.Say=[“Not”,$my,“fault”]）##ArrayList

注意：

最后一个例子的取值方法为：

$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”））

Theresultofthefirstqueryis$result

#set（$resut=$query.criteria（“address”））

Theresultofthesecondqueryis$result

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

Theresultofthefirstqueryisbill

Theresultofthefirstqueryisbill

看看下面的例子：

#set（$criteria=["name","address"]）

#foreach（$criterionin$criteria）

#set（$result=$query.criteria（$criterion））

#if（$result）

Querywassuccessful

#end

#end

在上面的例子中，程序将不能智能的根据$result的值决定查询是否成功。

在$result被#set后（addedtothecontext），它不能被设置回null（removedfromthecontext）。

打印的结果将显示两次查询结果都成功了，但是实际上有一个查询是失败的。

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

#set（$criteria=[“name”,“address”]）

#foreach（$criterionin$criteria）

#set（$result=false）

#set（$result=$query.criteria（$criterion））

#if（$result）

Querywassuccessful

#end

#end

StringLiterals

当你使用#setdirective，Stringliteral封闭在一对双引号内。

#set（$directoryRoot=“www”）

#set（$templateName=“index.vm”）

#set（$template=“$directoryRoot/$tempateName”）

$template

上面这段代码的输出结果为：

www/index.vm

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

#set（$foo=“bar”）

$foo

#set（$blargh=‘$foo'）

结果：

bar

$foo

上面这个特性可以通过修改velocity.properties文件的stringliterals.interpolate=false的值来改变上面的特性是否有效。

条件语句

if/elseif/else

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

例如：

#if（$foo）

Velocity!

#end

上例中的条件语句将在以下两种条件下成立：

l$foo是一个boolean型的变量，且它的值为true

l$foo变量的值不为null

这里需要注意一点：

Velocityc