velocity详解初学者建议看.docx

1、velocity详解初学者建议看Velocity教程关键字: velocity教程 Velocity是一个基于java的模板引擎template engine。它允许任何人仅仅简单的使用模板语言template language来引用由java代码定义的对象。 当Velocity应用于web开发时，界面设计人员可以和java程序开发人员同步开发一个遵循MVC架构的web站点，也就是说，页面设计人员可以只关注页面的显示效果，而由java程序开发人员关注业务逻辑编码。Velocity将java代码从web页面中别离出来，这样为web站点的长期维护提供了便利，同时也为我们在JSP和PHP之外又提供了

2、一种可选的方案。 Velocity脚本摘要 1、声明:#set ($var=XXX)左边可以是以下的内容Variable reference String literal Property reference Method reference Number literal #set ($i=1) ArrayList #set ($arr=yt1,t2)技持算术运算符2、注释:单行# XXX多行#* xxxxxxxxxxxxxxxxxxx*#References 引用的类型3、变量 Variables 以 $ 开头，第一个字符必须为字母。character followed by a VTL I

3、dentifier. (a . z or A . Z).变量可以包含的字符有以下内容：alphabetic (a . z, A . Z) numeric (0 . 9) hyphen (-) underscore (_) 4、Properties hashtable user中的的name值.类似：user.get(name)5、Methods object user.getName() = $user.getName()6、Formal Reference Notation 用把变量名跟字符串分开 如#set ($user=csy$username 返回csyname$username$!u

4、sername$与$!的区别当找不到username的时候，$username返回字符串$username，而$!username返回空字符串 7、双引号 与 引号 #set ($var=helo)test$var 返回testhellotest$var 返回test$var可以通过设置 stringliterals.interpolate=false改变默认处理方式8、条件语句#if( $foo ) Velocity!#end#if($foo)#elseif()#else#end当$foo为null或为Boolean对象的false值执行.9、逻辑运算符:= & | !10、循环语句#for

5、each($var in $arrays ) / 集合包含下面三种Vector, a Hashtable or an Array#end#foreach( $product in $allProducts )$product#end#foreach( $key in $allProducts.keySet() )Key: $key - Value: $allProducts.get($key)#end#foreach( $customer in $customerList )$velocityCount$customer.Name#end11、velocityCount变量在配置文件中定义#

6、Default name of the loop counter# variable reference.# Default starting value of the loop# counter variable reference.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 $someli

7、st )#foreach( $something in $somelist )$something#end#end17、Range Operator #foreach( $foo in 1.5 ) Velocity用户手册-中文版 (来源网络) Velocity是什么？ Velocity是一个基于java的模板引擎template engine。它允许任何人仅仅简单的使用模板语言template language来引用由java代码定义的对象。 当Velocity应用于web开发时，界面设计人员可以和java程序开发人员同步开发一个遵循MVC架构的web站点，也就是说，页面设计人员可以只关注页

8、面的显示效果，而由java程序开发人员关注业务逻辑编码。Velocity将java代码从web页面中别离出来，这样为web站点的长期维护提供了便利，同时也为我们在JSP和PHP之外又提供了一种可选的方案。 Velocity的才能远不止web站点开发这个领域，例如，它可以从模板template产生SQL和PostScript、XML，它也可以被当作一个独立工具来产生源代码和报告，或者作为其他系统的集成组件使用。Velocity也可以为Turbine web开发架构提供模板效劳template service。Velocity+Turbine提供一个模板效劳的方式允许一个web应用以一个真正的MV

9、C模型进展开发。 Velocity能为我们作什么？ The Mud Store Example Velocity使得web页面的客户化工作非常容易。作为一个web site的设计人员，你希望每个用户登陆时都拥有自己的页面。 你会见了一些公司内的软件工程师，你发现他们每个人都同意客户应该拥有具有个性化的信息。那让我们把软件工程师应该作的事情发在一边，看一看你应该作些什么吧。 你可能在页面内嵌套如下的VTL声明： Hello $customer.Name! #foreach( $mud in $nudsOnSpecial ) #if ( $customer.hasPurchased( $mud )

10、 ) $flogger.getPromo( $mud ) #end #end Velocity Template Language(VTL):AN introduction VTL意味着提供最简单、最容易并且最整洁的方式合并页面动态内容。 VTL使用references来在web site内嵌套动态内容，一个变量就是一种类型的reference。变量是某种类型的refreence，它可以指向java代码中的定义，或者从当前页面内定义的VTL statement得到值。下面是一个VTL statement的例子，它可以被嵌套到HTML代码中： #set ( $a = “Velocity ) 和所

11、有的VTL statement一样，这个statement以字符开始并且包含一个directive：set。当一个在线用户恳求你的页面时，Velocity Templating Engine将查询整个页面以便发现所有字符，然后确定哪些是VTL statement，哪些不需要VTL作任何事情。 字符后紧跟一个directive：set时，这个set directive使用一个表达式使用括号封闭一个方程式分配一个值给变量。变量被列在左边，而它的值被列在右边，最后他们之间使用号分割。 在上面的例子中，变量是$a，而它的值是Velocity。和其他的references一样以$字符开始，而值总是以双引

12、号封闭。Velocity中仅有String可以被赋值给变量。 记住以下的规那么： 使用$字符开始的references参考，引用用于得到什么；使用#字符开始的directives指令用于作些什么。 Hello Velocity World! 一旦某个变量被分配了一个值，那么你就可以在HTML文件的任何地方引用它。在下面的例子中，一个值被分配给$foo变量，并在其后被引用。 #set ( $foo = “Velocity ) Hello $foo World! 上面的实现结果是在页面上打印“Hello Velocity World！ 为了使包含VTL directives的statement语句

13、更具有可读性，我们鼓励你在新行开始每个VTL statement，尽管你不是必须这么作。Set directive将在后面详细描绘。 注释 单行注释： # This is a single line comment. 多行注释： #* Thus begins a multi-line comment. Online visitors wont see this text because the Velocity Templating Engine will ignore it. *# 文档格式： #* This is a VTL comment block and may be used to

14、 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对象处理。假设有一个对象

15、$foo是一个Integer对象，那么Velocity将调用它的toString()方法将这个对象转型为String类型。 变量 格式要求同java。 属性 例子： $customer.Address $purchase.Total 有两种含义。它可以表示：查找hashtable对象customer中以Address为关键字的值；也可以表示调用customer对象的getAddress()方法。当你的页面被恳求时，Velocity将确定以上两种方式选用那种，然后返回适当的值。 方法 一个方法就是被定义在java中的一段代码，并且它有完成某些有用工作的才能，例如一个执行计算和判断条件是否成立、满

16、足等。方法是一个由$开始并跟随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。假设你觉得他们之间有某种联络的话，那你是正确的。

17、VTL属性可以作为VTL方法的缩写。$customer.Address属性和使用$customer.getAddress()方法具有一样的效果。假设可能的话使用属性的方式是比较合理的。属性和方法的不同点在于你可以给一个方法指定一个参数列表。 正式reference标记 reference的正是格式如下： $mudSlinger变量 $customer.Address属性 $purchase.getTotal()方法 非正是格式更见常用，但是有时还是使用正是格式比较适宜。例如：你希望通过一个变量$vice来动态的组织一个字符串。 Jack is a $vicemaniac. 本来变量是$vice

18、如今却变成了$vicemaniac，这样Veloctiy就不知道您到底要什么了。所以，应该使用正是格式书写 Jack is a $vicemaniac 如今Velocity知道变量是$vice而不是$vicemaniac。 Quiet reference notation 例如： 当页面的form被初始加载时，变量$email还没有值，这时你肯定是希望它可以显示一个blank text来代替输出$email这样的字段。那么使用quiet reference notation就比较适宜。 这样文本框的初始值就不会是email而是空值了。 正式和quiet格式的reference notation

19、也可一同使用，像下面这样： Getting literal Velocity使用特殊字符$和#来帮助它工作，所以假设要在template里使用这些特殊字符要格外小心。本节将讨论$字符。 货币字符 在VTL中使用$2.5这样的货币标识是没有问题得的，VTL不会将它错认为是一个reference，因为VTL中的reference总是以一个大写或者小写的字母开始。 Escaping valid VTL reference VTL中使用“作为逃逸符。 例如： #set( $email = “foo ) $email $email $email $email 将render为： foo $email f

20、oo $email 假设email变量没有被定义那么 $email $email $email $email 将被render为： $email $email $email $email 注意：VTL中未被定义的变量将被认为是一个字符串，所以以下例子： #set( $foo = “gibbous ) $moon = $foo 的输出结果是： $moon = gibbous Case substitution 如今你已经对reference比较熟悉了，你可以将他们高效的应用于你的template了。Velocity利用了很多java标准以方便了设计人员的使用。例如： $foo $foo.getB

21、ar() # is the same as $foo.Bar $data.getUser(“jon) # is the same as $data.User(“jon) $data.getRequest().getServerName() # is the same as # is the same as 但是，注意VTL中不会将reference解释为对象的实例变量。例如：$foo.Name将被解释为Foo对象的getName方法，而不是Foo对象的Name实例变量。 Directives Reference允许设计者使用动态的内容，而directive使得你可以应用java代码来控制你的显

22、示逻辑，从而到达你所期望的显示效果。 #set #set directive被用于设置一个reference的值。例如： #set ( $primate = “monkey ) #set ( $customer.Behavior = $primate ) 赋值左侧的LHS必须是一个变量或者属性reference。右侧RHS可以是以下类型中一种： l变量reference lString literal l属性reference l方法reference lnumber literal lArrayList 下面是应用各种类型的RHS的例子： set ( $monkey = $bill ) #变

23、量reference set ( $monkey.Friend = “monica ) #String literal set ( $monkey.Blame = $whitehouse.Leak )#属性reference set ( $monkey.Plan = $spindoctor.weave($web) )#方法reference set ( $monkey.Number = 123 )#Number literal set ( $monkey.Say = “Not, $my, “fault )#ArrayList RHS也可以是一个简单的算术表达式： #set ( $value =

24、 $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 resu

25、lt 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

26、($criterion) ) #if( $result ) Query was successful #end #end 在上面的例子中，程序将不能智能的根据$result的值决定查询是否成功。在$result被#set后added to the context，它不能被设置回nullremoved from the context。打印的结果将显示两次查询结果都成功了，但是实际上有一个查询是失败的。 为理解决以上问题我们可以通过预先定义的方式： #set( $criteria = “name, “address ) #foreach( $criterion in $criteria ) #s

27、et( $result = false ) #set( $result = $query.criteria( $criterion ) ) #if( $result ) Query was successful #end #end String Literals 当你使用#set directive，String literal封闭在一对双引号内。 #set ( $directoryRoot = “www ) #set ( $templateName = “index.vm ) #set ( $template = “$directoryRoot/$tempateName ) $templat

28、e 上面这段代码的输出结果为：www/index.vm 但是，当string literal被封装在单引号内时，它将不被解析： #set ( $foo = “bar ) $foo #set ( $blargh = $foo ) 结果： bar $foo 条件语句 if/elseif/else 当一个web页面被生成时使用Velocity的#if directrive，假设条件成立的话可以在页面内嵌入文字。例如： #if ( $foo ) Velocity! #end 上例中的条件语句将在以下两种条件下成立： l$foo是一个boolean型的变量，且它的值为true l$foo变量的值不为null 这里需要注意一点：Velocity context仅仅可以包含对象，所以当我们说“boolean时实际上代表的时一个Boolean对象。即便某个方法返回的是一个boolean值，Velocity也会利用内省机制将它转换为一个Boolean的一样值。 假设条件成立，那么#if和#end之间的内容将被显示。 #elseif和#else元素可以同#if一同使用。例如： #if( $foo 10 ) Go North #elseif( $foo = 10 ) Go East #elseif( $foo = 6 ) Go South #else Go West #