Portlet API參考實現的祕密

概要
 在Stefan Hepper和Stephan Hesmer的portlet系列文章的第二部分中,作者把着筆點從Portlet API的基礎概要介紹轉移到了Portlet API的參考實現(RI reference implementation也就是Pluto)的細節描述。作者還提供了一系列portlet的實例來說明怎樣擴展Portlet API的標準函數。
企業portal提供商使用可插的用戶接口組件(portlets)向信息系統提供表示層。不幸的是,以前的提供商都只定義了自己的portlet API,在整個行業之中互不相容。爲了標準化整個行業進程,Java團體發佈了Java規範要求(JSR)168:Portlet規範。
這篇系列文章的第一部分介紹了JSP 168的細節。第二部分重點放在portlet API的參考實現(RI)上,也就是Pluto。此外還提供了一個portlet的實例,讀者可以通過這個實例來學習。
文章第一節描述了RI的體系結構,包括portlet容器的可拆卸性的概念和怎樣在其他項目中重用portlet容器。第二節介紹了RI的安裝和使用,以及怎樣快速配置portlet。其中文章還包括一個逐步深入的實例。
注意:你可以通過文章之後的資源鏈接下載原代碼
 
Pluto的體系結構
    讓我們先來看一下Pluto的體系結構和一些基本的概念。我們先簡要的說明portal的參考實現和portlet容器在整個portal體系結構中的位置。接下來我們在細節方面研究Pluto的體系結構。最後,我們看一下在portlet容器裏很有趣的:portlet 展開。
 
關於portal
       Pluto一般用來演示Portlet API如何工作以及向開發者提供一個測試portlets的實例平臺。然而,如果沒有驅動來運行和測試portlet容器有點麻煩。Pluto的簡單portal組件只是架構於portlet容器,它只滿足了JSR 168的基本要求。(相比之下,Apache的開源項目Jetspeed就要專業的多。Jetspeed將着重中在了portal本身而非portlet容器之上,並且更多的考慮了其他團體的需求。)
圖一描述了portal的基本體系結構。Portal的網絡應用程序處理客戶端請求,從用戶的當前頁面得到portlets,之後調用portlet容器以獲得每個portlet的內容。portal使用Portlet 容器的 Invoker API來訪問 portlet容器,從 portal看來,portlet 容器的主要接口是支持基於請求的方法調用 portlets。容器用戶要想獲得portal的相關信息則必須實現portlet容器的Provider SPI (Service Provider Interface)的callback接口。最終,portlet容器通過portlet API調用所有portlet。
 
 
圖一:Pluto中的一個簡單的portal的結構
 
Portlet容器
   
     Portlet容器是portlet的運行環境,也是每個portal的組成核心。它需要有關portal本身的信息,且它必須重用自身的公共代碼。因此,portlet容器和其他portal組件是完全分離的。這就是說,你可以將獨立的portlet容器嵌入任意的portal,只要你滿足portlet容器的條件,比方說實現所有的SPI。
Portlet容器的 Invoker API,或者叫入口點,扮演了portlet容器的主調用接口的角色。Portlet容器的Invoker API將portlet容器的生存週期(init,destroy)和基於請求的調用方法(initPage(),performTitle(),portletService()等等)結合了起來。因爲portlet容器最後調用portlet的方法名有點類似portlet API的主portlet接口,不同的是是否必須要傳遞portlet定義符。正是因爲這個附加的portlet定義符,portlet容器才能正確的調用portlet。
除了要用API訪問portlet容器之外,portal還必須擴展portlet容器定義的SPI。因此,RI引入了容器服務:在容器註冊過的可拆卸組件提供基礎功能並且可擴充。RI包含如下一些容器內的自建服務(前四個必須在運行portlet容器時實現,最後一個是可選的):
l 信息提供器:給portlet容器提供portal和portal框架的信息。通過這個接口來獲得信息和存儲portal信息。這些信息包括導航欄裏的URL、portlet上下文、portlet模式和窗口狀態控制。
l 工廠管理器:定義了怎麼怎樣通過工廠方法來獲得一個具體實現。(一個標準的portal應該已經存在一個實現。)
l 日誌服務:定義了一個日誌工具(一個標準的portal應該已經存在一個實現)。
l 配置服務:定義了怎麼樣獲得配置參數(一個標準的portal應該已經存在一個實現)。
l 屬性管理器(可選):屬性管理器接口的實現允許處理JSR168規範中定義的屬性。
嚴格的說,portlet對象模型也是SPI中的一部分,只是它在SPI中佔有一個特殊的地位。Portlet對象模型處理所有的potlet對象,他由一個交織在一起的接口集合組成。因此,不能把他和容器服務分開來考慮。
 
 
圖二:portlet容器結構
 
Portlet的部署
 
   portlet 容器 架構在servlet容器之上並且增強了它的功能。爲了實現它,portlet 容器將原始servlet 加入每一個portlet應用程序的war文件中,這一點我們在圖三3中有所描述。部署portlet組件時,先取得原始的war文件,然後向其中加入一個新的或者修改原有的web.xml,並且加入一個servlet作爲一個調用點來包裝每個portlet。之後, portlet的部署器(?這個原文是Then the portlet deployment passes the modified war file to the application server deployment)會傳遞一個修改過的war文件到應用服務器,將其部署到應用服務器系統。在portlet的調用過程中,portlet容器調用添加進去的servlet,作爲部署portlet的war文件的入口點。
 
 
圖三:RI中portlet的部署
 
Pluto和WSRP標準
 
   正像第一部分所描述的那樣,JSR 168與遠程portlet網絡服務(the Web Services for Remote Portlets (WSRP))標準緊密結合。幾乎同時形成的這兩種標準發佈了開源實現,實現了在各自的規範中描述必要的功能。作爲共有的目標,兩種標準努力能夠在一起更好的合作。現在,portlet容器可以很好的運行WSRP portlet。
Pluto可以在一個portal中運行多個portlet容器。從而Pluto的portlet容器可以被初始化多次。更重要的是,可以用不同的方式來初始化它。每一個portlet容器可以使用SPI的不同實現。
 
RI的安裝
 
   你會發現Pluto的安裝過程非常簡單。執行install命令,build目錄/build下的install.bat或者install.sh。接下來安裝程序會提示你指定Tomcat的安裝目錄。(注意:在MS windows下文件分隔符不是反斜槓。)
在這之後,安裝進程會創建RI和所有portlet,安裝portlet到指定的Tomcat目錄。安裝完成後請查看文檔以確定完成了所有必要的手工設置工作。
現在可以啓動Tomcat,通過http://localhost:8080/pluto/portal來訪問RI了。
就是這麼簡單!
 
怎樣部署portlet
 
      在Pluto中部署portlet和它的安裝一樣的簡單。只要記住你必須首先安裝了Pluto,它正確的設置了prepareRun.properties。這是部署過程所必須的。在命令提示符下轉到build目錄,輸入命令deployPortlet.bat , 用portlet war文件做參數,比如:
deployPortlet.bat C:/pluto/portlets/bookmark_04/driver/bookmark_04.war
 
Portlet實例
     我們來看一個portlet的例子,Bookmark。它充分利用了Portlet API並且闡明瞭我們學到的概念。我們以一個簡單的例子開始,我們在每一節一步步擴展這個Bookmark portlet,最後我們將幾乎用到所有的portlet API,把它做成一個高級的portlet。
Bookmark portlet:版本一
第一個Bookmark portlet用到了Portlet API中如下的一些特性:
l Portlet API 接口The Portlet API interface
l Java服務器頁面(jsp)JavaServer Pages (JSP) pages
l Portlet API標籤庫The Portlet API tag libraries
l 部署描述符Deployment descriptors
第一個Bookmark portlet的兩個JSP頁面分別顯示和編輯模式。每個JSP頁面只是簡單的顯示了portlet的當前portlet模式和windwos狀態。爲了顯示這些信息,我們用到了Portlet API標籤庫(只是部分程序代碼,請下載全部代碼,不然很難理解:譯者注):
 
public void doView (RenderRequest request,
RenderResponse response) throws PortletException, IOException {
        response.setContentType("text/html");       
        String jspName = getPortletConfig().getInitParameter("jspView");
PortletRequestDispatcher rd =
                           getPortletContext().getRequestDispatcher(jspName);
        rd.include(request,response);
    }
接下來的代碼是例子中的一個簡單的JSP 頁面(即view.jsp:譯者注):
<%@ page session="false" %>
<%@ page import="javax.portlet.*"%>
<%@ page import="java.util.*"%>
<%@ taglib uri='/WEB-INF/tld/portlet.tld' prefix='portlet'%>
<portlet:defineObjects/>
 
Hello,<br>
I am the bookmark portlet.<br>
<br>
Current Portlet Mode: <%=portletRequest.getPortletMode()%><br>
Current Window State: <%=portletRequest.getWindowState()%><br>
<br>
Bookmark portlet:版本二
 第二個Bookmark portlet進一步深入了Portlet API 的概念。除了第一例子所使用到的Portlet API 特性,它增加了:
l 動作處理Action handling
l Portlet 參數 Portlet preferences
l 驗證參數 A preferences validator
l 在部署描述符中預定義參數 Predefined preferences in the deployment descriptor
在第二個Bookmark例子裏,兩個新的JSP頁面替代了版本一中的。首先,edit.jsp允許通過portlet動作添加和刪除書籤。在這個JSP頁面中輸入的書籤將作爲portlet參數存放。其次,view.jsp 以超鏈接顯示出作爲portlet參數存放的書籤。
Bookmark portlet:版本三
 新增用到的特性:
l 地區性部署描述符 Localizable deployment descriptor
l 資源包ResourceBundles
現在部署描述符和JSP頁面從資源包裏(ResourceBundles)獲得可顯示的字符集,他們都可以支持英文和德文了。
Bookmark portlet:版本四
 最終的這個portlet例子通過portlet API傳遞遞交參量(render parameters)示範了導航的概念(the navigational state concept )。在版本四里有七個書籤,但默認一頁只顯示四個,如圖四所示。通過點擊next和back的超鏈接,用戶可以導航到向前或者向後的五個書籤。初始點將被初始化爲遞交參量,使得用戶可以使用瀏覽器的刷新、後退和前進按鈕。
 
 Bookmark portlet版本四的界面
 
Portlet複習
  
   象你所看到的那樣,portlet規範的參考實現包括兩個部分:portal和portlet容器。Portal作爲一個簡單的運行portlet容器的測試驅動。Portlet容器作爲一個能迅速使用到其他portal(比如jetspeed)裏的普通組件。
    這個portlet實例用到了許多portlet API裏的很重要的概念。你可以用所有portlet API和servlet API的特性來擴展這個實例。比方說你可以用一個servlet在新窗口中輸出其他有用的信息,如一個打印預覽。還可以通過Http會話與portlet進行交互。實際上,因爲portlet是一個強大的技術,能用他實現的功能是無窮無盡的。
 
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章