【51CTO精選譯文】當你訪問iGoogle或是myYahoo!一類的門戶時，是否會對這種個性化門戶界面的實現方式感到好奇呢？實現這種“組件式”門戶的技術叫做Portlet。隨著Portlet相關規范的統一，這種技術現在也被用于企業內部網站（企業門戶）以及其他商業或個人網站。下面，我們將進行一次簡短的Portlet入門介紹與教程。

Java Portlet的歷史

自2003年最初的JSR 168規范發布以來，Portlet開發在企業和開源社區中都獲得了積極響應。2008年6月發布了JSR 286規范，標志著Portlet開發技術已經非常成熟。截至目前已經有不止20個開源Portlet容器和門戶產品可用，如SUN的Liferay Portal、eXo Platform和Jakarta Pluto等，也有來自主流軟件廠商的商業化產品，如Vignette Portal、IBM WebSphere Portal、Sun OpenPortal和Oracle Portal（以前叫做BEA WebLogic Portal）等。

Web門戶基礎

那么，什么是門戶呢？傳統的觀點認為Web分為三類：Web網站，搜索引擎和門戶。Web網站一般放置個人主頁或公司主頁，而搜索引擎是網絡爬蟲，它索引個人和企業網頁，以便于人們搜索，門戶就象一個大雜燴，將各種有關或無關的東西全部糅合到一塊（目前許多搜索引擎如Yahoo.com和MSN也是門戶）。隨著門戶的演變，出現了一些新的特征，如保存用戶的參數設置和其它自定義信息，用戶也可以配置門戶記住他們的設置，如背景色，顯示記錄條數等。支持自定義可以讓不同的用戶擁有個性化的門戶，每個人訪問門戶時界面顯示的內容可能完全不一樣，如A看到的是新聞和股票，B看到的是娛樂和天文學。如圖1所示。

 
圖 1 Yahoo門戶：門戶自定義讓門戶記住用戶的參數設置

經過自定義后，不同種類的信息摻和在一起形成一個非常現代化的頁面，目前最流行的做法是在門戶上放置多個矩形框，每個矩形框代表一個Portlet。Wikipedia將門戶定義為“以統一的方式顯示來自不同地方的信息”，將Portlet定義為“可插拔的用戶界面組件”。

門戶的目標就是為不同用戶定制顯示不同的Portlet，以滿足用戶個性化的需求，這樣做可以粘住用戶。經過這幾年的發展，門戶的應用已經擴大到企業內部中去了，包括內部門戶，B2B等形式，如企業財務門戶將各種財務信息聚合到一起，分別以Portlet形式展示，如投資組合、401K計劃、信用卡、銀行賬戶等，財務部門人員就可以一次性獲得大量的財務數據。

企業門戶和Portlet容器

那么門戶和Portlet容器是什么關系呢？簡答：門戶是Portlet容器的容器。Portlet容器是根據門戶提供的Portlet標準API實現的供Portlet運行的環境，依靠這個環境，或者說平臺，Portlet可以被實例化，使用，最終被處理掉(destroyed)。Java Portlet容器不是象Servlet容器那樣標準的獨立的容器，相反，它是在Java Servlet容器上實現的，并會重用Java Servlet的功能。從技術角度來說，Portlet容器可以看作是Portlet和門戶之間的接口。

早期的Web門戶都是采用封閉式開發的，自家開發的Portlet只能在一個特定的Portlet容器中運行，不具有很好的兼容性，遇到新項目或需求變化，開發人員不得不重新修改Portlet代碼。這種情況直到2003年SUN發布JSR 168規范后才得到改善，雖說這個規范也不完美，但它提供了一個標準Portlet API，定義了Portlet生命周期和其它重要屬性。即使到了今天，很多Portlet和Portlet容器都仍然遵循JSR 168或2008年發布的JSR 286規范，凡遵循這些規范編寫的Portlet幾乎都有很好的移植性。

提示：IBM也開發了自家的WebSphere portal，并且公開了API，IBM的API和SUN的API很類似，但最新的版本中，IBM放棄了自家的API，完全遵循JSR 168和JSR 286規范了。

現代Portlet容器可以用來構建企業內部網站（企業門戶），商業網站或個人網站，大多數都實現了開箱即用的功能，如國際化支持，工具和內容管理，基于角色的授權，單點登錄（SSO）支持，搜索和標簽支持等。圖2顯示了一個正在運行的Portlet容器示例。

 
圖 2 Apache Jetspeed門戶：包括一個日歷Portlet

用戶可以拖動日歷Portlet的位置，如圖3所示。

 
圖 3 移動日歷Portlet

#p#

開發一個Portlet

下面這部分將介紹如何進行簡單的Portlet開發。首先創建一個標準的Java項目，然后創建一個portlet.xml文件，在這個文件中定義哪些Portlet對哪些容器有效，以及在實例化時需要使用哪些類，但這個文件并沒有定義如何注冊和識別Portlet。

圖4顯示了一個示例Portlet項目的目錄結構。

 
圖 4 Portlet項目結構示例

下面的portlet.xml定義了一個Portlet：

< ?xml version="1.0" encoding="UTF-8"?> 
< portlet-app xmlns=  
  "http://java.sun.com/xml/ns/portlet/portlet-app_1_0.xsd" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xsi:schemaLocation=  
    "http://java.sun.com/xml/ns/portlet/portlet-app_1_0.xsd" 
    version="1.0"> 
    < portlet> 
      < portlet-name>QuickSearch< /portlet-name> 
      < portlet-class> 
        org.springframework.web.portlet.DispatcherPortlet  
      < /portlet-class> 
      < init-param> 
        < name>contextConfigLocation< /name> 
        < value>/WEB-INF/context/portlet/QuickSearchDefinition.xml< /value> 
      < /init-param> 
      < supports> 
        < mime-type>text/html< /mime-type> 
        < portlet-mode>view< /portlet-mode> 
      < /supports> 
      < portlet-info> 
        < title>Quick Search< /title> 
      < /portlet-info>        
    < /portlet>      
< /portlet-app> 
 

從上面的內容可以看出portlet.xml指定contextConfigLocation為Spring類的初始化參數。

列表1顯示了完整的contextConfigLocation文件的內容。

< ?xml version="1.0" encoding="UTF-8"?> 
< beans xmlns="http://www.springframework.org/schema/beans" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xmlns:aop="http://www.springframework.org/schema/aop" 
  xsi:schemaLocation="  
   http://www.springframework.org/schema/beans   
   http://www.springframework.org/schema/beans/spring-beans-2.0.xsd  
   http://www.springframework.org/schema/aop   
   http://www.springframework.org/schema/aop/spring-aop-2.0.xsd  
     
  < bean id="quickEntitySearchController"   
    class="com.portlet.controller.QuickSearchController"   
    parent="basePageController">   
    < property name="sessionForm">< value>true< /value>< /property>   
 
    < !-- Keep command object throughout session --> 
    < property name="commandName" value="commandObject"/> 
    < property name="commandClass"   
      value="com.portlet.command.commandObject"/> 
    < property name="formView">< value>quick.search< /value>< /property> 
    < property name="successView">< value>quick.search< /value>< /property> 
    < property name="bindOnNewForm">< value>true< /value>< /property>       
    < property name="quickServiceClient" ref="quickServiceClient"/> 
  < /bean>     
     
  < bean id="portletModeParameterHandlerMapping" class="  
    org.springframework.web.portlet.handler.  
    PortletModeParameterHandlerMapping"> 
    < property name="order" value="10"/> 
    < property name="interceptors"> 
      < list> 
        < ref bean="parameterMappingInterceptor" /> 
      < /list> 
    < /property> 
 
    < property name="portletModeParameterMap"> 
      < map> 
        < entry key="view"> 
          < map> 
            < entry key="basePageAction"> 
              < ref bean="quickSearchController"/> 
            < /entry> 
          < /map> 
        < /entry> 
      < /map> 
    < /property> 
  < /bean> 
     
  < bean id="portletModeHandlerMapping" class=  
    "org.springframework.web.portlet.handler.PortletModeHandlerMapping"> 
    < property name="interceptors"> 
      < list> 
        < ref bean="parameterMappingInterceptor" /> 
      < /list> 
    < /property> 
    < property name="portletModeMap"> 
      < map> 
        < entry key="view">< ref bean="quickSearchController"/>< /entry> 
      < /map> 
    < /property> 
  < /bean> 
< /beans> 
 

接下來就是編寫Java代碼實現控制器，視圖和Portlet處理程序了。視圖是一個JSP頁面，控制器和Portlet處理程序是Java類。在控制器和處理程序的幫助下，從不同數據源提取數據，如Web Service，數據庫或feed等，你可以通過命令模式將這些數據傳給視圖，運輸工具使用commandObject。下面的代碼展示了如何使用Portlet API獲取數據并返回給視圖層。

@Override 
protected ModelAndView handleRenderRequestInternal(  
   RenderRequest request, RenderResponse response) throws Exception   
{        
   logger.info ("Inside Controller handleRenderRequestInternal");        
   Map< String, CommandObject> model = new   
     HashMap< String, CommandObject>();     
   CommandObject commandObject =   
     (CommandObject)request.getPortletSession().getAttribute(  
     CommandObject.COMMAND_NAME,PortletSession.APPLICATION_SCOPE);  
   if (commandObject == null){  
      commandObject = new CommandObject();  
   }  
              
   // logic to get the data and put it in the commandObject   
   // should be here...  
              
   String view = getFormView();  
   model.put("commandObject", commandObject);  
   ModelAndView mav = new ModelAndView(view, model);  
   return mav;    
}  
@Override 
public void onSubmitAction (final ActionRequest request,   
  final ActionResponse response, final Object command,  
  final BindException bindException) throws Exception   
{  
   logger.info ("Inside onSubmitAction");  
   // Set the form bean into session so that it will be available   
   CommandObject commandObject = (CommandObject)command;  
   logger.info("Command Object :"+ToStringBuilder.reflectionToString(  
      commandObject));  
   request.getPortletSession ().setAttribute ("command_obj",   
      command,PortletSession.APPLICATION_SCOPE);  
}  
 

在JSP文件中，你可以象下面這樣檢索數據：

< form:form action="${formAction}" name="quickProcess"   
   method="post" commandName="commandObject">      
  < form:hidden path="p" id="p" /> 
  < c:if test="${commandObject.someList != null}"> 
    < c:forEach items="${commandObject.someList}"   
      var="listItem" varStatus="loop">                
      < c:out value="${listItem.name}"/>< br>              
    < /c:forEach> 
  < /c:if> 
< /form:form> 
 

注意這個Portlet并沒有指出它在屏幕上的布局，是否可以調整大小，寬度和高度應該保持多少為佳，這些屬性都由Portlet容器來進行控制的。

為了讓Portlet可以真正運行，你還需要編譯并部署它。在編譯時，創建一個標準的Java war文件（一般使用Ant或Maven創建），部署時將war文件放到托管Portlet容器的應用服務器上。當Portlet配置好，且在Portlet容器中注冊后，就要借助portlet.xml文件查找哪些容器中可以使用哪些Portlet了。例如，在Vignette Portal中，你可以通過搜索找到需要的Portlet，然后將其添加到門戶中，如圖5和圖6所示。

 
圖 5 在Vignette中添加一個Portlet

 
圖 6 在Vignette中搜索Portlet

添加Portlet到Portlet容器后，你還可以設置它們的位置、布局和屬性，例如，你可以設置默認的寬度和位置，以及是否可以最小化和移動位置等。

圖7顯示了Vignette示例頁面有三個Portlet，當用戶登錄到門戶后默認就看到這三個Portlet。

 
圖 7 在Vignette調整Portlet布局

圖8顯示了eXo JBoss Portlet容器默認的布局，當然你也可以在此基礎上重新調整，以符合你特殊需要。

 
圖 8  eXo JBoss 中可選的Portlet容器默認布局

通過Portlet容器可以很容易地改變整個網站的外觀，風格，只需要改變Portlet的布局、皮膚或UI主題即可。

小結

本文介紹了門戶和Portlet的入門基礎知識，并提供了一個簡單的實例，對如何創建和部署Portlet做了簡要說明。目前既有開源的也有商業化的門戶產品，不管采用哪種產品，基于門戶的開發將使程序員的重心轉移到業務邏輯上。門戶技術還處于不斷發展中，未來幾年有可能出現新的門戶技術，如果你正從事企業級開發，那么從現在開始關注門戶技術吧！

原文：An Introduction to Java Enterprise Portals and Portlet Development

作者：Vlad Kofman