一、基本語法

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

　　 1、$!obj 　直接返回對象結果。
　　 如：在html標簽中顯示java對象msg的值。<p>$!msg</p>
　 在html標簽中顯示經過HtmlUtil對象處理過后的msg對象的值　　<p>$!HtmlUtil.doSomething($!msg)</p>

　　2、#if($!obj) #else #end 判斷語句
　　 如：在EasyJWeb各種開源應用中，我們經常看到的用于彈出提示信息msg的例子。
　　 #if($msg)
　　???? <script>
　　???????? alert('$!msg');
　　 ????</script>
　　 #end
上面的腳本表示當對象msg對象存在時，輸出<script>等后面的內容。

????3、#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集合中的對象，并輸出對象的相關內容。
　　
5、#macro(macroName)#end 腳本函數(宏)調用，不推薦在界面模板中大量使用。
　　 如：在使用EasyJWeb Tools快速生成的添刪改查示例中，可以點擊列表的標題欄進行升降排序顯示，這是我們在EasyJWeb應用中經常看到的一個排序狀態顯示的模板內容。
　　 函數(宏)定義，一般放在最前面
　　 #macro(orderPic $type)
　　 #if ($orderField.equals($type))
　　 <img src="/images/ico/${orderType}.gif">
　　 #end
　　 #end
具體的調用如：<font color="#FFFFFF">頭銜#orderPic("title")</font>

6、包含文件#inclue("模板文件名")或#parse("模板文件名")
　　主要用于處理具有相同內容的頁面，比如每個網站的頂部或尾部內容。
　　使用方法，可以參考EasyJF開源Blog及EasyJF開源論壇中的應用！
　　如：#parse("/blog/top.html")或#include("/blog/top.html")
　　parse與include的區別在于，若包含的文件中有Velocity腳本標簽，將會進一步解析，而include將原樣顯示。

關于#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、注釋:

????(1)單行注釋： ## xxxx

????(2)多行注釋： #* xxxxxx

?????????????????????????????xxxx *#

????(3)文檔格式： #** xxxxx

????????????????????????????xxx

????????????????????????@author striner *#

3、變量 Variables
　　以 "$" 開頭，第一個字符必須為字母。character followed by a VTL Identifier. (a .. z or A .. Z).
　　變量可以包含的字符有以下內容：
　　alphabetic (a .. z, A .. Z)
　　numeric (0 .. 9)
　　hyphen ("-")

　　underscore ("_")

(1)變量的定義：

#set($name = "hello") 說明：velocity中變量是弱類型的。

當使用#set 指令時，括在雙引號中的字面字符串將解析和重新解釋，如下所示：

#set($directoryRoot = "www" )

#set($templateName = "index.vm" )

#set(?directoryRoot/$templateName" )

$template

輸出將會是：www/index.vm

注：在velocity中使用$2.5這樣的貨幣標識是沒有問題得的，因為velocity中的變量總是以一個大寫或者小寫的字母開始的。

(2)變量規范的寫法

????也可以寫成：?$name。提倡用前面的寫法。

????例如：你希望通過一個變量$vice來動態的組織一個字符串。

???? Jack is a $vicemaniac.

????本來變量是現在卻變成了?vicemaniac，這樣Veloctiy就不知道您到底要什么了。所以，應該使用規范的格式書寫 ： Jack is a ${vice}maniac現在Velocity知道變量是vice而不是?maniac。

注意：當引用屬性的時候不能加{}

(3)變量的賦值:

????$name="hello"

????賦值的左邊必須是一個變量或者是屬性引用。右邊可以是下面六種類型之一：

????變量引用,字面字符串,屬性引用,方法引用,字面數字,數組列表。

????下面的例子演示了上述的每種類型：

????#set( ?bill ) ## variable reference

????#set( $monkey.Friend = "monica" ) ## string

????#set( ?whitehouse.Leak ) ## property reference

????#set( ?spindoctor.weave($web) ) ## method reference

????#set( $monkey.Number = 123 ) ##number

????#set( ?my, "fault"] ) ## ArrayList

????注意：①如果上述例子中的右值是null, 則左值不會被賦值，也就是說會保留以前的值。

????②velocity模板中未被定義的變量將被認為是一個字符串。例如：

????#set($foo = "gibbous") ?foo輸出結果為：$moon = gibbous

????③velocity模板中不會將reference解釋為對象的實例變量。例如：$foo.Name將被解釋為Foo對象的getName（）方法，而不是Foo對象的Name實例變量。例如：

????data.getRequest().getServerName()?等同于?{data.Request.ServerName}

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
?????
　　#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

例子：

????#set($list = ["pine", "oak", "maple"])

????#foreach ($element in $list)

????$velocityCount

This is $element.<br>

????#end

輸出的結果為：

1 This is pine. 2 This is oak. 3 This is maple.

每次循環中的一個值都會賦給?element變量。 可以是一個、或者。分配給?element的值是一個java對象，并且可以通過變量被引用。例如：如 果$element 是一個java的Product類，并且這個產品的名字可以通過調用他的getName（）方法得到。

#foreach ( ?list.keySet()) Key: ?list.get($key) <br> #end

提示：velocity中大小寫敏感。

Velocity還特別提供了得到循環次數的方法，$velocityCount變量的名字是Velocity默認的名字。

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與#parse導入腳本

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

????????#parse ("parsefoo.vm")

#include和#parse的作用都是引入本地文件, 為了安全的原因，被引入的本地文件只能在TEMPLATE_ROOT目錄下。

區別：

(1) 與#include不同的是，#parse只能指定單個對象。而#include可以有多個

如果您需要引入多個文件，可以用逗號分隔就行： #include ("one.gif", "two.txt", "three.htm" ) 在括號內可以是文件名，但是更多的時候是使用變量的： #include ( “greetings.txt”, $seasonalstock )

(2)?#include被引入文件的內容將不會通過模板引擎解析；

而#parse引入的文件內容Velocity將解析其中的velocity語法并移交給模板，意思就是說相當與把引入的文件copy到文件中。

#parse是可以遞歸調用的，例如：如果dofoo.vm包含如下行：

Count down.<br>

#set ($count = 8)

#parse ("parsefoo.vm")

<br>All done with dofoo.vm!

那么在parsefoo.vm模板中，你可以包含如下內容：

$count

#set($count = $count - 1)

#if ( $count > 0 )<br>

#parse( "parsefoo.vm" )

#else

<br>All done with parsefoo.vm!

#end

注意：在vm中使用#parse來嵌套另外一個vm時的變量共享問題。如：
->a.vm 里嵌套 b.vm；
->a.vm 里定義了變量 $param；
->b.vm 里可以直接使用$param，無任何限制。
但需要特別注意的是，如果b.vm里同時定義有變量$param，則b.vm里將使用b.vm里定義的值

13、#stop 停止執行并返回

14、定義宏Velocimacros ,相當于函數 支持包含功能

Velocity中的宏我們可以理解為函數。

①宏的定義

　　#macro( 宏的名稱 $參數1 $參數2 ... )
　　 語句體（函數體）

　　#end

②宏的調用

　　#宏的名稱（$參數1 $參數2 ...）

???????注意：參數之間用空格隔開

例：
　　#macro( tablerows $color $somelist )
　　#foreach( $something in $somelist )
　　 <tr><td bgcolor=$color>$something</td></tr>
　　#end
　　#end

15、Range Operator
　　#foreach( $foo in [1..5] )

16、內置對象

????Velocity內置了一些對象，在vm模版里可以直接調用，列舉如下：
????$request、$response、$session，另外，模板內還可以使用 $msg內的消息工具訪問 Struts 的國際化資源，達到簡便實現國際化的方法。

17、數組訪問

????對數組的訪問在Velocity中存在問題，因為Velocity只能訪問對象的方法，而數組又是一個特殊的Array，所以雖然數組可以進行循環列舉，但卻不能定位訪問特定位置的元素，如 strs[2]，數組對固定位置元素的訪問調用了Array的反射方法get(Object array, int index)，而Velocity沒能提供這樣的訪問，所以數組要么改成List等其他類容器的方式來包裝，要么就通過公用Util類的方式來提供，傳入數組對象和要訪問的位置參數，從而達到返回所需值的目的。

總結

以上是生活随笔為你收集整理的Velocity常用语法的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。