Velocity指令碼入門教程

     下面資料整理自網路

一、Velocity介紹

Velocity是Apache公司的開源產品，是一套基於Java語言的模板引擎，可以很靈活的將後臺資料物件與模板檔案結合在一起，說的直白一點，就是允許任何人使用模板語言引用後臺java程式碼定義的物件Velocity應用於Web開發時，介面設計人員可以和java程式開發人員同步開發一個遵循MVC架構的web站點，也就是說，頁面設計人員可以只關注頁面的顯示效果，而由Java程式開發人員關注業務邏輯編碼。Velocity將 java程式碼從web頁面中分離出來，這樣為web站點的長期維護提供了便利。

Velocity是一個基於java的模板引擎（templateengine），它允許任何人僅僅簡單的使用模板語言（template language）來引用由java程式碼定義的物件。作為一個比較完善的模板引擎，Velocity的功能是比較強大的，但強大的同時也增加了應用複雜性。

很多人下載了EasyJWeb的開源應用示例，使用EasyJWeb的目的，是在於把頁面－程式完成分開，就也就是一個專案中，程式設計師使用專業Java開發工具（如Eclipse、JBuilder等)來編寫、除錯、測試程式，頁面製作人員使用專業的網頁製作工具（如Macromedia Dreamweaver）來設計製作網頁，而兩者之間的協調通過一個規範的介面協議來解決。需要在頁面裡面加如一些標籤，來生成動態內容，這一工作可以交由網頁製作人員來完成。因為使用Velocity作為檢視，由於他的語法、功能及使用方法都比較簡單，因此一般情況下，一天以內就能讓頁面製作人員熟練掌握其用法。

二、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
　　    XXX*#

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($varin $arrays )

 // 集合包含下面三種Vector, aHashtable 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()

帶引數的巨集
　　#macro( tablerows $color $somelist )
　　#foreach( $something in $somelist )
　　 <tr><td bgcolor=$color>$something</td></tr>
　　#end
　　#end
16、範圍操作符Range Operator
　　#foreach( $foo in [1..5] )

17、"#"用來標識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

18、"$"用來標識一個物件(或理解為變數)；

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

19、"{}"用來明確標識Velocity變數；

比如在頁面中，頁面中有一個$someonename，此時，Velocity將把someonename作為變數名，若我們程式是想在someone這個變數的後面緊接著顯示name字元，則上面的標籤應該改成${someone}name。

20、"!"用來強制把不存在的變數顯示為空白。

如當頁面中包含$msg，如果msg物件有值，將顯示msg的值，如果不存在msg物件同，則在頁面中將顯示$msg字元。這是我們不希望的，為了把不存在的變數或變數值為null的物件顯示為空白，則只需要在變數名前加一個“!”號即可。如：$!msg

三、EasyJWeb建議

在介面模板中使用過多過複雜的指令碼表達方式，在萬不得已的情況下，不要在介面模板中加入任何複雜的邏輯，更不要在介面模板中加入變數宣告、邏輯運算子等等。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 指令碼函式(巨集)呼叫，不推薦在介面模板中大量使用。
　　 如：在使用EasyJWebTools快速生成的添刪改查示例中，可以點選列表的標題欄進行升降排序顯示，這是我們在EasyJWeb應用中經常看到的一個排序狀態顯示的模板內容。
　　 函式(巨集)定義，一般放在最前面，案例：

#macro(orderPic $type)
　　 #if ($orderField.equals($type))
　　 <imgsrc="http://images.cnblogs.com/ico/${orderType}.gif">
　　 #end
　　 #end
具體的呼叫如：<font color="#FFFFFF">頭銜#orderPic("title")</font>

5、包含檔案#inclue("模板檔名")或#parse("模板檔名")

　　主要用於處理具有相同內容的頁面，比如每個網站的頂部或尾部內容。如：#parse("/blog/top.html")或#include("/blog/top.html")
　　parse與include的區別在於，若包含的檔案中有Velocity指令碼標籤，將會進一步解析，而include將原樣顯示。

四、入門例子

Velocity應用於java工程時，建立完一個普通的java工程後，需要引入相應的jar包，才能讓工程支援Velocity模板引擎(velocity-1.7.jar/commons-*.jar)

1.例子一：

VelJava工程的後臺java程式碼`VelJava.java`

//建構函式  

public VelJava() throws IOException{  

    //初始化Velocity模板  

    Velocity.init();  

    //建立一個VeloctiyContext物件  

    VelocityContext context=new VelocityContext();  

    //向VelocityContext物件中放入一個鍵值對  

    context.put("list", getNames());  

    Template template=null;  

    //通過靜態方法獲取一個模板  

    template=Velocity.getTemplate("test.vm");  

    //建立一個輸出流  

    BufferedWriter writer=new BufferedWriter(new OutputStreamWriter(System.out));  

    //將模板與context中的物件結合，然後輸出  

    if(template!=null)  

        template.merge(context, writer);  

    //重新整理快取  

    writer.flush();  

    //關閉writer  

    writer.close();  

}  

//VelocityContext鍵值對中的值  

public ArrayList<String> getNames(){  

    ArrayList<String> list=new ArrayList<String>();  

    list.add("element 1");  

    list.add("element 2");  

    list.add("element 3");  

    list.add("element 4");  

    return list;  

}

備註

在這個例子中，以健值對的形式將getNames()函式的返回值存放在Velocity容器中，並給其一個鍵值為list

模板檔案的程式碼如下test.vm：

##宣告瞭一個變數  

#set( $this = "ppTest")  

##將變數列印出來  

$this is great!  

##對後臺的list進行掃描，將集合中的元素一個一個的列印出來  

#foreach( $name in $list )  

$name is showed!  

#end  

##設定一個判斷條件，將將判斷條件賦值為真  

#set( $condition = true)  

##判斷條件為真，執行  

#if ($condition)  

The condition is true!  

##判斷條件為假時，執行  

#else  

The condition is false!  

#end

備註

其中的##表示的是註釋

#set類表示的是預處理指令

$變數名錶示宣告的是一個變數

上面的程式碼註釋的已經很清楚了，如果只是應用，不需要了解更多細節的話，上面的程式碼已經夠了，從上面的程式碼中可以看出Velocity的一個好處就是模板檔案與後臺檔案可以同步開發，只要約定好一些共有的變數定義即可，在模板輸出時，由模板引擎進行變數的替換,替換之後再進行相應的輸出

例子二：Velocity動態建立模板並渲染(Java工程)

演示了在Java工程將模板渲染後以指定的編碼方式GBK輸出，同時也演示了動態建立模板，然後進行渲染

public static void main(String[] args) {  

    //初始化Velocity引擎  

    Velocity.init();  

    //獲取一個VelocityContext物件  

    VelocityContext context=new VelocityContext();  

    //向此物件容器中加入相應的鍵值對  

    context.put("name", "Velocity");  

    context.put("project", "Jakarta");  

    //StringWriter底層其實就是一個StringBuffer  

    StringWriter w=new StringWriter();  

    //將test2.vm與context進行合併，生成的最終程式碼寫入StringWriter的buf中  

    Velocity.mergeTemplate("test2.vm", "GBK",context,w);  

    //將其在控制檯上列印出來  

    System.out.println("模板:"+w);  

    //動態建立模板  

    String s="正在使用 $project $name 渲染模板";  

    w=new StringWriter();  

    /* 

     *context：對輸入的字串進行渲染 

     *w:渲染後的結果輸出的地方 

     *mystring:發生錯誤時，被用來作為錯誤檔案的名字 

     *s:包括VTL語言的輸入字串 

    */   

    Velocity.evaluate(context, w, "mystring", s);  

    //將結果進行輸出來  

    System.out.println(w);  

}

例子二的模板檔案test2.vm如下：

Hello 來自於 $name 在 $project 工程裡.

例子二與例子一極為相似，例子二的模板只不過是在程式碼中建立的，例子一中的模板是直接引用外部的test.vm檔案，從上面的程式碼中可以揣測一下Velocity是如何工作的，大概是這樣的

1、將外部的vm檔案讀入記憶體

2、Velocity模板引擎對vm檔案進行解析

3、解析之後對模板檔案中的變數進行替換，並執行vm中的相應判斷邏輯

4、執行完後，整個頁面的渲染結果就知道了，再直接輸出即可

從這裡可以看出只要前後臺程式碼的開發人員能夠約定相同的變數，則前後臺的開發完全可以並行執行

推薦文章：http://www.cnblogs.com/yasin/archive/2010/04/02/1703188.html

                 http://www.yanyulin.info/pages/2014/03/velocity_disabuse_1.html