Velocity 語法（轉）

Velocity 是一個基於 java 的模板引擎（template engine）。它容許任何人僅僅簡單的使用模板語言（template language）來引用由 java 代碼定義的對象。

當 Velocity 應用於 web 開發時， 界面設計人員能夠和 java 程序開發人員同步開發一個遵循 MVC 架構的 web 站點，也就是說，頁面設計人員能夠只關注頁面的顯示效果，而由 java 程序開發人員關注業務邏輯編碼。Velocity 將 java 代碼從 web頁面中分離出來，這樣爲 web 站點的長期維護提供了便利，同時也爲咱們在 JSP以外又提供了一種可選的方案。

 

Velocity 的能力遠不止 web 站點開發這個領域，例如，它能夠從模板（template）產生 SQL 和 PostScript、XML，它也能夠被看成一個獨立工具來產生源代碼和報告， 或者做爲其餘系統的集成組件使用。Velocity 也能夠爲 Turbine web開發架構提供模板服務（template service）。Velocity+Turbine 提供一個模板服務的方式容許一個 web 應用以一個真正的 MVC 模型進行開發。

 

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

2、在EasyJWeb中的最佳實踐

　　理論上你能夠在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] )

附：《淺析MVC框架中View層的優雅設計及實例》

做者：EasyJF開源團隊 大峽
在基於B/S的應用程序開發中，從基本的技術分工上來講就是兩大塊，一是軟件顯示界面，另外一個是程序邏輯。在N年前的腳本語言時代，不管是asp、 php仍是jsp，咱們基本是都是把這二者柔和在一塊兒的。儘管咱們千方百計作好不少函數或者包含文件來努力達到軟件的複用，但仍然沒法知足多變的用戶需 求,這主要是由於之前的純腳本編碼方式沒法很好支持及應用面向對象(OO)領域中的強大功能。

在常見的B/S軟件項目中，界面的設計包括html界面、Wap界面及其它由文本字符協議爲基本表示的界面等。以咱們接觸最多的html頁面爲例子，在 作這些界面的時候每每須要美工先使用photoshop或fireworks等圖形界面設計工具進行全局設計，而後再使用進行Dreamweaver等 html頁面製做工具進行加工製做。而強大的程序邏輯及後臺處理都是由服務器端程序完成，這些程序具備較高的穩定性，其開發工具如JBuilder、 Eclipse等對View層的界面沒法很好的支持(固然那些用記事本寫界面的應用除外)，這就使得不少MVC框架的設計都沒法兩全齊美。

做位一個比較友好的MVC的框架，在簡化服務器應用開發的同時，還須要在View這一層設計上不要過多的影響到界面人員的工做，最基本的要求就是不要過 多的加入一些設計軟件不支持的標籤等元素(如Struts的不少標籤在Dreamweaver中都不支持)。這裏咱們以EasyJWeb爲例，探討在 View層如何實現比較合理的設計。

　　EasyJWeb做爲一個快速Java Web MVC框架，其設計目標不滿是要簡化軟件開發人員的代碼書寫工做，更是要能方便界面設計人員的工做。

　　固然，要使界面能跟後臺程序邏輯能融合，顯示界面及程序邏輯之間須要必定的對話協議在所不免。EasyJWeb做爲一個MVC框架，一樣也存在着這樣的對話協議，這就是EasyJWeb中的界面模板標識語言。

　　在當前發佈的版本中，EasyJWeb界面模板標識語言使用的是Apache開源的Velocity模板引擎(template engine)，固然之後會根據際須要加入更多的模板引擎以供框架應用者選擇。

Velocity是一個基於java的模板引擎（template engine），它容許任何人僅僅簡單的使用模板語言（template language）來引用由java代碼定義的對象。做爲一個比較完善的模板引擎，Velocity的功能是比較強大的，但強大的同時也增長了應用複雜 性。

　　理論上你能夠在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.something #end　　循環讀取集合list中的對象，並做相應的處理。

如：EasyJF開源論壇系統中論壇首頁顯示熱門主題的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 腳本函數(宏)調用，不推薦在界面模板中大量使用。

　　如：在EasyJF簡易訂銷管等系統中常常看到的一個排序狀態顯示的模板內容。
函數(宏)定義，通常放在最前面
#macro(orderPic $type)
#if ($orderField.equals($type))
<img src="http://images.cnblogs.com/ico/${orderType}.gif">
#end
#end

具體的調用如：<font color="#FFFFFF">頭銜#orderPic("title")</font>

總結：　
固然，在實際應用項目中，爲了實現界面的更加友好、人性化，會出現不少復、易變的需求。如根據對象的不一樣狀態，顯示不一樣的提示顏色、提示語音等功能。在這 種時候，仍然要慎用太多的模板腳本功能，大多數需求均可以經過變通的方式解決，有些信息能夠直接在對象中增長邏輯轉化信息，有些界面要求能夠經過在界面中 使用與特定界面有關的表達方式來實現，如html頁面中使用javascript、css，Wap頁面中使用WMLScript等等。只有，這樣才能確保 證你的系統核心不受界面的的影響及控制，才能更好的擴展及維護。

　　咱們但願你能成爲真正的程序高手，而不僅是精通某個處於表層的腳本語言，所以也不但願廣大Java開發人員在View層消耗太多的時間。

　　因爲水平有限，本文所談的內容有N多不合理或者須要改進的地方，懇請你們指正！

附：EasyJWeb簡介

EasyJWeb是基於java技術，應用於WEB應用程序快速開發的MVC框架，框架設計構思來源於國內衆多項目實踐，充分借簽了當前主流的開源 Web框架（Struts、JSF、Tapestry 、Webwork等），吸收了其優勢及精華，利用Velocity做爲模板頁面引擎，是一個實現了頁面及代碼徹底分離的MVC開發框架，是一個旨在於爲中 小型Web應用系統提供快速開發實踐的簡易Web框架。

　　EasyJF開源團隊於2006年初纔開始建設，所以當前整個開發團隊組建以及所發佈的做品，都顯得極不成熟。EasyJWeb仍然處於測試階段，請廣大的Java愛好者多多批評及建議,同時也很是歡迎您能加入到咱們的國產開源隊伍中。

　　EasyJWeb官方網址：www.easyjf.comEasyJF團隊官方網址：www.easyjf.com