Velocity

青旅半醒 2022-08-23 11:00 146阅读 0赞

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的[Eclipse插件][Eclipse]的Update地址是：http://propsorter.sourceforge.net/veloeclipse

**Velocity 的 JavaDoc:**[ http://www.ostools.net/apidocs/apidoc?api=velocity-1.7][http_www.ostools.net_apidocs_apidoc_api_velocity-1.7]

<table> 
 <tbody> 
 <tr> 
 <td style="font-family:Verdana,Geneva,Arial,Helvetica,sans-serif; font-size:12px; border-color:silver; border-collapse:collapse; padding:3px"> 
 <table> 
 <tbody> 
 <tr> 
 <td style="font-family:Verdana,Geneva,Arial,Helvetica,sans-serif; border-color:silver; border-collapse:collapse; padding:3px"> </td> 
 </tr> 
 <tr> 
 <td style="font-family:Verdana,Geneva,Arial,Helvetica,sans-serif; border-color:silver; border-collapse:collapse; padding:3px"> &nbsp; 　　理论上你可以在EasyjWeb模板使用所有Velocity的脚本及功能，但我们不推荐你在界面模板中使用过多过复杂的脚本表达方式，在万不得已的情况下，不要在界面模板中加入任何复杂的逻辑，更不要在界面模板中加入变量声明、逻辑运算符等等。 　　在EasyJWeb中，我们提供了五条基本的模板脚本语句，基本上就能满足所有应用模板的要求。这四条模板语句很简单，可以直接由界面设计人员来添加。在当前很多EasyJWeb的应用实践中，我们看到，所有界面模板中归纳起来只有下面四种简单模板脚本语句即可实现： 1、$!obj 　直接返回对象结果。 如：在html标签中显示java对象msg的值。&lt;p&gt;$!msg&lt;/p&gt; 在html标签中显示经过HtmlUtil对象处理过后的msg对象的值　　&lt;p&gt;$!HtmlUtil.doSomething($!msg)&lt;/p&gt; 　　2、#if($!obj) #else #end 判断语句 如：在EasyJWeb各种开源应用中，我们经常看到的用于弹出提示信息msg的例子。 #if($msg) &lt;script&gt; alert('$!msg'); &lt;/script&gt; #end 上面的脚本表示当对象msg对象存在时，输出&lt;script&gt;等后面的内容。 　　3、#foreach( $info in $list) $info.someList #end　　循环读取集合list中的对象，并作相应的处理。 如：EasyJF开源论坛系统中论(0.3)坛首页显示热门主题的html界面模板脚本： #foreach( $info in $hotList1)&nbsp; &lt;a href="/bbsdoc.ejf?easyJWebCommand=show&amp;&amp;cid=$!info.cid" target="_blank"&gt;$!info.title&lt;/a&gt;&lt;br&gt; #end&nbsp; 上面的脚本表示循环遍历hotList1集合中的对象，并输出对象的相关内容。 4、#macro(macroName)#end 脚本函数(宏)调用，不推荐在界面模板中大量使用。 如：在使用EasyJWeb Tools快速生成的添删改查示例中，可以点击列表的标题栏进行升降排序显示，这是我们在EasyJWeb应用中经常看到的一个排序状态显示的模板内容。 函数(宏)定义，一般放在最前面 #macro(orderPic $type) #if ($orderField.equals($type))&nbsp; &lt;img src="http://images.cnblogs.com/ico/${orderType}.gif"&gt;&nbsp; #end #end 具体的调用如：&lt;font color="#FFFFFF"&gt;头衔#orderPic("title")&lt;/font&gt; 经过测试，宏不支持方法重载 &nbsp; 　　5、包含文件#inclue("模板文件名")或#parse("模板文件名") 主要用于处理具有相同内容的页面，比如每个网站的顶部或尾部内容。 使用方法，可以参考EasyJF开源Blog及EasyJF开源论坛中的应用！ 如：#parse("/blog/top.html")或#include("/blog/top.html") parse与include的区别在于，若包含的文件中有Velocity脚本标签，将会进一步解析，而include将原样显示。 </td> 
 </tr> 
 <tr> 
 <td style="font-family:Verdana,Geneva,Arial,Helvetica,sans-serif; border-color:silver; border-collapse:collapse; padding:3px"> &nbsp;</td> 
 </tr> 
 </tbody> 
 </table> </td> 
 </tr> 
 <tr> 
 <td style="font-family:Verdana,Geneva,Arial,Helvetica,sans-serif; font-size:12px; border-color:silver; border-collapse:collapse; padding:3px"> 
 <table> 
 <tbody> 
 <tr> 
 <td style="font-family:Verdana,Geneva,Arial,Helvetica,sans-serif; border-color:silver; border-collapse:collapse; padding:3px"> 
 <table> 
 <tbody> 
 <tr> 
 <td style="font-family:Verdana,Geneva,Arial,Helvetica,sans-serif; border-color:silver; border-collapse:collapse; padding:3px"> <a rel="nofollow"></a>三、关于#set的使用 </td> 
 </tr> 
 </tbody> 
 </table> </td> 
 </tr> 
 <tr> 
 <td style="font-family:Verdana,Geneva,Arial,Helvetica,sans-serif; border-color:silver; border-collapse:collapse; padding:3px"> 在万不得已的时候，不要在页面视图自己声明Velocity脚本变量，也就是尽量少使用#set。有时候我们需要在页面中显示序号，而程序对象中又没有包 含这个序号属性同，可以自己定义。如在一个循环体系中，如下所示： #set ($i=0) #foreach($info in $list) 序号:$i #set($i=$i+1) #end </td> 
 </tr> 
 <tr> 
 <td style="font-family:Verdana,Geneva,Arial,Helvetica,sans-serif; border-color:silver; border-collapse:collapse; padding:3px"> &nbsp;</td> 
 </tr> 
 </tbody> 
 </table> </td> 
 </tr> 
 <tr> 
 <td style="font-family:Verdana,Geneva,Arial,Helvetica,sans-serif; font-size:12px; border-color:silver; border-collapse:collapse; padding:3px"> 
 <table> 
 <tbody> 
 <tr> 
 <td style="font-family:Verdana,Geneva,Arial,Helvetica,sans-serif; border-color:silver; border-collapse:collapse; padding:3px"> 
 <table> 
 <tbody> 
 <tr> 
 <td style="font-family:Verdana,Geneva,Arial,Helvetica,sans-serif; border-color:silver; border-collapse:collapse; padding:3px"> <a rel="nofollow"></a>四、Velocity脚本语法摘要 </td> 
 </tr> 
 </tbody> 
 </table> </td> 
 </tr> 
 <tr> 
 <td style="font-family:Verdana,Geneva,Arial,Helvetica,sans-serif; border-color:silver; border-collapse:collapse; padding:3px"> 1、声明:#set ($var=XXX) 左边可以是以下的内容 Variable reference&nbsp; String literal&nbsp; Property reference&nbsp; Method reference&nbsp; Number literal #set ($i=1)&nbsp; ArrayList #set ($arr=["yt1","t2"]) 算术运算符 2、注释: 单行## XXX 多行#* xxx xxxx xxxxxxxxxxxx*# References 引用的类型 3、变量 Variables&nbsp; 以 "$" 开头，第一个字符必须为字母。character followed by a VTL Identifier. (a .. z or A .. Z). 变量可以包含的字符有以下内容： alphabetic (a .. z, A .. Z)&nbsp; numeric (0 .. 9)&nbsp; hyphen ("-")&nbsp; underscore ("_")&nbsp; 4、Properties&nbsp; $Identifier.Identifier $user.name hashtable user中的的name值.类似：user.get("name") 5、Methods&nbsp; object user.getName() = $user.getName() 6、Formal Reference Notation&nbsp; 用{}把变量名跟字符串分开&nbsp; 如 #set ($user="csy"} ${user}name&nbsp; 返回csyname $username $!username $与$!的区别 当找不到username的时候，$username返回字符串"$username"，而$!username返回空字符串""&nbsp; 7、双引号 与 引号&nbsp; #set ($var="helo") test"$var" 返回testhello test'$var' 返回test'$var' 可以通过设置 stringliterals.interpolate=false改变默认处理方式 8、条件语句 #if( $foo )&nbsp; &lt;strong&gt;Velocity!&lt;/strong&gt; #end #if($foo) #elseif() #else #end 当$foo为null或为Boolean对象的false值执行. 9、逻辑运算符:== &amp;&amp; || ! 10、循环语句#foreach($var in $arrays )&nbsp;// 集合包含下面三种Vector, a Hashtable or an Array #end #foreach( $product in $allProducts ) &lt;li&gt;$product&lt;/li&gt; #end #foreach( $key in $allProducts.keySet() ) &lt;li&gt;Key: $key -&gt; Value: $allProducts.get($key)&lt;/li&gt; #end #foreach( $customer in $customerList ) &lt;tr&gt;&lt;td&gt;$velocityCount&lt;/td&gt;&lt;td&gt;$customer.Name&lt;/td&gt;&lt;/tr&gt; #end 11、velocityCount变量在配置文件中定义 # Default name of the loop counter # variable reference. directive.foreach.counter.name = velocityCount # Default starting value of the loop # counter variable reference. directive.foreach.counter.initial.value = 1 12、包含文件&nbsp; #include( "one.gif","two.txt","three.htm" ) 13、Parse导入脚本 #parse("me.vm" ) 14、#stop 停止执行并返回&nbsp; 15、定义宏Velocimacros ,相当于函数 支持包含功能 #macro( d ) &lt;tr&gt;&lt;td&gt;&lt;/td&gt;&lt;/tr&gt; #end 调用&nbsp; #d() 16、带参数的宏 #macro( tablerows $color $somelist ) #foreach( $something in $somelist ) &lt;tr&gt;&lt;td bgcolor=$color&gt;$something&lt;/td&gt;&lt;/tr&gt; #end #end 17、Range Operator&nbsp; #foreach( $foo in [1..5]&nbsp; </td> 
 </tr> 
 </tbody> 
 </table> </td> 
 </tr> 
 </tbody> 
</table>

[Eclipse]: http://www.oschina.net/p/veloeclipse
[http_www.ostools.net_apidocs_apidoc_api_velocity-1.7]: http://www.ostools.net/apidocs/apidoc?api=velocity-1.7