【51CTO精選譯文】當(dāng)你訪問iGoogle或是myYahoo!一類的門戶時(shí),是否會(huì)對(duì)這種個(gè)性化門戶界面的實(shí)現(xiàn)方式感到好奇呢?實(shí)現(xiàn)這種“組件式”門戶的技術(shù)叫做Portlet。隨著Portlet相關(guān)規(guī)范的統(tǒng)一,這種技術(shù)現(xiàn)在也被用于企業(yè)內(nèi)部網(wǎng)站(企業(yè)門戶)以及其他商業(yè)或個(gè)人網(wǎng)站。下面,我們將進(jìn)行一次簡(jiǎn)短的Portlet入門介紹與教程。
Java Portlet的歷史
自2003年最初的JSR 168規(guī)范發(fā)布以來(lái),Portlet開發(fā)在企業(yè)和開源社區(qū)中都獲得了積極響應(yīng)。2008年6月發(fā)布了JSR 286規(guī)范,標(biāo)志著Portlet開發(fā)技術(shù)已經(jīng)非常成熟。截至目前已經(jīng)有不止20個(gè)開源Portlet容器和門戶產(chǎn)品可用,如SUN的Liferay Portal、eXo Platform和Jakarta Pluto等,也有來(lái)自主流軟件廠商的商業(yè)化產(chǎn)品,如Vignette Portal、IBM WebSphere Portal、Sun OpenPortal和Oracle Portal(以前叫做BEA WebLogic Portal)等。
Web門戶基礎(chǔ)
那么,什么是門戶呢?傳統(tǒng)的觀點(diǎn)認(rèn)為Web分為三類:Web網(wǎng)站,搜索引擎和門戶。Web網(wǎng)站一般放置個(gè)人主頁(yè)或公司主頁(yè),而搜索引擎是網(wǎng)絡(luò)爬蟲,它索引個(gè)人和企業(yè)網(wǎng)頁(yè),以便于人們搜索,門戶就象一個(gè)大雜燴,將各種有關(guān)或無(wú)關(guān)的東西全部糅合到一塊(目前許多搜索引擎如Yahoo.com和MSN也是門戶)。隨著門戶的演變,出現(xiàn)了一些新的特征,如保存用戶的參數(shù)設(shè)置和其它自定義信息,用戶也可以配置門戶記住他們的設(shè)置,如背景色,顯示記錄條數(shù)等。支持自定義可以讓不同的用戶擁有個(gè)性化的門戶,每個(gè)人訪問門戶時(shí)界面顯示的內(nèi)容可能完全不一樣,如A看到的是新聞和股票,B看到的是娛樂和天文學(xué)。如圖1所示。
圖 1 Yahoo門戶:門戶自定義讓門戶記住用戶的參數(shù)設(shè)置
經(jīng)過自定義后,不同種類的信息摻和在一起形成一個(gè)非?,F(xiàn)代化的頁(yè)面,目前最流行的做法是在門戶上放置多個(gè)矩形框,每個(gè)矩形框代表一個(gè)Portlet。Wikipedia將門戶定義為“以統(tǒng)一的方式顯示來(lái)自不同地方的信息”,將Portlet定義為“可插拔的用戶界面組件”。
門戶的目標(biāo)就是為不同用戶定制顯示不同的Portlet,以滿足用戶個(gè)性化的需求,這樣做可以粘住用戶。經(jīng)過這幾年的發(fā)展,門戶的應(yīng)用已經(jīng)擴(kuò)大到企業(yè)內(nèi)部中去了,包括內(nèi)部門戶,B2B等形式,如企業(yè)財(cái)務(wù)門戶將各種財(cái)務(wù)信息聚合到一起,分別以Portlet形式展示,如投資組合、401K計(jì)劃、信用卡、銀行賬戶等,財(cái)務(wù)部門人員就可以一次性獲得大量的財(cái)務(wù)數(shù)據(jù)。
企業(yè)門戶和Portlet容器
那么門戶和Portlet容器是什么關(guān)系呢?簡(jiǎn)答:門戶是Portlet容器的容器。Portlet容器是根據(jù)門戶提供的Portlet標(biāo)準(zhǔn)API實(shí)現(xiàn)的供Portlet運(yùn)行的環(huán)境,依靠這個(gè)環(huán)境,或者說平臺(tái),Portlet可以被實(shí)例化,使用,最終被處理掉(destroyed)。Java Portlet容器不是象Servlet容器那樣標(biāo)準(zhǔn)的獨(dú)立的容器,相反,它是在Java Servlet容器上實(shí)現(xiàn)的,并會(huì)重用Java Servlet的功能。從技術(shù)角度來(lái)說,Portlet容器可以看作是Portlet和門戶之間的接口。
早期的Web門戶都是采用封閉式開發(fā)的,自家開發(fā)的Portlet只能在一個(gè)特定的Portlet容器中運(yùn)行,不具有很好的兼容性,遇到新項(xiàng)目或需求變化,開發(fā)人員不得不重新修改Portlet代碼。這種情況直到2003年SUN發(fā)布JSR 168規(guī)范后才得到改善,雖說這個(gè)規(guī)范也不完美,但它提供了一個(gè)標(biāo)準(zhǔn)Portlet API,定義了Portlet生命周期和其它重要屬性。即使到了今天,很多Portlet和Portlet容器都仍然遵循JSR 168或2008年發(fā)布的JSR 286規(guī)范,凡遵循這些規(guī)范編寫的Portlet幾乎都有很好的移植性。
提示:IBM也開發(fā)了自家的WebSphere portal,并且公開了API,IBM的API和SUN的API很類似,但最新的版本中,IBM放棄了自家的API,完全遵循JSR 168和JSR 286規(guī)范了。
現(xiàn)代Portlet容器可以用來(lái)構(gòu)建企業(yè)內(nèi)部網(wǎng)站(企業(yè)門戶),商業(yè)網(wǎng)站或個(gè)人網(wǎng)站,大多數(shù)都實(shí)現(xiàn)了開箱即用的功能,如國(guó)際化支持,工具和內(nèi)容管理,基于角色的授權(quán),單點(diǎn)登錄(SSO)支持,搜索和標(biāo)簽支持等。圖2顯示了一個(gè)正在運(yùn)行的Portlet容器示例。
圖 2 Apache Jetspeed門戶:包括一個(gè)日歷Portlet
用戶可以拖動(dòng)日歷Portlet的位置,如圖3所示。
開發(fā)一個(gè)Portlet
下面這部分將介紹如何進(jìn)行簡(jiǎn)單的Portlet開發(fā)。首先創(chuàng)建一個(gè)標(biāo)準(zhǔn)的Java項(xiàng)目,然后創(chuàng)建一個(gè)portlet.xml文件,在這個(gè)文件中定義哪些Portlet對(duì)哪些容器有效,以及在實(shí)例化時(shí)需要使用哪些類,但這個(gè)文件并沒有定義如何注冊(cè)和識(shí)別Portlet。
圖4顯示了一個(gè)示例Portlet項(xiàng)目的目錄結(jié)構(gòu)。
圖 4 Portlet項(xiàng)目結(jié)構(gòu)示例
下面的portlet.xml定義了一個(gè)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>
從上面的內(nèi)容可以看出portlet.xml指定contextConfigLocation為Spring類的初始化參數(shù)。
列表1顯示了完整的contextConfigLocation文件的內(nèi)容。
- < ?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>
接下來(lái)就是編寫Java代碼實(shí)現(xiàn)控制器,視圖和Portlet處理程序了。視圖是一個(gè)JSP頁(yè)面,控制器和Portlet處理程序是Java類。在控制器和處理程序的幫助下,從不同數(shù)據(jù)源提取數(shù)據(jù),如Web Service,數(shù)據(jù)庫(kù)或feed等,你可以通過命令模式將這些數(shù)據(jù)傳給視圖,運(yùn)輸工具使用commandObject。下面的代碼展示了如何使用Portlet API獲取數(shù)據(jù)并返回給視圖層。
- @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文件中,你可以象下面這樣檢索數(shù)據(jù):
- < 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>
注意這個(gè)Portlet并沒有指出它在屏幕上的布局,是否可以調(diào)整大小,寬度和高度應(yīng)該保持多少為佳,這些屬性都由Portlet容器來(lái)進(jìn)行控制的。
為了讓Portlet可以真正運(yùn)行,你還需要編譯并部署它。在編譯時(shí),創(chuàng)建一個(gè)標(biāo)準(zhǔn)的Java war文件(一般使用Ant或Maven創(chuàng)建),部署時(shí)將war文件放到托管Portlet容器的應(yīng)用服務(wù)器上。當(dāng)Portlet配置好,且在Portlet容器中注冊(cè)后,就要借助portlet.xml文件查找哪些容器中可以使用哪些Portlet了。例如,在Vignette Portal中,你可以通過搜索找到需要的Portlet,然后將其添加到門戶中,如圖5和圖6所示。
添加Portlet到Portlet容器后,你還可以設(shè)置它們的位置、布局和屬性,例如,你可以設(shè)置默認(rèn)的寬度和位置,以及是否可以最小化和移動(dòng)位置等。
圖7顯示了Vignette示例頁(yè)面有三個(gè)Portlet,當(dāng)用戶登錄到門戶后默認(rèn)就看到這三個(gè)Portlet。
圖 7 在Vignette調(diào)整Portlet布局
圖8顯示了eXo JBoss Portlet容器默認(rèn)的布局,當(dāng)然你也可以在此基礎(chǔ)上重新調(diào)整,以符合你特殊需要。
圖 8 eXo JBoss 中可選的Portlet容器默認(rèn)布局
通過Portlet容器可以很容易地改變整個(gè)網(wǎng)站的外觀,風(fēng)格,只需要改變Portlet的布局、皮膚或UI主題即可。
小結(jié)
本文介紹了門戶和Portlet的入門基礎(chǔ)知識(shí),并提供了一個(gè)簡(jiǎn)單的實(shí)例,對(duì)如何創(chuàng)建和部署Portlet做了簡(jiǎn)要說明。目前既有開源的也有商業(yè)化的門戶產(chǎn)品,不管采用哪種產(chǎn)品,基于門戶的開發(fā)將使程序員的重心轉(zhuǎn)移到業(yè)務(wù)邏輯上。門戶技術(shù)還處于不斷發(fā)展中,未來(lái)幾年有可能出現(xiàn)新的門戶技術(shù),如果你正從事企業(yè)級(jí)開發(fā),那么從現(xiàn)在開始關(guān)注門戶技術(shù)吧!
原文:An Introduction to Java Enterprise Portals and Portlet Development
作者:Vlad Kofman
(#)
聯(lián)系客服