DWR 简化 Ajax 的 portlet 间通信

本文内容包括:
构建示例的 portlet 间通信应用程序
测试示例应用程序
结束语
下载
参考资料
关于作者
对本文的评价

相关链接:
Java technology 技术文档库
WebSphere 技术文档库
Web architecture 技术文档库


developerWorks 中国  >  Java technology | WebSphere | Web architecture  >
DWR 简化 Ajax 的 portlet 间通信
Java portlet 和 Ajax 是 Web 开发的绝配

将此页作为电子邮件发送
样例代码
拓展 Tomcat 应用
下载 IBM 开源 J2EE 应用服务器 WAS CE 新版本 V1.1
级别: 中级
Sami Salkosuo (sami.salkosuo@fi.ibm.com), 软件架构师, IBM
2006 年 9 月 04 日
许多开发人员都期待着利用 Ajax 技术来提高基于 Web 的应用程序的用户体验，但是 Ajax 编程可能是一项麻烦的任务。开放源码的 Direct Web Remoting (DWR) 库通过自动把 Java 类转换成 JavaScript 类，可以为 Java™ 开发人员简化 Ajax 开发。在这篇文章中，将学习如何用 DWR 和符合 JSR-168 规范的 portlet 迅速而容易地构建 Ajax 应用程序。 Portlet 是基于 Java 平台的 Web 门户应用程序。JSR-168 是开发 portlet 应用程序的 Java Community Process 标准，它描述了 portlet 生命周期管理、portlet 容器合约、打包、部署以及与门户有关的其他方面。
异步 JavaScript + XML（或者叫做 Ajax）是一项用于开发丰富、交互的 Web 应用程序的技术。Ajax 组合了 XML、HTML、DHTML、JavaScript 和 DOM。
Portlet 和 Ajax 看起来彼此之间是完美搭配，因为它们都侧重于用 Web 浏览器作为向用户呈现用户界面的工具。把这两者与 Java 技术组合在一起的简易方式就是使用 DWR 库。DWR 是 Apache 许可下的开放源码 Java 库，用于构建基于 Ajax 的 Web 应用程序。DWR 的基本目的是向开发人员隐藏 Ajax 的细节。您在服务器端使用普通 Java 对象（POJO），而 DWR 动态地生成 JavaScript 代理函数，所以使用 JavaScript 的客户端开发感觉起来就像直接调用 JavaBean。DWR 的主要组件是一个 Java servlet，处理从浏览器到服务器的调用。
本文使用 DWR、基于三个 portlet 来构建一个示例 Ajax 应用程序。我将介绍如何把 DWR 与 porlet 应用程序集成，但是我不想深入 DWR 的幕后工作细节；在这个项目的 Web 站点和 developerWorks 的页面上（请参阅参考资料 获得细节）可以找到关于这个库的更多信息。要构建我描述的应用程序，需要 1.3 或以后版本的 Java 平台和符合 JSR-168 规范的的门户环境。我用来开发和测试这个代码的环境包含 IBM Rational Application Developer V6.0、Apache Jetspeed 2.0 portal 和 Java 5.0。
在开始之前，还应当熟悉 portlet 和 Ajax 开发。如果愿意学习关于这些主题的更多内容，请参阅下面的参考资料 小节。可以从下载 小节下载示例应用程序的完整代码，包括 DWR。
我们的示例应用程序有三个 portlet：Orders、Order Details 和 Customer Details；图 1 显示了示例应用程序：

Orders portlet 有一个订单列表。当用户点击订单号时，该 portlet 把订单号发送给 Order Details 和 Customer Details portlet，这两者然后显示适当的订单和客户细节。
在可以开发 portlet 之前，需要设置开发环境和 DWR。我使用 IBM Rational Application Developer V6.0，它对 Java portlet 开发具有内置的支持，但是其他开发环境也可以。按以下步骤开始：
创建一个新的 JSR-168 portlet 项目。给项目起名为 InterPortletMessaging，但是现在还不创建任何 portlet。
下载 dwr.jar（版本 1.1；请参阅参考资料 中的链接）。把 dwr.jar 添加到项目的 /WebContent//WEB-INF/lib 目录。
打开 web.xml 并添加清单 1 中的代码。这会把 DWR servlet 添加到应用程序。这个 servlet 被用在后台处理请求并把响应发送回浏览器。
dwr-invoker DWR Servlet uk.ltd.getahead.dwr.DWRServlet debug true dwr-invoker /dwr/*
用清单 2 中的代码在 WEB-INF 目录创建一个名为 dwr.xml 的文件。这个文件是 DWR 的配置文件，它告诉容器哪些类在 JavaScript 中是可用的。DWR 读取这个 XML 文件并动态地生成把 Java 类表示成 JavaScript 类的 JavaScript 代码。这样您就可以在浏览器中提供由这些 Java 类提供的功能。目前还没有真正创建在清单 2 中引用的 Java 类，但是我们先来看一下。

现在可以在 portlet 中使用 DWR 了。但是在创建示例 portlet 之前，需要创建一个消息 bean 和一个伪装数据库 bean（充当示例应用程序的后端）。
清单 3 所示的 MockupDB 是个单体类，模拟客户订单的数据库。所有订单都硬编码在这个类中。真实应用程序可能使用关系数据库系统，但这个示例对我们的目的来说足够了。
package db; import java.util.Hashtable; import java.util.Map; public class MockupDB { private static MockupDB instance=new MockupDB(); private String[] orders=new String[4]; private Map orderDetails=new Hashtable(); private Map customerDetails=new Hashtable(); private MockupDB() { String ordStart="ORD"; orders[0]=ordStart+"000408015"; orders[1]=ordStart+"001600023"; orders[2]=ordStart+"000042000"; orders[3]=ordStart+"011235813"; orderDetails.put(orders[0],"1. WebSphere Everyplace Connection Manager
"+ "2. WebSphere Portal"); orderDetails.put(orders[1],"1. DB2 Universal Database
2. DB2 Everyplace"); orderDetails.put(orders[2],"1. Tivoli Access Manager for e-business
2."+ "Tivoli Directory Integrator"); orderDetails.put(orders[3],"1. IBM System z9
2. IBM System p5 550 Express"); customerDetails.put(orders[0],"Systems and Technology Group
"+ "Some Road
Finland"); customerDetails.put(orders[1],"Global Financing
Another Street"+ "
Finland"); customerDetails.put(orders[2],"Software
Yet Another Road"+ "
Finland"); customerDetails.put(orders[3],"Global Services
Still Another "+ "Street
Finland"); } public static MockupDB getInstance() { return instance; } public String[] getOrders() { return orders; } public String getOrderDetails(String orderNro) { return (String)orderDetails.get(orderNro); } public String getCustomerDetails(String orderNro) { return (String)customerDetails.get(orderNro); } }
清单 4 所示的 MessagingBean 是个简单的 POJO，有两个方法，都接受订单号，但是分别返回订单细节和客户细节。MessagingBean 从 MockupDB 得到细节。
package msg; import javax.servlet.http.HttpSession; import db.MockupDB; public class MessagingBean { public MessagingBean() { } public String getOrderDetails(String orderNumber,HttpSession httpSession) { String orderDetails=MockupDB.getInstance().getOrderDetails(orderNumber) httpSession.setAttribute("orderDetailsOrderNumber",orderNumber); httpSession.setAttribute("orderDetails",orderDetails); return orderDetails; } public String getCustomerDetails(String orderNumber,HttpSession httpSession) { String customerDetails=MockupDB.getInstance().getCustomerDetails(orderNumber); httpSession.setAttribute("customerDetailsOrderNumber",orderNumber); httpSession.setAttribute("customerDetails",customerDetails); return customerDetails; } }
MessagingBean 还把订单细节和客户细节添加到 HttpSession。
javaScriptFunctions.jsp 导入了来自 DWR 的 JavaScript 库（engine.js）并动态地创建库 MessagingBean.js。注意，MessagingBean.js 使用的名称与 dwr.xml（清单 2）中的 JavaBean 的名称相同；实际上，DWR 生成 MessagingBean.js。DWR 框架使用 engine.js 库；作为开发人员，通常不需要考虑直接使用它。
如清单 5 所示，sendOrderNr() 函数调用清单 4 中定义的 MessagingBean 函数。DWR 自动把 HttpSession 添加到方法调用。JavaScript 函数中的最后一个参数是 callback 函数。在稍后创建的 portlet JSP 中，包含这个 JSP。
<%@ page contentType="text/html" import="java.util.*,javax.portlet.*,interportletmessagingusingajax.*" %> <%@taglib uri="http://java.sun.com/portlet" prefix="portlet" %>
现在有了后端和代理函数，可以开发 portlet 本身了。所有三个 portlet 都使用相同的代码基；惟一的区别是每个 portlet 使用的 JSP 的名称。
使用清单 6 中的代码创建一个新 portlet，并给它起名为 Orders:
package interportletmessagingusingajax; import java.io.*; import javax.portlet.*; public class Orders extends GenericPortlet { // JSP folder name public static final String JSP_FOLDER = "/interportletmessagingusingajax/jsp/"; // JSP file name to be rendered on the view mode public static final String VIEW_JSP = "OrdersView"; public void init(PortletConfig config) throws PortletException{ super.init(config); } public void doView(RenderRequest request, RenderResponse response) throws PortletException, IOException { // Set the MIME type for the render response response.setContentType(request.getResponseContentType()); // Invoke the JSP to render PortletRequestDispatcher rd = getPortletContext().getRequestDispatcher( getJspFilePath(request, VIEW_JSP)); rd.include(request,response); //this is workaround for portletsession sharing between //servlets and portlets //see http://weblogs.java.net/blog/wholder/archive/2005/02/session_session.html //and http://mail-archives.apache.org/mod_mbox/portals-pluto-dev/200502.mbox/%3Ca //2519328f3ba1d1eddfc33c924b6805d@umich.edu%3E // PortletRequestDispatcher rd2 = getPortletContext().getRequestDispatcher("/dwr/"); rd2.include(request, response); } private static String getJspFilePath(RenderRequest request, String jspFile) { String markup = request.getProperty("wps.markup"); if( markup == null ) markup = getMarkup(request.getResponseContentType()); return JSP_FOLDER+markup+"/"+jspFile+"."+getJspExtension(markup); } private static String getMarkup(String contentType) { if( "text/vnd.wap.wml".equals(contentType) ) return "wml"; return "html"; } private static String getJspExtension(String markupName) { return "jsp"; } }
创建并打开 OrdersView.jsp（在 interportletmessagingusingajax/jsp/html 目录），并把清单 7 中的代码添加到它：
<%@ page contentType="text/html" import="java.util.*,javax.portlet.*,interportletmessagingusingajax.*" %> <%@taglib uri="http://java.sun.com/portlet" prefix="portlet" %>

Orders

<% db.MockupDB database= db.MockupDB.getInstance(); String[] orders=database.getOrders(); for(int i=0;i <% } %>

<%="000000000"+String.valueOf(i+1) %>

<%=orders[i]%>

第二个 portlet 是 OrderDetailsPortlet.java。对这个 portlet 使用清单 6 中的代码，并把 VIEW_JSP 变量的值改成 OrdersDetailsPortletView.jsp。这个 JSP 的代码如清单 8 所示：
<%@ page contentType="text/html" import="java.util.*,javax.portlet.*,interportletmessagingusingajax.*" %> <%@taglib uri="http://java.sun.com/portlet" prefix="portlet" %>

Order details

<% String orderDetailsOrderNumber=(String)renderRequest.getPortletSession().getAttribute( "orderDetailsOrderNumber",PortletSession.APPLICATION_SCOPE); String orderDetails=(String)renderRequest.getPortletSession().getAttribute( "orderDetails",PortletSession.APPLICATION_SCOPE); if(orderDetailsOrderNumber==null) { orderDetailsOrderNumber=""; } if(orderDetails==null) { orderDetails=""; } %>

Order number	Order details
<%=orderDetailsOrderNumber%>	<%=orderDetails%>

第三个 portlet 是 CustomerDetailsPortlet.java。对这个 portlet 使用清单 6 中的代码，并把 VIEW_JSP 变量的值改成 CustomerDetailsPortletView.jsp。这个 JSP 的代码如清单 9 所示：
<%@ page contentType="text/html" import="java.util.*,javax.portlet.*,interportletmessagingusingajax.*" %> <%@taglib uri="http://java.sun.com/portlet" prefix="portlet" %> <% %>

Customer details

<% String customerDetailsOrderNumber= (String)renderRequest.getPortletSession().getAttribute( "customerDetailsOrderNumber",PortletSession.APPLICATION_SCOPE); String customerDetails=(String)renderRequest.getPortletSession().getAttribute( "customerDetails", PortletSession.APPLICATION_SCOPE); if(customerDetailsOrderNumber==null) { customerDetailsOrderNumber=""; } if(customerDetails==null) { customerDetails=""; } %>

Order number	Customer details
<%=customerDetailsOrderNumber%>	<%=customerDetails%>

示例应用程序现在准备好了。下一步是把 portlet 打包成 WAR 文件并在 Apache Jetspeed 门户中测试它。




回页首
在这一节，将看到示例应用程序的作用。首先，创建 portlet WAR 并把它安装到 Jetspeed 门户。然后，把三个 portlet 添加到门户，看它们是如何工作的。将把它们全都构建到一个页面，但如果需要也可以把它们放到多个页面；幕后的机制仍然起作用。
把 portlet WAR 文件安装到 Jetspeed 的方法是把 WAR 文件拷贝到 /webapps/jetspeed/WEB-INF/deploy 目录。然后 Jetspeed 会自动安装 portlet，portlet 即可使用了。
使用以下步骤把新页面添加到 Jetspeed 门户：
进入 Jetspeed 门户，并作为管理员登录。
点击右下角的 Edit 图标，并添加名为 Inter-Portlet Messaging 的新页面，如图 2 所示：

选择 Inter-Portlet Messaging 页面并点击 Edit 图标。然后点击 Add a portlet 图标，在这个页面上添加 portlet。选择 Orders、Order Details 和 Customer Details portlet，并点击 Select portlets，把选中的 portlet 添加到门户页面。完成之后，页面看起来应当像图 3：

Orders portlet 如图 4 所示，列出订单：

在点击订单号时，其他 portlet 显示这个订单的细节。Customer Details portlet 显示客户信息，如图 5 所示。信息检索自 MockupDB。

Order Details portlet 也显示检索自 MockupDB 的信息，如图 6 所示：

如果喜欢，可以回过去，向不同的页面添加一个或多个 portlet。将会看到，portlet 不需要在单个页面上，因为 portlet 内容保存在用户会话中。




回页首
这篇文章介绍了用 Ajax 实现 portlet 间通信的一种方式。Ajax 是开发交互式 Web 页面的一种非常强大的技术，而支持 Ajax 的 portlet 通过消除门户中典型存在的请求-响应延迟，极大地改善了用户体验。
可以用本文中的代码作为开发您自己的应用程序的起点；文中的代码还显示了 DWR 如何把 Java 编程模型扩展到 Web 浏览器。使用 DWR，JavaBean 几乎就像是在浏览器中可用一样。DWR 几乎隐藏了 Ajax 的全部细节，让您可以专注于手头的工作，而不必考虑 Ajax 开发的具体细节，从而简化了工作。




回页首
描述 名字 大小 下载方法
Source code j-ajaxportlet.war 3MBHTTP

关于下载方法的信息Get Adobe® Reader®




回页首
学习
您可以参阅本文在 developerWorks 全球站点上的英文原文 。
developerWorks 中国网站 Ajax 技术资源中心：在这里您可以找到更多关于 Ajax 的知识，包括 Ajax 基础入门、使用 Java, PHP 等语言开发 Ajax 应用的各种技巧和多种 Ajax 框架的技术信息。
“掌握 Ajax”（Brett McLaughlin，developerWorks，2006 年）：赶上 Ajax 编程和概念的速度。
DWR: Easy Ajax for Java：用来自包创建者的这套资源开始了解 DWR。
“结合 Direct Web Remoting 使用 Ajax ”（Philip McCarthy，developerWorks，2005 年 11 月）：学习如何用 DWR 直接把 JavaBean 方法公开给 JavaScript 代码并自动进行 Ajax 的繁重工作。
使用 Apache Pluto 构建和测试 JSR 168 兼容的 portlets （Mark Talbot 和 Kulvir Singh Bhogal，developerWorks，2006 年 4 月）：构建、编译、打包和部署简单的 portlet 到 Pluto，测试 JSR 168 的符合程度。
developerWorks Web 开发专区：专注于介绍各种基于 Web 的解决方案的文章。
“比较 JSR 168 Java Portlet 规范与 IBM Portlet API”（Stefan Hepper，developerWorks，2003 年 12 月）：学习关于 Java portlet 开发的更多内容。
获得产品和技术
Direct Web remoting：下载这个开放源码的、使得本文中开发的应用程序成为可能的 Java 库。
Apache Jetspeed：下载并找到关于这个门户的更多内容。
Rational Application Developer for WebSphere Software V6.0：下载这个开发环境的免费试用版。




回页首


Sami Salkosuo 从 1999 年起一直在 IBM 工作。他的主要兴趣领域是 Java 编程，是 Sun 认证 Java 程序员，IBM 认证的 XML 和相关技术解决方案开发人员，IBM 认证的 IBM WebSphere Portal 解决方案开发人员。除了 Java 技术，他还有 Python、Fortran、LabVIEW、Visual Basic、LISP、Perl 和 PHP 的经验。