運用Jakarta Struts的七大實(shí)戰心法
(原文 http://www.onjava.com/pub/a/onjava/2002/10/30/jakarta.html?page=1)
(作者Chuck Cavaness, 編譯 邱文宇)
編者按:當作者 Chuck Cavaness(著(zhù)有《Programming Jakarta Struts》一書(shū))所在的網(wǎng)絡(luò )公司決定采用Struts框架之后,Chuck曾經(jīng)花費了好幾個(gè)月來(lái)研究如何用它來(lái)構建公司的應用系統。本文敘述的正是作者在運用Struts過(guò)程中來(lái)之不易的若干經(jīng)驗和心得。如果你是個(gè)負責通過(guò)jsp和servlet開(kāi)發(fā)Web應用的Java程序員,并且也正在考慮采用基于Struts的構建方法的話(huà),那么你會(huì )在這里發(fā)現很多頗有見(jiàn)地同時(shí)也很有價(jià)值的信息。
1. 只在必要的時(shí)候才考慮擴展Struts框架
一個(gè)好的framework有很多優(yōu)點(diǎn),首先,它必須能夠滿(mǎn)足用戶(hù)的可預見(jiàn)的需求。為此 Struts為Web 應用提供了一個(gè)通用的架構,這樣開(kāi)發(fā)人員可以把精力集中在如何解決實(shí)際業(yè)務(wù)問(wèn)題上。其次,一個(gè)好的framework還必須能夠在適當的地方提供擴展接口,以便應用程序能擴展該框架來(lái)更好的適應使用者的實(shí)際需要。
如果Struts framework在任何場(chǎng)合,任何項目中都能很好的滿(mǎn)足需求,那真是太棒了。但是實(shí)際上,沒(méi)有一個(gè)框架聲稱(chēng)能做到這一點(diǎn)。一定會(huì )有一些特定的應用需求是框架的開(kāi)發(fā)者們無(wú)法預見(jiàn)到的。因此,最好的辦法就是提供足夠的擴展接口,使得開(kāi)發(fā)工程師能夠調整struts來(lái)更好的符合他們的特殊要求。
在Struts framework中有很多地方可供擴展和定制。幾乎所有的配置類(lèi)都能被替換為某個(gè)用戶(hù)定制的版本,這只要簡(jiǎn)單的修改一下Struts的配置文件就可以做到。
其他組件如ActionServlet和 RequestProcessor 也能用自定義的版本代替. 甚至連Struts 1.1里才有的新特性也是按照擴展的原則來(lái)設計的。例如,在異常處理機制中就允許用戶(hù)定制異常處理的句柄,以便更好的對應用系統發(fā)生的錯誤做出響應。
作為框架的這種可調整特性在它更適合你的應用的同時(shí)也在很大的程度上影響了項目開(kāi)發(fā)的效果。首先,由于您的應用是基于一個(gè)現有的成熟的、穩定的framework如Struts,測試過(guò)程中發(fā)現的錯誤數量將會(huì )大大減少,同時(shí)也能縮短開(kāi)發(fā)時(shí)間和減少資源的投入。因為你不再需要投入開(kāi)發(fā)力量用于編寫(xiě)基礎框架的代碼了。
然而, 實(shí)現更多的功能是要花費更大的代價(jià)的。我們必須小心避免不必要的濫用擴展性能, Struts是由核心包加上很多工具包構成的,它們已經(jīng)提供了很多已經(jīng)實(shí)現的功能。因此不要盲目的擴展Struts框架,要先確定能不能采用其他方法使用現有的功能來(lái)實(shí)現。 在決定編寫(xiě)擴展代碼前務(wù)必要確認Struts的確沒(méi)有實(shí)現你要的功能。否則重復的功能會(huì )導致混亂將來(lái)還得花費額外的精力清除它。
2. 使用異常處理聲明
要定義應用程序的邏輯流程,成熟的經(jīng)驗是推薦在代碼之外,用配置的方法來(lái)實(shí)現,而不是寫(xiě)死在程序代碼中的。在J2EE中,這樣的例子比比皆是。從實(shí)現EJB的安全性和事務(wù)性行為到描述JMS消息和目的地之間的關(guān)系,很多運行時(shí)的處理流程都是可以在程序之外定義的。
Struts 創(chuàng )建者從一開(kāi)始就采用這種方法,通過(guò)配置Struts的配置文件來(lái)定制應用系統運行時(shí)的各個(gè)方面。這一點(diǎn)在版本1.1的新特性上得到延續,包括新的異常處理功能。在Struts framework以前的版本中,開(kāi)發(fā)人員不得不自己處理Struts應用中發(fā)生的錯誤情況。在最新的版本中,情況大大的改觀(guān)了,Struts Framework提供了內置的一個(gè)稱(chēng)為 ExceptionHandler 的類(lèi), 用于系統缺省處理action類(lèi)運行中產(chǎn)生的錯誤。這也是在上一個(gè)技巧中我們提到的framework許多可擴展接口之一。
Struts缺省的 ExceptionHandler類(lèi)會(huì )生成一個(gè)ActionError對象并保存在適當的范圍(scope)對象中。這樣就允許JSP頁(yè)面使用錯誤類(lèi)來(lái)提醒用戶(hù)出現什么問(wèn)題。如果你認為這不能滿(mǎn)足你的需求,那么可以很方便的實(shí)現你自己的ExcepionHandler類(lèi)。
具體定制異常處理的方法和機制
要定制自己的異常處理機制,第一步是繼承org.apache.struts.action.ExceptionHandler類(lèi)。這個(gè)類(lèi)有2個(gè)方法可以覆蓋,一個(gè)是excute()另外一個(gè)是storeException(). 在多數情況下,只需要覆蓋其中的excute()方法。下面是ExceptionHandler類(lèi)的excute()方法聲明:
正如你看到的,該方法有好幾個(gè)參數,其中包括原始的異常。方法返回一個(gè)ActionForward對象,用于異常處理結束后將controller類(lèi)帶到請求必須轉發(fā)的地方去。
當然您可以實(shí)現任何處理,但一般而言,我們必須檢查拋出的異常,并針對該類(lèi)型的異常進(jìn)行特定的處理。缺省的,系統的異常處理功能是創(chuàng )建一個(gè)出錯信息,同時(shí)把請求轉發(fā)到配置文件中指定的地方去。 定制異常處理的一個(gè)常見(jiàn)的例子是處理嵌套異常。假設該異常包含有嵌套異常,這些嵌套異常又包含了其他異常,因此我們必須覆蓋原來(lái)的execute()方法,對每個(gè)異常編寫(xiě)出錯信息。
一旦你創(chuàng )建了自己的ExceptionHandler 類(lèi),就應該在Struts配置文件中的部分聲明這個(gè)類(lèi),以便讓Struts知道改用你自定義的異常處理取代缺省的異常處理.
可以配置你自己的ExceptionHandler 類(lèi)是用于A(yíng)ction Mapping特定的部分還是所有的Action對象。如果是用于A(yíng)ction Mapping特定的部分就在<action>元素中配置。如果想讓這個(gè)類(lèi)可用于所有的Action對象,可以在<global-sections> 元素中指定。例如,假設我們創(chuàng )建了異常處理類(lèi)CustomizedExceptionHandler用于所有的Action類(lèi), <global-exceptions>元素定義如下所示:
在<exception />元素中可以對很多屬性進(jìn)行設置。在本文中,最重要的屬性莫過(guò)于handler屬性, handler屬性的值就是自定義的繼承了ExceptionHandler類(lèi)的子類(lèi)的全名。 假如該屬性沒(méi)有定義,Struts會(huì )采用自己的缺省值。當然,其他的屬性也很重要,但如果想覆蓋缺省的異常處理的話(huà),handler無(wú)疑是最重要的屬性。
最后必須指出的一點(diǎn)是,你可以有不同的異常處理類(lèi)來(lái)處理不同的異常。在上面的例子中,CustomizedExceptionHandler用來(lái)處理任何java.lang.Exception的子類(lèi). 其實(shí),你也可以定義多個(gè)異常處理類(lèi),每一個(gè)專(zhuān)門(mén)處理不同的異常樹(shù)。下面的XML片斷解釋了如何配置以實(shí)現這一點(diǎn)。
在這里,一旦有異常拋出,struts framework將試圖在配置文件中找到ExceptionHandler,如果沒(méi)有找到,那么struts將沿著(zhù)該異常的父類(lèi)鏈一層層往上找直到發(fā)現匹配的為止。因此,我們可以定義一個(gè)層次型的異常處理關(guān)系結構,在配置文件中已經(jīng)體現了這一點(diǎn)。
3. 使用應用模塊(Application Modules)
Struts 1.1的一個(gè)新特性是應用模塊的概念。應用模塊允許將單個(gè)Struts應用劃分成幾個(gè)模塊,每個(gè)模塊有自己的Struts配置文件,JSP頁(yè)面,Action等等。這個(gè)新特性是為了解決大中型的開(kāi)發(fā)隊伍抱怨最多的一個(gè)問(wèn)題,即為了更好的支持并行開(kāi)發(fā)允許多個(gè)配置文件而不是單個(gè)配置文件。
注:在早期的beta版本中,該特性被稱(chēng)為子應用(sub-applications),最近的改名目的是為了更多地反映它們在邏輯上的分工。
顯然,當很多開(kāi)發(fā)人員一起參加一個(gè)項目時(shí),單個(gè)的Struts配置文件很容易引起資源沖突。應用模塊允許Struts按照功能要求進(jìn)行劃分,許多情況已經(jīng)證明這樣更貼近實(shí)際。例如,假設我們要開(kāi)發(fā)一個(gè)典型的商店應用程序??梢詫⒔M成部分劃分成模塊比如catalog(商品目錄), customer(顧客), customer service(顧客服務(wù)), order(訂單)等。每個(gè)模塊可以分布到不同的目錄下,這樣各部分的資源很容易定位,有助于開(kāi)發(fā)和部署。圖1 顯示了該應用的目錄結構。
圖 1. 一個(gè)典型的商店應用程序的目錄結構
注:如果你無(wú)需將項目劃分成多個(gè)模塊,Struts框架支持一個(gè)缺省的應用模塊。這就使得應用程序也可以在1.0版本下創(chuàng )建,具有可移植性,因為應用程序會(huì )自動(dòng)作為缺省的應用模塊。
為了使用多應用模塊功能,必須執行以下幾個(gè)準備步驟:
• 為每個(gè)應用模塊創(chuàng )建獨立的Struts配置文件。
• 配置Web 部署描述符 Web.xml文件。
• 使用org.apache.struts.actions.SwitchAction 來(lái)實(shí)現程序在模塊之間的跳轉.
創(chuàng )建獨立的Struts配置文件
每個(gè)Struts應用模塊必須擁有自己的配置文件。允許創(chuàng )建自己的獨立于其他模塊的Action,ActionForm,異常處理甚至更多。
繼續以上面的商店應用程序為例,我們可以創(chuàng )建以下的配置文件:一個(gè)文件名為struts-config-catalog.xml,包含catalog(商品目錄)、items(商品清單)、和其它與庫存相關(guān)的功能的配置信息;另一個(gè)文件名為struts- config-order.xml, 包含對order(訂單)和order tracking(訂單跟蹤)的設置。第三個(gè)配置文件是struts-config.xml,其中含有屬于缺省的應用模塊中的一般性的功能。
配置Web部署描述符
在Struts的早期版本中,我們在Web.xml中指定Struts配置文件的路徑。好在這點(diǎn)沒(méi)變,有助于向后兼容。但對于多個(gè)應用模塊,我們需要在Web部署描述符中增加新的配置文件的設定。
對于缺省的應用(包括Struts的早期版本),Struts framework 在Web.xml文件中查找帶有config的元素<init-param>,用于載入Action mapping 和其它的應用程序設定。作為例子,以下的XML片斷展現一個(gè)典型的<init-param>元素:
注:如果在現有的<init-param>元素中找不到"config"關(guān)鍵字,Struts framework將缺省地使用/WEB/struts-config.xml
為了支持多個(gè)應用模塊(Struts 1.1的新特性),必須增加附加的<init-param>元素。與缺省的<init-param>元素不同的是,附加的<init-param>元素與每個(gè)應用模塊對應,必須以config/xxx的形式命名,其中字符串xxx代表該模塊唯一的名字。例如,在商店應用程序的例子中,<init-param>元素可定義如下(注意粗體字部分):
第一個(gè) <init-param>元素對應缺省的應用模塊。第二和第三個(gè)元素分別代表非缺省應用模塊catalog 和 order。
當Struts載入應用程序時(shí),它首先載入缺省應用模塊的配置文件。然后查找帶有字符串config/xxx 形式的附加的初始化參數。對每個(gè)附加的配置文件也進(jìn)行解析并載入內存。這一步完成后,用戶(hù)就可以很隨意地用config/后面的字符串也就是名字來(lái)調用相應的應用模塊。
多個(gè)應用模塊之間調用Action類(lèi)
在為每個(gè)應用模塊創(chuàng )建獨立的配置文件之后,我們就有可能需要調用不同的模塊中Action。為此必須使用Struts框架提供的SwitchAction類(lèi)。Struts 會(huì )自動(dòng)將應用模塊的名字添加到URL,就如Struts 自動(dòng)添加應用程序的名字加到URL一樣。應用模塊是對框架的一個(gè)新的擴充,有助于進(jìn)行并行的團隊開(kāi)發(fā)。如果你的團隊很小那就沒(méi)必要用到這個(gè)特性,不必進(jìn)行模塊化。當然,就算是只有一個(gè)模塊,系統還是一樣的運作。
4. 把JSP放到WEB-INF后以保護JSP源代碼
為了更好地保護你的JSP避免未經(jīng)授權的訪(fǎng)問(wèn)和窺視, 一個(gè)好辦法是將頁(yè)面文件存放在Web應用的WEB-INF目錄下。
通常JSP開(kāi)發(fā)人員會(huì )把他們的頁(yè)面文件存放在Web應用相應的子目錄下。一個(gè)典型的商店應用程序的目錄結構如圖2所示。跟catalog (商品目錄)相關(guān)的JSP被保存在catalog子目錄下。跟customer相關(guān)的JSP,跟訂單相關(guān)的JSP等都按照這種方法存放。
圖 2.基于不同的功能 JSP 被放置在不同的目錄下
這種方法的問(wèn)題是這些頁(yè)面文件容易被偷看到源代碼,或被直接調用。某些場(chǎng)合下這可能不是個(gè)大問(wèn)題,可是在特定情形中卻可能構成安全隱患。用戶(hù)可以繞過(guò)Struts的controller直接調用JSP同樣也是個(gè)問(wèn)題。
為了減少風(fēng)險,可以把這些頁(yè)面文件移到WEB-INF 目錄下?;赟ervlet的聲明,WEB-INF不作為Web應用的公共文檔樹(shù)的一部分。因此,WEB-INF 目錄下的資源不是為客戶(hù)直接服務(wù)的。我們仍然可以使用WEB-INF目錄下的JSP頁(yè)面來(lái)提供視圖給客戶(hù),客戶(hù)卻不能直接請求訪(fǎng)問(wèn)JSP。
采用前面的例子,圖3顯示將JSP頁(yè)面移到WEB-INF 目錄下后的目錄結構
圖 3. JSP存放在 WEB-INF 目錄下更為安全
如果把這些JSP頁(yè)面文件移到WEB-INF 目錄下,在調用頁(yè)面的時(shí)候就必須把"WEB-INF"添加到URL中。例如,在一個(gè)Struts配置文件中為一個(gè)logoff action寫(xiě)一個(gè)Action mapping。其中JSP的路徑必須以"WEB-INF"開(kāi)頭。如下所示:請注意粗體部分.
這個(gè)方法在任何情況下都不失為Struts實(shí)踐中的一個(gè)好方法。是唯一要注意的技巧是你必須把JSP和一個(gè)Struts action聯(lián)系起來(lái)。即使該Action只是一個(gè)很基本的很簡(jiǎn)單JSP,也總是要調用一個(gè)Action,再由它調用JSP。
最后要說(shuō)明的是,并不是所有的容器都能支持這個(gè)特性。WebLogic早期的版本不能解釋Servlet聲明,因此無(wú)法提供支持,據報道在新版本中已經(jīng)改進(jìn)了??傊褂弥跋葯z查一下你的Servlet容器。
5. 使用 Prebuilt Action類(lèi)提升開(kāi)發(fā)效率
Struts framework帶有好幾個(gè)prebuilt Action類(lèi),使用它們可以大大節省開(kāi)發(fā)時(shí)間。其中最有用的是org.apache.struts.actions.ForwardAction 和 org.apache.struts.actions.DispatchAction.
使用 ForwardAction
在應用程序中,可能會(huì )經(jīng)常出現只要將Action對象轉發(fā)到某個(gè)JSP的情況。在上一點(diǎn)中曾提到總是由Action調用JSP是個(gè)好習慣。如果我們不必在A(yíng)ction中執行任何業(yè)務(wù)邏輯,卻又想遵循從Action訪(fǎng)問(wèn)頁(yè)面的話(huà),就可以使用ForwardAction,它可以使你免去創(chuàng )建許多空的Action類(lèi)。運用ForwardAction的好處是不必創(chuàng )建自己的Action類(lèi),你需要做的僅僅是在Struts配置文件中配置一個(gè)Action mapping。
舉個(gè)例子,假定你有一個(gè)JSP文件index.jsp ,而且不能直接調用該頁(yè)面,必須讓程序通過(guò)一個(gè)Action類(lèi)調用,那么,你可以建立以下的Action mapping來(lái)實(shí)現這一點(diǎn):
正如你看到的,當 /home 被調用時(shí), 就會(huì )調用ForwardAction 并把請求轉發(fā)到 index.jsp 頁(yè)面.
再討論一下不通過(guò)一個(gè)Action類(lèi)直接轉發(fā)到某個(gè)頁(yè)面的情況,必須注意我們仍然使用<action>元素中的forward屬性來(lái)實(shí)現轉發(fā)的目標。這時(shí)<action>元素定義如下:
以上兩種方法都可以節省你的時(shí)間,并有助于減少一個(gè)應用所需的文件數。
使用 DispatchAction
DispatchAction是Struts包含的另一個(gè)能大量節省開(kāi)發(fā)時(shí)間的Action類(lèi)。與其它Action類(lèi)僅提供單個(gè)execute()方法實(shí)現單個(gè)業(yè)務(wù)不同,DispatchAction允許你在單個(gè)Action類(lèi)中編寫(xiě)多個(gè)與業(yè)務(wù)相關(guān)的方法。這樣可以減少Action類(lèi)的數量,并且把相關(guān)的業(yè)務(wù)方法集合在一起使得維護起來(lái)更容易。
要使用DispatchAction的功能,需要自己創(chuàng )建一個(gè)類(lèi),通過(guò)繼承抽象的DispatchAction得到。對每個(gè)要提供的業(yè)務(wù)方法必須有特定的方法signature。例如,我們想要提供一個(gè)方法來(lái)實(shí)現對購物車(chē)添加商品清單,創(chuàng )建了一個(gè)類(lèi)ShoppingCartDispatchAction提供以下的方法:
那么,這個(gè)類(lèi)很可能還需要一個(gè)deleteItem()方法從客戶(hù)的購物車(chē)中刪除商品清單,還有clearCart()方法清除購物車(chē)等等。這時(shí)我們就可以把這些方法集合在單個(gè)Action類(lèi),不用為每個(gè)方法都提供一個(gè)Action類(lèi)。
在調用ShoppingCartDispatchAction里的某個(gè)方法時(shí),只需在URL中提供方法名作為參數值。就是說(shuō),調用addItem()方法的 URL看起來(lái)可能類(lèi)似于:
http://myhost/storefront/action/cart?method=addItem
其中method參數指定ShoppingCartDispatchAction中要調用的方法。參數的名稱(chēng)可以任意配置,這里使用的"method"只是一個(gè)例子。參數的名稱(chēng)可以在Struts配置文件中自行設定。
6.使用動(dòng)態(tài)ActionForm
在Struts framework中,ActionForm對象用來(lái)包裝HTML表格數據(包括請求),并返回返回動(dòng)態(tài)顯示給用戶(hù)的數據。它們必須是完全的JavaBean,并繼承.Struts 里面的ActionForm類(lèi),同時(shí),用戶(hù)可以有選擇地覆蓋兩個(gè)缺省方法。
該特性能節省很多時(shí)間,因為它可以協(xié)助進(jìn)行自動(dòng)的表現層的驗證。ActionForm的唯一缺點(diǎn)是必須為不同的HTML表格生成多個(gè)ActionForm 類(lèi)以保存數據。例如,如果有一個(gè)頁(yè)面含有用戶(hù)的注冊信息,另一個(gè)頁(yè)面則含有用戶(hù)的介紹人的信息,那么就需要有兩個(gè)不同的ActionForm類(lèi)。這在大的應用系統中就會(huì )導致過(guò)多的ActionForm類(lèi)。Struts 1.1對此做出了很好的改進(jìn),引入了動(dòng)態(tài)ActionForm類(lèi)概念
通過(guò)Struts framework中的DynaActionForm類(lèi)及其子類(lèi)可以實(shí)現動(dòng)態(tài)的ActionForm ,動(dòng)態(tài)的ActionForm允許你通過(guò)Struts的配置文件完成ActionForm的全部配置;再也沒(méi)有必要在應用程序中創(chuàng )建具體的ActionForm類(lèi)。具體配置方法是:在Struts的配置文件通過(guò)增加一個(gè)<form-bean>元素,將type屬性設定成DynaActionForm或它的某個(gè)子類(lèi)的全名。下面的例子創(chuàng )建了一個(gè)動(dòng)態(tài)的ActionForm名為logonForm,它包含兩個(gè)實(shí)例變量:username 和 password.
動(dòng)態(tài)的ActionForm可以用于A(yíng)ction類(lèi)和JSP,使用方法跟普通的ActionForm相同,只有一個(gè)小差別。如果使用普通的ActionForm對象則需要提供get 和 set方法取得和設置數據。以上面的例子而言,我們需要提供getUsername() 和 setUsername()方法取得和設置username變量,同樣地有一對方法用于取得和設置password變量.
這里我們使用的是DynaActionForm,它將變量保存在一個(gè)Map類(lèi)對象中,所以必須使用DynaActionForm 類(lèi)中的get(name) 和 set(name)方法,其中參數name是要訪(fǎng)問(wèn)的實(shí)例變量名。例如要訪(fǎng)問(wèn)DynaActionForm中username的值,可以采用類(lèi)似的代碼:
String username = (String)form.get("username");
由于值存放在一個(gè)Map對象,所以要記得對get()方法返回的Object對象做強制性類(lèi)型轉換。
DynaActionForm有好幾個(gè)很有用的子類(lèi)。其中最重要的是DynaValidatorForm ,這個(gè)動(dòng)態(tài)的ActionForm和Validator 一起利用公共的Validator包來(lái)提供自動(dòng)驗證。這個(gè)特性使你得以在程序代碼之外指定驗證規則。將兩個(gè)特性結合使用對開(kāi)發(fā)人員來(lái)說(shuō)將非常有吸引力。
7. 使用可視化工具
自從Struts 1.0 分布以來(lái),就出現了不少可視化工具用于協(xié)助創(chuàng )建,修改和維護Struts的配置文件。配置文件本身是基于XML格式,在大中型的開(kāi)發(fā)應用中會(huì )增大變得很笨拙。為了更方便的管理這些文件,一旦文件大到你無(wú)法一目了然的時(shí)候,建議試著(zhù)采用其中的一種GUI 工具協(xié)助開(kāi)發(fā)。商業(yè)性的和開(kāi)放源代碼的工具都有不少,表1列出了可用的工具和其相關(guān)鏈接,從那里可以獲取更多信息。
表 1. Struts GUI 工具
相關(guān)資源
要獲取更為全面的Struts GUI 工具列表 (包括免費的和商業(yè)性的), 請訪(fǎng)問(wèn) Struts resource page.