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

2、"$"用来标识一个对象(或理解为变量)；如

如：$i、$msg、$TagUtil.options(...)等。

3、"{}"用来明确标识Velocity变量；

比如在页面中，页面中有一个$someonename，此时，Velocity将把someonename作为变量名，若我们程序是想在someone这个变量的后面紧接着显示name字符，则上面的标签应该改成${someone}name。

4、"!"用来强制把不存在的变量显示为空白。

如当页面中包含$msg，如果msg对象有值，将显示msg的值，如果不存在msg对象同，则在页面中将显示$msg字符。这是我们不希望的，为了把不存在的变量或变量值为null的对象显示为空白，则只需要在变量名前加一个“!”号即可。

如：$!msg

二，关于#set的使用

在万不得已的时候，不要在页面视图自己声明Velocity脚本变量，也就是尽量少使用#set。有时候我们需要在页面中显示序号，而程序对象中又没有包含这个序号属性同，可以自己定义。如在一个循环体系中，如下所示：

#set ($i=0)

#foreach($info in $list)

序号:$i

#set($i=$i+1)

#end

三，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

多行#* xxx

xxxx

xxxxxxxxxxxx*#

References 引用的类型

3、变量 Variables

以 "$" 开头，第一个字符必须为字母。character followed by a VTL Identifier. (a .. z or A .. Z).

变量可以包含的字符有以下内容：

alphabetic (a .. z, A .. Z)

numeric (0 .. 9)

hyphen ("-")

underscore ("_")

4、Properties

$Identifier.Identifier

$user.name

hashtable user中的的name值.类似：user.get("name")

5、Methods

object user.getName() = $user.getName()

6、Formal Reference Notation

用{}把变量名跟字符串分开

如

#set ($user="csy"}

${user}name

返回csyname

$username

$!username

$与$!的区别

当找不到username的时候，$username返回字符串"$username"，而$!username返回空字符串""

7、双引号 与 引号

#set ($var="helo")

test"$var" 返回testhello

test'$var' 返回test'$var'

可以通过设置 stringliterals.interpolate=false改变默认处理方式

8、条件语句

#if( $foo )

<strong>Velocity!</strong>

#end

#if($foo)

#elseif()

#else

#end

当$foo为null或为Boolean对象的false值执行.

9、逻辑运算符

== && || !

10、循环语句

#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

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、包含文件

#include( "one.gif","two.txt","three.htm" )

13、Parse导入脚本

#parse("me.vm" )

14、#stop 停止执行并返回

15、定义宏Velocimacros ,相当于函数 支持包含功能

#macro( d )

<tr><td></td></tr>

#end

调用

#d()

16、带参数的宏

#macro( tablerows $color $somelist )

#foreach( $something in $somelist )

<tr><td bgcolor=$color>$something</td></tr>

#end

#end

17、Range Operator

#foreach( $foo in [1..5] )

18、判断

#if(${StringUtils.isNotEmpty(${user.weibo})}||${StringUtils.isNotEmpty(${user.weixin})}||${StringUtils.isNotEmpty(${user.qq})})