Velocity是一個(gè)基于java的模板引擎（template engine）。它允許任何人僅僅簡單的使用模板語言（template language）來引用由java代碼定義的對(duì)象。當(dāng)Velocity 應(yīng)用于web開發(fā)時(shí)，界面設(shè)計(jì)人員可以和java程序開發(fā)人員同步開發(fā)一個(gè)遵循MVC架構(gòu)的web站點(diǎn)，也就是說，頁面設(shè)計(jì)人員可以只關(guān)注頁面的顯示效果，而由java程序開發(fā)人員關(guān)注業(yè)務(wù)邏輯編碼。Velocity將java代碼從web頁面中分離出來，這樣為web站點(diǎn)的長期維護(hù)提供了便利，同時(shí)也 為我們?cè)贘SP和PHP之外又提供了一種可選的方案。

Velocity的能力遠(yuǎn)不止web站點(diǎn)開發(fā)這個(gè)領(lǐng)域，例如，它可以從模板 （template）產(chǎn)生SQL和PostScript、XML，它也可以被當(dāng)作一個(gè)獨(dú)立工具來產(chǎn)生源代碼和報(bào)告，或者作為其他系統(tǒng)的集成組件使用。 Velocity也可以為Turbine web開發(fā)架構(gòu)提供模板服務(wù)（template service）。Velocity+Turbine提供一個(gè)模板服務(wù)的方式允許一個(gè)web應(yīng)用以一個(gè)真正的MVC模型進(jìn)行開發(fā)。

一、基本語法

1、"#"用來標(biāo)識(shí)Velocity的腳本語句，包括#set、#if 、#else、#end、#foreach、#end、#include、#parse、#macro等；

如:

#if($info.imgs) <img src="$info.imgs" border=0> #else <img src="noPhoto.jpg"> #end

2、"$"用來標(biāo)識(shí)一個(gè)對(duì)象(或理解為變量)；如：$i、$msg、$TagUtil.options(...)等。

3、"{}"用來明確標(biāo)識(shí)Velocity變量；

比如在頁面中，頁面中有一個(gè)$someonename，此時(shí)，Velocity將把someonename作為變量名，若我們程序是想在someone這個(gè)變量的后面緊接著顯示name字符，則上面的標(biāo)簽應(yīng)該改成${someone}name。

4、"!"用來強(qiáng)制把不存在的變量顯示為空白。

如當(dāng)頁面中包含$msg，如果msg對(duì)象有值，將顯示msg的值，如果不存在msg對(duì)象同，則在頁面中將顯示$msg字符。這是我們不希望的，為了把不存在的變量或變量值為null的對(duì)象顯示為空白，則只需要在變量名前加一個(gè)“!”號(hào)即可。

如：$!msg

二、在EasyJWeb中的最佳實(shí)踐

理論上你可以在EasyjWeb模板使用所有Velocity的腳本及功能，但我們不推薦你在界面模板中使用過多過復(fù)雜的腳本表達(dá)方式，在萬不得已的情況下，不要在界面模板中加入任何復(fù)雜的邏輯，更不要在界面模板中加入變量聲明、邏輯運(yùn)算符等等。

1、$!obj?　直接返回對(duì)象結(jié)果。

如：在html標(biāo)簽中顯示java對(duì)象msg的值。<p>$!msg</p>

在html標(biāo)簽中顯示經(jīng)過HtmlUtil對(duì)象處理過后的msg對(duì)象的值<p>$!HtmlUtil.doSomething($!msg)</p>

2、#if($!obj) #else #end 判斷語句

如：在EasyJWeb各種開源應(yīng)用中，我們經(jīng)常看到的用于彈出提示信息msg的例子。

#if($msg) <script> alert('$!msg'); </script> #end

上面的腳本表示當(dāng)對(duì)象msg對(duì)象存在時(shí)，輸出<script>等后面的內(nèi)容。

3、#foreach( $info in $list) $info.someList #end循環(huán)讀取集合list中的對(duì)象，并作相應(yīng)的處理。

如：EasyJF開源論壇系統(tǒng)中論(0.3)壇首頁顯示熱門主題的html界面模板腳本：

#foreach( $info in $hotList1) <a href="/bbsdoc.ejf?easyJWebCommand=show&&cid=$!info.cid" target="_blank">$!info.title</a><br> #end

上面的腳本表示循環(huán)遍歷hotList1集合中的對(duì)象，并輸出對(duì)象的相關(guān)內(nèi)容。

4、#macro(macroName)#end?腳本函數(shù)(宏)調(diào)用，不推薦在界面模板中大量使用。 Velocity中的宏我們可以理解為函數(shù)。 ①宏的定義 #macro(宏的名稱 $參數(shù)1 $參數(shù)2 …) 語句體(即函數(shù)體) #end

②宏的調(diào)用 #宏的名稱($參數(shù)1 $參數(shù)2 …)

說明：參數(shù)之間用空格隔開。

如：在使用EasyJWeb Tools快速生成的添刪改查示例中，可以點(diǎn)擊列表的標(biāo)題欄進(jìn)行升降排序顯示，這是我們?cè)贓asyJWeb應(yīng)用中經(jīng)常看到的一個(gè)排序狀態(tài)顯示的模板內(nèi)容。 函數(shù)(宏)定義，一般放在最前面

#macro(orderPic $type) #if ($orderField.equals($type)) <img src="http://images.cnblogs.com/ico/${orderType}.gif"> #end #end

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

5、包含文件#inclue("模板文件名")或#parse("模板文件名")

主要用于處理具有相同內(nèi)容的頁面，比如每個(gè)網(wǎng)站的頂部或尾部內(nèi)容。

如：#parse("/blog/top.html")或#include("/blog/top.html")

區(qū)別：

若包含的文件中有Velocity腳本標(biāo)簽，將會(huì)進(jìn)一步解析，而include將原樣顯示。

#parse只能指定單個(gè)對(duì)象。而#include可以有多個(gè)

示范代碼：

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

三、關(guān)于#set的使用

在萬不得已的時(shí)候，不要在頁面視圖自己聲明Velocity腳本變量，也就是盡量少使用#set。有時(shí)候我們需要在頁面中顯示序號(hào)，而程序?qū)ο笾杏譀]有包含這個(gè)序號(hào)屬性同，可以自己定義。如在一個(gè)循環(huán)體系中，如下所示：

#set ($i=0) #foreach($info in $list) 序號(hào):$i #set($i=$i+1) #end

四、Velocity腳本語法摘要

聲明:#set ($var=XXX)

變量引用,字面字符串,屬性引用,方法引用,字面數(shù)字,數(shù)組列表。

#set( $monkey = $bill ) ## variable reference #set( $monkey.Friend = "monica" ) ## string #set( $monkey.Blame = $whitehouse.Leak ) ## property reference #set( $monkey.Plan = $spindoctor.weave($web) ) ## method reference #set( $monkey.Number = 123 ) ##number #set( $monkey.Say = ["Not", $my, "fault"] ) ## ArrayList

算術(shù)運(yùn)算符

#set ( $foo = $bar + 3 ) #set ( $foo = $bar - 4 ) #set ( $foo = $bar * 6 ) #set ( $foo = $bar / 2 )

2、注釋:

單行## XXX?多行

#* xxx xxxx xxxxxxxxxxxx*#

References 引用的類型

3、變量 Variables

以 "$" 開頭，第一個(gè)字符必須為字母。character followed by a VTL Identifier. (a .. z or A .. Z).

變量可以包含的字符有以下內(nèi)容：

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?$與$!的區(qū)別

當(dāng)找不到username的時(shí)候，$username返回字符串"$username"，而$!username返回空字符串""

7、雙引號(hào) 與 引號(hào)

#set ($var="helo")

test"$var"?返回testhello?test'$var'?返回test'$var'

可以通過設(shè)置 stringliterals.interpolate=false改變默認(rèn)處理方式

8、條件語句

#if( $foo ) <strong>Velocity!</strong> #end #if($foo) #elseif() #else #end

當(dāng)$foo為null或?yàn)锽oolean對(duì)象的false值執(zhí)行.

9、邏輯運(yùn)算符:== && || !

10、循環(huán)語句#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

語句的嵌套

#foreach ($element in $list) ## inner foreach 內(nèi)循環(huán) #foreach ($element in $list) `This is $element. $velocityCount <br>inner<br> #end ## inner foreach 內(nèi)循環(huán)結(jié)束 ## outer foreach This is $element. $velocityCount <br>outer<br> #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導(dǎo)入腳本

#parse("me.vm" )

14、#stop 停止執(zhí)行并返回

停止執(zhí)行模板引擎并返回,把它應(yīng)用于debug是很有幫助的。

15、定義宏Velocimacros ,相當(dāng)于函數(shù) 支持包含功能

#macro( d ) <tr><td></td></tr> #end

調(diào)用?#d()

16、帶參數(shù)的宏

#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] )

18、轉(zhuǎn)義字符

如果reference被定義，兩個(gè)’\’意味著輸出一個(gè)’\’，如果未被定義，剛按原樣輸出。?

#set($email = "foo" ) $email \$email \\$email \\\$email

輸出：foo $email....

from:?http://outofmemory.cn/code-snippet/1623/Velocity-syntax-usage-summary

總結(jié)

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

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。