开发基于JSR 168的开发和部署

轻松进行Java Portlets
——开发基于JSR 168的开发和部署 浏览次数： 1495 时间：2004-10-22

作者：Prakash Malani

摘要
Portlet是生成片段（遵守特定规范的标记语言（如HTML、XML）的片段）的Web组件。片段再合成一个完整的文档。本文介绍了关于Java Portlet的Java Specification Request (JSR) 168规范。它说明了如何使用BEA WebLogic Workshop 8.1 SP2来创建Java Portlet，以及如何将这些portlet部署到BEA WebLogic Portal 8.1 Sp2上。我将介绍一些关键概念，如门户、桌面和portlet，并详细描述多种portlet模式和窗口状态。我还将介绍如何使用Workshop来设计、实现、配置和执行portlet。
JSR 168定义了有关Java Portlet的规范。门户是一个Web应用程序和一个portlet的聚合。Portlet容器运行portlet，并管理它们的生命周期。JSR 168定义了portlet与portlet容器之间的契约，它没有定义portlet容器与门户之间的契约。门户的实现留给了门户供应商。
BEA WebLogic门户
BEA WebLogic Portal (8.1 SP2)的当前版本支持不同类型的portlet：JSP/HTML portlet、Java PageFlow portlet、Struts portlet和Java portlet，将来还会支持其他portlet，如Web Services for Remote Portlets (WSRP)。我们将着重介绍Java portlet。
WebLogic Portal提供了JSR 168中未描述的门户功能，包括但不限于：书和页面中portlet的组织、多渠道支持和使用skin、skeleton和shell定制。
为了能够继续下去，在进行下一部分之前，请先完成以下内容：
·使用WebLogic Domain Configuration Wizard创建一个门户域（如JSR168PortalDomain）。
·使用WebLogic Workshop创建一个使用上面所建立域的门户应用程序（如JSR168PortalApp）。
·在门户应用程序内创建一个门户Web项目（如JSR168PortalWebProject）。
·在门户Web项目中创建一个WebLogic Portal .portal文件（如JSR168.portal）。
·启动服务器实例。
创建您的第一个Java Portlet
下面的步骤描述了如何创建您的第一个JSR 168 portlet。
·在门户Web项目（如JSR168PortalWebProject）中，使用WebLogic Workshop为portlet（入FirstPortlet）创建一个新文件夹。
·在新文件夹内使用Wizard通过创建相应的.portlet文件创建一个新portlet（如Firstportlet）。
·选择portlet类型为Java Portlet。
·指定标题（如First）。
·指定定义标签（如first）。
·指定类名称（如com.malani.examples.portlets.jsr168.FirstPortlet）。
·打开门户（如JSR168.portal）。
·将portlet（如Firstportlet）拖放到门户中的页面上（如JSR168.portal）。
·运行.portal文件进行测试。
您的第一个JSR 168 portlet已经成功运行了！但向导在背后作了些什么呢？
·它创建了一个特定于WebLogic Workshop和WebLogic Portal的.portlet文件。.portlet文件构成了与特定于Workshop和WebLogic Portal的.portal文件的契约。
·向导创建了一个.java文件（如com.malani.examples.portlets.jsr168.FirstPortlet.java），该文件放置在WEB-INF/src目录中。
·向导创建了一个WEB-INF/portlet.xml配置文件，并为portlet在文件中插入了一个条目。该portlet的条目看上去如下：

Description goes here
first
com.malani.examples.portlets.jsr168.FirstPortlet





Java Portlet类
在该示例中，向导生成的Portlet Java文件扩展了javax.portlet.GenericPortlet类。GenericPortlet类实现了javax.portlet.Portlet接口。图1是一个Unified Modeling Language (UML)类图，描述了这些关系。通过直接实现portlet接口，可以编写一个portlet。然而，GenericPortlet是一个创建portlet的更方便方法。首先，我们看一下portlet生命周期、portlet模式和window状态。

图 1
Portlet生命周期
为了成功地创建portlet，您必须遵照portlet生命周期。javax.portlet.Portlet接口中的方法定义了该生命周期，这些生命周期方法是init()、render()、processAction()和destroy()。当部署portlet的实例时调用init()方法。它用于获得所需的任何昂贵资源（如后台连接），并执行其他一次性活动。当portlet的实例被撤销部署时，使用destroy()方法来释放这些资源。
Portlet规范清晰区别render请求和动作请求。图2描述了portlet请求和响应的一个UML类图。门户页面上的render请求会导致对所页面上的每个portlet上调用render()方法，当用户在特定portlet上调用某个动作（通常是HTML表单提交）时，将会调用该portlet的processAction()方法。这样，用户的动作请求转换为processAction()方法的一次调用和render()方法的多次调用。

图 2
图3是一个序列图，说明了调用processAction()方法的效果，以及为同一页面上的portlet进行后续render()方法的调用。关于更多信息，请参阅关于处理动作的一节。

图 3
有两种重载的init()方法，一个没有参数，另一个有一个javax.portlet.PortletConfig类的实例。注意：关于init(PortletConfig)有一个特殊的caveat。调用super.init(aPortletConfig)失败将导致一个NullPointerException。所包含的源代码示例中的Init portlet说明了这种行为（源代码可以在www.sys-con.com/weblogic/source.cfm中找到）。
Portlet模式
JSR 168定义了三种Portlet模式：VIEW、EDIT和HELP。一个portlet实例在任何时候都可以恰巧在一种　portlet模式下。其他自定义portlet模式（如配置和源）都是可能的。VIEW模式是默认的模式。Portlet规范建议EDIT模式允许portlet用户定制portlet实例，以及HELP模式显示关于portlet的用法信息。Portlet必须支持VIEW模式，但在portlet中对EDIT模式和HELP模式的支持是可选的。例如，portlet First portlet示例不支持EDIT模式和HELP模式。
window状态
JSR 168定义了三种Window状态：NORMAL、MINIMIZED和MAXIMIZED。Portlet实例任何时候都可以恰好是一种window状态。其他自定义window状态（如半页）也是可能的。在NORMAL状态下，portlet占了屏幕区的一小部分。屏幕状态与其他portlet共享。在MINIMIZED状态下，portlet的内容被隐藏。在MAXIMIZED状态下，portlet的内容占屏幕区的大部分。其他共享同一页面的portlet在MAXIMIZED状态下被隐藏。例如，portlet First示例支持所有三种window状态。
GenericPortlet类
您创建的大多数portlet将会扩展javax.portlet.GenericPortlet类，而不是直接实现javax.portlet.Portlet接口。GenericPortlet类实现了render()方法。如果portlet的window状态被最小化，那么render()方法不能做任何事情。如果portlet的window状态不是最小化，那么render()方法设置在portlet.xml文件中指定的标题，并调用doDispatch()方法。根据Portlet模式， doDispatch()方法适当地调用doView()、doEdit()和doHelp()方法。这样，由于GenericPortlet类帮助实现render()方法，并且提供doView()、doEdit()和doHelp()方法来覆盖，因此GenericPortlet类比Portlet接口更便于扩展。
考虑一下First portlet示例。FirstPortlet类扩展了GenericPortlet，FirstPortlet改写了doView()方法。
public void doView(RenderRequest request, RenderResponse response)
throws PortletException, IOException
{
response.setContentType("text/html");
response.getWriter().write("

Hello World

");
}
注意：调用setContentType()方法前调用getWriter()方法会导致java.lang.IllegalStateException。
实现Portlet模式
VIEW模式是强制的，但EDIT和HELP模式是可选的。为了实现EDIT和HELP portlet模式，需要在portlet类中实现适当的doEdit()和doHelp()方法。请参考包含在源代码示例（本文的源代码可以在www.sys-con.com/wldj/sourcec.cfm找到）中的portlet Mode。此外，必须在portlet.xml中如下配置各模式：

text/html
edit
help

注意：修改portlet.xml配置文件，但不实现portlet类中的相应方法，会导致javax.portlet.PortletException。
实现window状态
JSR 168没有描述禁用window状态支持的方法。然而，WebLogic Portal实现了对它们的禁用。为了禁用portlet对window状态的支持，需要在weblogic-portlet.xml文件中排除window状态：

state

text/html
minimized
maximized


请参考源代码示例中的portlet State。
包含JavaServer Pages (JSPs)
考虑portlet First的doView()方法，该方法获得了Writer的实例，并直接输出HTML片段。由于多种原因（如为了达到Java逻辑与HTML视图表现的分离），往往不推荐输出直接的HTML片段。推荐的方法是使用JSP来显示视图。portlet类中的方法执行业务逻辑、设置render参数以及包含JSP。为了包含一个特定的JSP，应首先获得PortletContext。从PortletContext实例中，通过调用getRequestDispatcher()方法获得一个PortletRequestDispatcher的实例。通过调用include()方法来包含JSP。例如：
// execute the necessary logic here...
PortletRequestDispatcher aDispatcher =
getPortletContext().getRequestDispatcher(
"/IncludePortlet/includeView.jsp"
);
aDispatcher.include(aRequest, aResponse);
注意：在执行render()方法时，portlet可能只使用一个PortletRequestDispatcher对象。
请参考包含在源代码中的portlet Include。JSP页面（如includeView.jsp）不包含根HTML标签（如、