velocity语法教程

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

Velocity 的 JavaDoc: http://www.ostools.net/apidocs/apidoc?api=velocity-1.7

1、基本语法

一、"#"用来标识Velocity的脚本语句，包括#set、#if 、#else、#end、#foreach、#end、#iinclude、#parse、#macro等； 如: #if($info.imgs) <img src="$info.imgs" border=0> #else <img src="noPhoto.jpg"> #end 二、"$"用来标识一个对象(或理解为变量)；如 如：$i、$msg、$TagUtil.options(...)等。 三、"{}"用来明确标识Velocity变量； 好比在页面中，页面中有一个$someonename，此时，Velocity将把someonename做为变量名，若咱们程序是想在someone这 个变量的后面紧接着显示name字符，则上面的标签应该改为${someone}name。 四、"!"用来强制把不存在的变量显示为空白。 如当页面中包含$msg，若是msg对象有值，将显示msg的值，若是不存在msg对象同，则在页面中将显示$msg字符。这是咱们不但愿的，为了把不存 在的变量或变量值为null的对象显示为空白，则只须要在变量名前加一个“!”号便可。 如：$!msg

理论上你能够在EasyjWeb模板使用全部Velocity的脚本及功能，但咱们不推荐你在界面模板中使用过多过复杂的脚本表达方式，在万不得已的状况下，不要在界面模板中加入任何复杂的逻辑，更不要在界面模板中加入变量声明、逻辑运算符等等。 　　在EasyJWeb中，咱们提供了五条基本的模板脚本语句，基本上就能知足全部应用模板的要求。这四条模板语句很简单，能够直接由界面设计人员来添加。在当前不少EasyJWeb的应用实践中，咱们看到，全部界面模板中概括起来只有下面四种简单模板脚本语句便可实现： 一、$!obj 　直接返回对象结果。 如：在html标签中显示java对象msg的值。<p>$!msg</p> 在html标签中显示通过HtmlUtil对象处理事后的msg对象的值　　<p>$!HtmlUtil.doSomething($!msg)</p> 　　二、#if($!obj) #else #end 判断语句 如：在EasyJWeb各类开源应用中，咱们常常看到的用于弹出提示信息msg的例子。 #if($msg) <script> alert('$!msg'); </script> #end 上面的脚本表示当对象msg对象存在时，输出<script>等后面的内容。 　　三、#foreach( $info in $list) $info.someList #end　　循环读取集合list中的对象，并做相应的处理。 如：EasyJF开源论坛系统中论(0.3)坛首页显示热门主题的html界面模板脚本： #foreach( $info in $hotList1)  <a href="/bbsdoc.ejf?easyJWebCommand=show&&cid=$!info.cid" target="_blank">$!info.title</a><br> #end  上面的脚本表示循环遍历hotList1集合中的对象，并输出对象的相关内容。 四、#macro(macroName)#end 脚本函数(宏)调用，不推荐在界面模板中大量使用。 如：在使用EasyJWeb Tools快速生成的添删改查示例中，能够点击列表的标题栏进行升降排序显示，这是咱们在EasyJWeb应用中常常看到的一个排序状态显示的模板内容。 函数(宏)定义，通常放在最前面 #macro(orderPic $type) #if ($orderField.equals($type))  <img src="http://images.cnblogs.com/ico/${orderType}.gif">  #end #end 具体的调用如：<font color="#FFFFFF">头衔#orderPic("title")</font> 通过测试，宏不支持方法重载   　　五、包含文件#inclue("模板文件名")或#parse("模板文件名") 主要用于处理具备相同内容的页面，好比每一个网站的顶部或尾部内容。 使用方法，能够参考EasyJF开源Blog及EasyJF开源论坛中的应用！ 如：#parse("/blog/top.html")或#include("/blog/top.html") parse与include的区别在于，若包含的文件中有Velocity脚本标签，将会进一步解析，而include将原样显示。

3、关于#set的使用 在万不得已的时候，不要在页面视图本身声明Velocity脚本变量，也就是尽可能少使用#set。有时候咱们须要在页面中显示序号，而程序对象中又没有包 含这个序号属性同，能够本身定义。如在一个循环体系中，以下所示： #set ($i=0) #foreach($info in $list) 序号:$i #set($i=$i+1) #end

4、Velocity脚本语法摘要 一、声明:#set ($var=XXX) 左边能够是如下的内容 Variable reference  String literal  Property reference  Method reference  Number literal #set ($i=1)  ArrayList #set ($arr=["yt1","t2"]) 算术运算符 二、注释: 单行## XXX 多行#* xxx xxxx xxxxxxxxxxxx*# References 引用的类型 三、变量 Variables  以 "$" 开头，第一个字符必须为字母。character followed by a VTL Identifier. (a .. z or A .. Z). 变量能够包含的字符有如下内容： alphabetic (a .. z, A .. Z)  numeric (0 .. 9)  hyphen ("-")  underscore ("_")  四、Properties  $Identifier.Identifier $user.name hashtable user中的的name值.相似：user.get("name") 五、Methods  object user.getName() = $user.getName() 六、Formal Reference Notation  用{}把变量名跟字符串分开  如 #set ($user="csy"} ${user}name  返回csyname $username $!username $与$!的区别 当找不到username的时候，$username返回字符串"$username"，而$!username返回空字符串""  七、双引号 与 引号  #set ($var="helo") test"$var" 返回testhello test'$var' 返回test'$var' 能够经过设置 stringliterals.interpolate=false改变默认处理方式 八、条件语句 #if( $foo )  <strong>Velocity!</strong> #end #if($foo) #elseif() #else #end 当$foo为null或为Boolean对象的false值执行. 九、逻辑运算符:== && || ! 十、循环语句#foreach($var in $arrays ) // 集合包含下面三种Vector, a Hashtable or an Array #end #foreach( $product in $allProducts ) <li>$product</li> #end #foreach( $key in $allProducts.keySet() ) <li>Key: $key -> Value: $allProducts.get($key)</li> #end #foreach( $customer in $customerList ) <tr><td>$velocityCount</td><td>$customer.Name</td></tr> #end 十一、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 十二、包含文件  #include( "one.gif","two.txt","three.htm" ) 1三、Parse导入脚本 #parse("me.vm" ) 1四、#stop 中止执行并返回  1五、定义宏Velocimacros ,至关于函数 支持包含功能 #macro( d ) <tr><td></td></tr> #end 调用  #d() 1六、带参数的宏 #macro( tablerows $color $somelist ) #foreach( $something in $somelist ) <tr><td bgcolor=$color>$something</td></tr> #end #end 1七、Range Operator #foreach( $foo in [1..5]