一、基本文法
1、"#"用來識別Velocity的腳本語句,包括#set、#if 、#else、#end、#foreach、#end、#iinclude、#parse、#macro等;
如:
#if($info.imgs)
<img src="http://VeVB.COm/ydmx_lei/blog/$info.imgs" border=0>
#else
<img src="http://VeVB.COm/ydmx_lei/blog/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
二、在EasyJWeb中的最佳實踐
理論上你可以在EasyjWeb模板使用所有Velocity的腳本及功能,但我們不推薦你在介面模板中使用過多過複雜的腳本表達方式,在萬不得已的情況下,不要在介面模板中加入任何複雜的邏輯,更不要在介面模板中加入變數宣告、邏輯運算子等等。
在EasyJWeb中,我們提供了五個基本的範本腳本語句,基本上就能滿足所有應用程式範本的要求。這四條模板語句很簡單,可以直接由介面設計人員來新增。在目前許多EasyJWeb的應用實務中,我們看到,所有介面範本中歸納起來只有下面四種簡單模板腳本語句即可實現:
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集合中的對象,並輸出對象的相關內容。
4、#macro(macroName)#end 腳本函數(宏)調用,不建議在介面範本中大量使用。
如:在使用EasyJWeb Tools快速產生的添刪改查範例中,可以點擊清單的標題欄進行升降排序顯示,這是我們在EasyJWeb應用程式中經常看到的一個排序狀態顯示的範本內容。
函數(宏)定義,一般放在最前面
#macro(orderPic $type)
#if ($orderField.equals($type))
<img src="http://VeVB.COm/ico/${orderType}.gif">
#end
#end
具體的呼叫如:<font color="#FFFFFF">頭銜#orderPic("title")</font>
5.包含檔案#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、註:
單行## 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] )