|
EasyJWeb－Velocity腳本簡(jiǎn)明教程
“簡(jiǎn)易,、實(shí)用才是硬道理”,、“讓J2EE應(yīng)用開發(fā)變得更加輕松,、簡(jiǎn)單”
很多人下載了EasyJWeb的開源應(yīng)用示例,，但是對(duì)動(dòng)態(tài)頁面模板文件中的標(biāo)簽使用不是很熟悉,，這里簡(jiǎn)單介紹一下,。EasyJWeb特定把視圖限定為Velocity,，因?yàn)槲覀冇X得在Velocity在表現(xiàn)上從可維護(hù)性、簡(jiǎn)潔性乃靈活性上,，比JSP及其它視力技術(shù)表現(xiàn)強(qiáng)得多,。雖然我們可以非常簡(jiǎn)單把EasyJWeb擴(kuò)展成支持多種視力技術(shù)，但當(dāng)前我們不打算這樣做,！
使用EasyJWeb的目的,，是在于把頁面－程序完成分開,，就也就是一個(gè)項(xiàng)目中,，程序員使用專業(yè)Java開發(fā)工具（如Eclipse、JBuilder等)來編寫,、調(diào)試,、測(cè)試程序，頁面制作人員使用專業(yè)的網(wǎng)頁制作工具（如Macromedia Dreamweaver）來設(shè)計(jì)制作網(wǎng)頁,，而兩者之間的協(xié)調(diào)通過一個(gè)規(guī)范的接口協(xié)議來解決,。需要在頁面里面加如一些標(biāo)簽,，來生成動(dòng)態(tài)內(nèi)容，這一工作可以交由網(wǎng)頁制作人員來完成,。因?yàn)槭褂肰elocity作為視圖,，由于他的語法、功能及使用方法都比較簡(jiǎn)單,，因此一般情況下,，一天以內(nèi)就能讓頁面制作人員熟練掌握其用法。
Velocity是一個(gè)基于java的模板引擎（template engine）,，它允許任何人僅僅簡(jiǎn)單的使用模板語言（template language）來引用由java代碼定義的對(duì)象,。作為一個(gè)比較完善的模板引擎，Velocity的功能是比較強(qiáng)大的,，但強(qiáng)大的同時(shí)也增加了應(yīng)用復(fù)雜性,。
一、基本語法
1,、"#"用來標(biāo)識(shí)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 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)算符等等,。
在EasyJWeb中,，我們提供了五條基本的模板腳本語句，基本上就能滿足所有應(yīng)用模板的要求,。這四條模板語句很簡(jiǎn)單,，可以直接由界面設(shè)計(jì)人員來添加。在當(dāng)前很多EasyJWeb的應(yīng)用實(shí)踐中,，我們看到,，所有界面模板中歸納起來只有下面四種簡(jiǎn)單模板腳本語句即可實(shí)現(xià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)?？吹降挠糜趶棾鎏崾拘畔sg的例子。
#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)用，不推薦在界面模板中大量使用,。
如：在使用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="/images/ico/${orderType}.gif">
#end
#end
具體的調(diào)用如：<font color="#FFFFFF">頭銜#orderPic("title")</font> 5,、包含文件#inclue("模板文件名")或#parse("模板文件名")
主要用于處理具有相同內(nèi)容的頁面,，比如每個(gè)網(wǎng)站的頂部或尾部?jī)?nèi)容。
使用方法,，可以參考EasyJF開源Blog及EasyJF開源論壇中的應(yīng)用,！
如：#parse("/blog/top.html")或#include("/blog/top.html")
parse與include的區(qū)別在于，若包含的文件中有Velocity腳本標(biāo)簽,，將會(huì)進(jìn)一步解析,，而include將原樣顯示。
三,、關(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腳本語法摘要
1,、聲明:#set ($var=XXX)
左邊可以是以下的內(nèi)容
Variable reference
String literal
Property reference
Method reference
Number literal #set ($i=1)
ArrayList #set ($arr=["yt1","t2"])
算術(shù)運(yùn)算符 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
#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導(dǎo)入腳本
#parse("me.vm" ) 14,、#stop 停止執(zhí)行并返回 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] )
附：《淺析MVC框架中View層的優(yōu)雅設(shè)計(jì)及實(shí)例》
作者：EasyJF開源團(tuán)隊(duì) 大峽
在基于B/S的應(yīng)用程序開發(fā)中，從基本的技術(shù)分工上來說就是兩大塊,，一是軟件顯示界面,，另一個(gè)是程序邏輯。在N年前的腳本語言時(shí)代,，無論是asp,、php還是jsp，我們基本是都是把這兩者柔和在一起的,。盡管我們想方設(shè)法做好很多函數(shù)或者包含文件來努力達(dá)到軟件的復(fù)用,，但仍然無法滿足多變的用戶需求,這主要是因?yàn)橐郧暗募兡_本編碼方式無法很好支持及應(yīng)用面向?qū)ο?OO)領(lǐng)域中的強(qiáng)大功能。 在常見的B/S軟件項(xiàng)目中,，界面的設(shè)計(jì)包括html界面,、Wap界面及其它由文本字符協(xié)議為基本表示的界面等。以我們接觸最多的html頁面為例子,，在做這些界面的時(shí)候往往需要美工先使用photoshop或fireworks等圖形界面設(shè)計(jì)工具進(jìn)行全局設(shè)計(jì),，然后再使用進(jìn)行Dreamweaver等html頁面制作工具進(jìn)行加工制作。而強(qiáng)大的程序邏輯及后臺(tái)處理都是由服務(wù)器端程序完成,，這些程序具有較高的穩(wěn)定性,，其開發(fā)工具如JBuilder、Eclipse等對(duì)View層的界面無法很好的支持(當(dāng)然那些用記事本寫界面的應(yīng)用除外),，這就使得很多MVC框架的設(shè)計(jì)都無法兩全齊美,。 作位一個(gè)比較友好的MVC的框架，在簡(jiǎn)化服務(wù)器應(yīng)用開發(fā)的同時(shí),，還需要在View這一層設(shè)計(jì)上不要過多的影響到界面人員的工作,，最基本的要求就是不要過多的加入一些設(shè)計(jì)軟件不支持的標(biāo)簽等元素(如Struts的很多標(biāo)簽在Dreamweaver中都不支持)。這里我們以EasyJWeb為例,，探討在View層如何實(shí)現(xiàn)比較合理的設(shè)計(jì),。 EasyJWeb作為一個(gè)快速Java Web MVC框架，其設(shè)計(jì)目標(biāo)不盡是要簡(jiǎn)化軟件開發(fā)人員的代碼書寫工作,，更是要能方便界面設(shè)計(jì)人員的工作,。 當(dāng)然，要使界面能跟后臺(tái)程序邏輯能融合,，顯示界面及程序邏輯之間需要一定的對(duì)話協(xié)議在所難免,。EasyJWeb作為一個(gè)MVC框架,，同樣也存在著這樣的對(duì)話協(xié)議，這就是EasyJWeb中的界面模板標(biāo)識(shí)語言,。 在當(dāng)前發(fā)布的版本中,，EasyJWeb界面模板標(biāo)識(shí)語言使用的是Apache開源的Velocity模板引擎(template engine)，當(dāng)然以后會(huì)根據(jù)際需要加入更多的模板引擎以供框架應(yīng)用者選擇,。 Velocity是一個(gè)基于java的模板引擎（template engine）,，它允許任何人僅僅簡(jiǎn)單的使用模板語言（template language）來引用由java代碼定義的對(duì)象,。作為一個(gè)比較完善的模板引擎,，Velocity的功能是比較強(qiáng)大的，但強(qiáng)大的同時(shí)也增加了應(yīng)用復(fù)雜性,。 理論上你可以在EasyjWeb模板使用所有Velocity的腳本及功能,，但我們不推薦你在界面模板中使用過多過復(fù)雜的腳本表達(dá)方式，在萬不得已的情況下,，不要在界面模板中加入任何復(fù)雜的邏輯,，更不要在界面模板中加入變量聲明、邏輯運(yùn)算符等等,。 在EasyJWeb中,，我們提供了四條基本的模板腳本語句，基本上就能滿足所有應(yīng)用模板的要求,。這四條模板語句很簡(jiǎn)單,，可以直接由界面設(shè)計(jì)人員來添加。在當(dāng)前很多EasyJWeb的應(yīng)用實(shí)踐中,，我們看到,，所有界面模板中歸納起來只有下面四種簡(jiǎn)單模板腳本語句即可實(shí)現(xià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)?？吹降挠糜趶棾鎏崾拘畔sg的例子。
#if($msg)
<script>
alert('$!msg');
</script>
#end
上面的腳本表示當(dāng)對(duì)象msg對(duì)象存在時(shí),，輸出<script>等后面的內(nèi)容,。 3、#foreach( $info in $list) $info.something #end 循環(huán)讀取集合list中的對(duì)象,，并作相應(yīng)的處理,。
如：EasyJF開源論壇系統(tǒng)中論壇首頁顯示熱門主題的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)用,，不推薦在界面模板中大量使用。 如：在EasyJF簡(jiǎn)易訂銷管等系統(tǒng)中經(jīng)?？吹降囊粋€(gè)排序狀態(tài)顯示的模板內(nèi)容,。
函數(shù)(宏)定義，一般放在最前面
#macro(orderPic $type)
#if ($orderField.equals($type))
<img src="/images/ico/${orderType}.gif">
#end
#end 具體的調(diào)用如：<font color="#FFFFFF">頭銜#orderPic("title")</font>
總結(jié)：
當(dāng)然,，在實(shí)際應(yīng)用項(xiàng)目中,，為了實(shí)現(xiàn)界面的更加友好、人性化,，會(huì)出現(xiàn)很多復(fù),、易變的需求。如根據(jù)對(duì)象的不同狀態(tài),，顯示不同的提示顏色,、提示語音等功能。在這種時(shí)候,，仍然要慎用太多的模板腳本功能,，大多數(shù)需求都可以通過變通的方式解決，有些信息可以直接在對(duì)象中增加邏輯轉(zhuǎn)化信息,，有些界面要求可以通過在界面中使用與特定界面有關(guān)的表達(dá)方式來實(shí)現(xiàn),，如html頁面中使用javascript、css,，Wap頁面中使用WMLScript等等,。只有，這樣才能確保證你的系統(tǒng)核心不受界面的的影響及控制,，才能更好的擴(kuò)展及維護(hù),。 我們希望你能成為真正的程序高手，而不只是精通某個(gè)處于表層的腳本語言,，因此也不希望廣大Java開發(fā)人員在View層消耗太多的時(shí)間,。 由于水平有限，本文所談的內(nèi)容有N多不合理或者需要改進(jìn)的地方,，懇請(qǐng)大家指正,！ 附：EasyJWeb簡(jiǎn)介 EasyJWeb是基于java技術(shù)，應(yīng)用于WEB應(yīng)用程序快速開發(fā)的MVC框架,，框架設(shè)計(jì)構(gòu)思來源于國(guó)內(nèi)眾多項(xiàng)目實(shí)踐,，充分借簽了當(dāng)前主流的開源Web框架（Struts、JSF,、Tapestry ,、Webwork等），吸取了其優(yōu)點(diǎn)及精華,，利用Velocity作為模板頁面引擎,，是一個(gè)實(shí)現(xiàn)了頁面及代碼完全分離的MVC開發(fā)框架,，是一個(gè)旨在于為中小型Web應(yīng)用系統(tǒng)提供快速開發(fā)實(shí)踐的簡(jiǎn)易Web框架。 EasyJF開源團(tuán)隊(duì)于2006年初才開始建設(shè),，因此當(dāng)前整個(gè)開發(fā)團(tuán)隊(duì)組建以及所發(fā)布的作品,，都顯得極不成熟。EasyJWeb仍然處于測(cè)試階段,，請(qǐng)廣大的Java愛好者多多批評(píng)及建議,同時(shí)也非常歡迎您能加入到我們的國(guó)產(chǎn)開源隊(duì)伍中,。
|
