首页 > 代码库 > Velocity

Velocity

2024-07-15 14:52:38   222人阅读

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


联系
我们