下面資料整理自網絡
一、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