Velocity

1. Velocity是一个基于java的模板引擎（template engine），它允许任何人仅仅简单的使用模板语言（template language）来引用由java代码定义的对象。作为一个比较完善的模板引擎，Velocity的功能是比较强大的，但强大的同时也增加了应用复杂性。
2. 一、基本语法
3. 1、"#"用来标识Velocity的脚本语句，包括#set、#if 、#else、#end、#foreach、#end、#iinclude、#parse、#macro等；
4. 如:
5. #if($info.imgs)
6. <img src="$info.imgs" border=0>
7. #else
8. <img src="noPhoto.jpg">
9. #end
10. 2、"$"用来标识一个对象(或理解为变量)；如
11. 如：$i、$msg、$TagUtil.options(...)等。
12. 3、"{}"用来明确标识Velocity变量；
13. 比如在页面中，页面中有一个$someonename，此时，Velocity将把someonename作为变量名，若我们程序是想在someone这个变量的后面紧接着显示name字符，则上面的标签应该改成${someone}name。
14. 4、"!"用来强制把不存在的变量显示为空白。
15. 如当页面中包含$msg，如果msg对象有值，将显示msg的值，如果不存在msg对象同，则在页面中将显示$msg字符。这是我们不希望的，为了把不存在的变量或变量值为null的对象显示为空白，则只需要在变量名前加一个“!”号即可。
16. 如：$!msg
17. 我们提供了五条基本的模板脚本语句，基本上就能满足所有应用模板的要求。这四条模板语句很简单，可以直接由界面设计人员来添加。在当前很多EasyJWeb的应用实践中，我们看到，所有界面模板中归纳起来只有下面四种简单模板脚本语句即可实现：
18. 　　 1、$!obj 　直接返回对象结果。
19. 　　 如：在html标签中显示java对象msg的值。<p>$!msg</p>
20. 　 在html标签中显示经过HtmlUtil对象处理过后的msg对象的值　　<p>$!HtmlUtil.doSomething($!msg)</p>
21. 　　2、#if($!obj) #else #end 判断语句
22. 　　 如：在EasyJWeb各种开源应用中，我们经常看到的用于弹出提示信息msg的例子。
23. 　　 #if($msg)
24. 　　 <script>
25. 　　 alert(‘$!msg‘);
26. 　　 </script>
27. 　　 #end
28. 上面的脚本表示当对象msg对象存在时，输出<script>等后面的内容。
29. 　　3、#foreach( $info in $list) $info.someList #end　　循环读取集合list中的对象，并作相应的处理。
30. 　　 如：EasyJF开源论坛系统中论(0.3)坛首页显示热门主题的html界面模板脚本：
31. 　　#foreach( $info in $hotList1)
32. <a href="/bbsdoc.ejf?easyJWebCommand=show&&cid=$!info.cid" target="_blank">$!info.title</a><br>
33. 　　　 #end
34. 　　 上面的脚本表示循环遍历hotList1集合中的对象，并输出对象的相关内容。
35. 　　
36. 　　 4、#macro(macroName)#end 脚本函数(宏)调用，不推荐在界面模板中大量使用。
37. 　　 如：在使用EasyJWeb Tools快速生成的添删改查示例中，可以点击列表的标题栏进行升降排序显示，这是我们在EasyJWeb应用中经常看到的一个排序状态显示的模板内容。
38. 　　 函数(宏)定义，一般放在最前面
39. 　　 #macro(orderPic $type)
40. 　　 #if ($orderField.equals($type))
41. 　　 <img src="/images/ico/${orderType}.gif">
42. 　　 #end
43. 　　 #end
44. 具体的调用如：<font color="#FFFFFF">头衔#orderPic("title")</font>
45. 　　5、包含文件#inclue("模板文件名")或#parse("模板文件名")
46. 　　主要用于处理具有相同内容的页面，比如每个网站的顶部或尾部内容。
47. 　　使用方法，可以参考EasyJF开源Blog及EasyJF开源论坛中的应用！
48. 　　如：#parse("/blog/top.html")或#include("/blog/top.html")
49. 　　parse与include的区别在于，若包含的文件中有Velocity脚本标签，将会进一步解析，而include将原样显示。
50. 关于#set的使用
51. 　　在万不得已的时候，不要在页面视图自己声明Velocity脚本变量，也就是尽量少使用#set。有时候我们需要在页面中显示序号，而程序对象中又没有包含这个序号属性同，可以自己定义。如在一个循环体系中，如下所示：
52. 　　#set ($i=0)
53. 　　#foreach($info in $list)
54. 　　序号:$i
55. 　　#set($i=$i+1)
56. 　　#end
57. Velocity脚本语法摘要
58. 1、声明:#set ($var=XXX)
59. 　　左边可以是以下的内容
60. 　　Variable reference
61. 　　String literal
62. 　　Property reference
63. 　　Method reference
64. 　　Number literal #set ($i=1)
65. 　　ArrayList #set ($arr=["yt1","t2"])
66. 　　算术运算符
67. 2、注释:
68. 　　单行## XXX
69. 　　多行#* xxx
70. 　　xxxx
71. 　　xxxxxxxxxxxx*#
72. 　　References 引用的类型
73. 3、变量 Variables
74. 　　以 "$" 开头，第一个字符必须为字母。character followed by a VTL Identifier. (a .. z or A .. Z).
75. 　　变量可以包含的字符有以下内容：
76. 　　alphabetic (a .. z, A .. Z)
77. 　　numeric (0 .. 9)
78. 　　hyphen ("-")
79. 　　underscore ("_")
80. 4、Properties
81. 　　$Identifier.Identifier
82. 　　$user.name
83. 　　hashtable user中的的name值.类似：user.get("name")
84. 5、Methods
85. 　　object user.getName() = $user.getName()
86. 6、Formal Reference Notation
87. 　　用{}把变量名跟字符串分开
88. 　　如
89. 　　#set ($user="csy"}
90. 　　${user}name
91. 　　返回csyname
92. 　　$username
93. 　　$!username
94. 　　$与$!的区别
95. 　　当找不到username的时候，$username返回字符串"$username"，而$!username返回空字符串""
96. 7、双引号 与 引号
97. 　　#set ($var="helo")
98. 　　test"$var" 返回testhello
99. 　　test‘$var‘ 返回test‘$var‘
100. 　　可以通过设置 stringliterals.interpolate=false改变默认处理方式
101. 8、条件语句
102. 　　#if( $foo )
103. 　　 <strong>Velocity!</strong>
104. 　　#end
105. 　　#if($foo)
106. 　　#elseif()
107. 　　#else
108. 　　#end
109. 　　当$foo为null或为Boolean对象的false值执行.
110. 9、逻辑运算符:== && || !
111. 10、循环语句#foreach($var in $arrays ) // 集合包含下面三种Vector, a Hashtable or an Array
112. #end
113. 　　#foreach( $product in $allProducts )
114. 　　 <li>$product</li>
115. 　　#end
116. 　　#foreach( $key in $allProducts.keySet() )
117. 　　 <li>Key: $key -> Value: $allProducts.get($key)</li>
118. 　　#end
119. 　　#foreach( $customer in $customerList )
120. 　　 <tr><td>$velocityCount</td><td>$customer.Name</td></tr>
121. 　　#end
122. 11、velocityCount变量在配置文件中定义
123. 　　# Default name of the loop counter
124. 　　# variable reference.
125. 　　directive.foreach.counter.name = velocityCount
126. 　　# Default starting value of the loop
127. 　　# counter variable reference.
128. 　　directive.foreach.counter.initial.value = 1
129. 12、包含文件
130. 　　#include( "one.gif","two.txt","three.htm" )
131. 13、Parse导入脚本
132. 　　#parse("me.vm" )
133. 14、#stop 停止执行并返回
134. 15、定义宏Velocimacros ,相当于函数 支持包含功能
135. 　　#macro( d )
136. 　　 <tr><td></td></tr>
137. 　　#end
138. 　　调用
139. 　　#d()
140. 16、带参数的宏
141. 　　#macro( tablerows $color $somelist )
142. 　　#foreach( $something in $somelist )
143. 　　 <tr><td bgcolor=$color>$something</td></tr>
144. 　　#end
145. 　　#end
146. 17、Range Operator
147. 　　#foreach( $foo in [1..5] )

Velocity,布布扣,bubuko.com