2006 年 9 月 04 日
Ajax 承諾了更流暢的 Web 體驗,但真正動手寫卻往往瑣碎而繁複。開源專案 Direct Web Remoting(DWR)把 Java 類別自動轉換為 JavaScript 類別,讓 Java 開發者不必深陷細節。本文示範如何搭配符合 JSR-168 規範的 portlet,快速搭出一個具備 Ajax 能力的入口網站應用。
Portlet 是立於 Java 平台之上的入口網站元件。JSR-168 是 Java Community Process 制定的 portlet 標準,涵蓋生命週期管理、容器契約、打包、部署等層面。
Ajax(Asynchronous JavaScript + XML)則是一套打造豐富互動介面的技術,集 XML、HTML、DHTML、JavaScript 與 DOM 於一身。
兩者都以瀏覽器作為呈現介面的載體,因此彼此契合。而把它們與 Java 技術串接起來最省事的方式,就是 DWR:這是一個依 Apache 授權發布的開放原始碼 Java 資料庫,核心目標是把 Ajax 的細節藏起來。你在伺服器端照常寫 POJO,DWR 動態產生對應的 JavaScript 代理函式,於是客戶端的撰寫手感幾乎等同於直接呼叫 JavaBean。DWR 的主要元件就是一支負責在瀏覽器與伺服器間轉送的 Java servlet。
本文以三個 portlet 組成一個範例應用,說明 DWR 與 portlet 的整合方式,但不深入 DWR 的內部實作。開發與測試環境為 IBM Rational Application Developer V6.0、Apache Jetspeed 2.0 portal 與 Java 5.0;運行需要 1.3 以上版本的 Java 平台與符合 JSR-168 的 portal 環境。
應用由三個 portlet 組成:Orders、Order Details 與 Customer Details。

Orders 列出所有訂單;使用者點擊任一訂單號時,該 portlet 把訂單號散播出去,Order Details 與 Customer Details 隨即各自顯示對應的訂單明細與客戶資訊——全程不換頁。
/WebContent/WEB-INF/lib。web.xml 註冊 DWR servlet,讓它在背景處理請求並回傳結果。
<servlet>
<servlet-name>dwr-invoker</servlet-name>
<display-name>DWR Servlet</display-name>
<servlet-class>uk.ltd.getahead.dwr.DWRServlet</servlet-class>
<init-param>
<param-name>debug</param-name>
<param-value>true</param-value>
</init-param>
</servlet>
<servlet-mapping>
<servlet-name>dwr-invoker</servlet-name>
<url-pattern>/dwr/*</url-pattern>
</servlet-mapping>
接著在 WEB-INF 建立 dwr.xml,告訴容器哪些類別要開放給 JavaScript 使用:
<!DOCTYPE dwr PUBLIC "-//GetAhead Limited//DTD Direct Web Remoting 1.0//EN"
"https://www.getahead.ltd.uk/dwr/dwr10.dtd">
<dwr>
<allow>
<create creator="new" javascript="MessagingBean">
<param name="class" value="msg.MessagingBean"/>
</create>
</allow>
</dwr>
MockupDB 是一個單例(Singleton)類別,用來假裝成訂單資料庫,所有資料都寫死在程式碼裡。真實場景當然會換成關聯式資料庫,但對這個範例而言綽綽有餘。它對外提供三個方法:getOrders() 回傳訂單號陣列,getOrderDetails() 與 getCustomerDetails() 依訂單號回傳明細與客戶資訊。
MessagingBean 則是一個簡單的 POJO,同樣接收訂單號,分別回傳訂單明細與客戶明細,並順手把結果寫進 HttpSession,讓不同 portlet 得以共用同一份狀態:
package msg;
import javax.servlet.http.HttpSession;
import db.MockupDB;
public class MessagingBean {
public String getOrderDetails(String orderNumber, HttpSession session) {
String details = MockupDB.getInstance().getOrderDetails(orderNumber);
session.setAttribute("orderDetailsOrderNumber", orderNumber);
session.setAttribute("orderDetails", details);
return details;
}
public String getCustomerDetails(String orderNumber, HttpSession session) {
String details = MockupDB.getInstance().getCustomerDetails(orderNumber);
session.setAttribute("customerDetailsOrderNumber", orderNumber);
session.setAttribute("customerDetails", details);
return details;
}
}
這裡有個關鍵細節:HttpSession 參數不必由呼叫端傳入,DWR 會自動補上。而 portlet 間之所以能互相傳值,靠的正是把資料放在 PortletSession.APPLICATION_SCOPE 這個共用的應用程式層級。
javaScriptFunctions.jsp 負責載入 DWR 的 engine.js,並動態引入由 dwr.xml 設定所生成的 MessagingBean.js。名稱之所以一致,是因為這支 JS 就是 DWR 依設定自動產生的產物。
<SCRIPT type="text/javascript"
src='<%= renderResponse.encodeURL(renderRequest.getContextPath()
+ "/dwr/interface/MessagingBean.js") %>'></SCRIPT>
<SCRIPT type="text/javascript"
src='<%= renderResponse.encodeURL(renderRequest.getContextPath()
+ "/dwr/engine.js") %>'></SCRIPT>
<SCRIPT type="text/javascript">
function <portlet:namespace />sendOrderNr(orderNr) {
document.getElementById("orderDetailsOrderNumber").innerHTML = orderNr;
document.getElementById("customerDetailsOrderNumber").innerHTML = orderNr;
MessagingBean.getOrderDetails(orderNr, <portlet:namespace />showOrderDetails);
MessagingBean.getCustomerDetails(orderNr, <portlet:namespace />showCustomerDetails);
return false;
}
function <portlet:namespace />showOrderDetails(orderDetails) {
document.getElementById("orderDetails").innerHTML = orderDetails;
return false;
}
function <portlet:namespace />showCustomerDetails(customerDetails) {
document.getElementById("customerDetails").innerHTML = customerDetails;
return false;
}
</SCRIPT>
每個函式的最後一個參數都是回呼函式;回應送達後,DWR 會把資料交給它,由它決定要更新頁面上哪個區塊。另外別忘了 <portlet:namespace />——同一頁面上多個 portlet 的 DOM id 必須命名空間化,否則會互相踩到。
三個 portlet 共用同一套程式碼骨架,差別只在各自要渲染的 JSP。以 Orders 為例:
public class Orders extends GenericPortlet {
public static final String JSP_FOLDER = "/interportletmessagingusingajax/jsp/";
public static final String VIEW_JSP = "OrdersView";
public void doView(RenderRequest request, RenderResponse response)
throws PortletException, IOException {
response.setContentType(request.getResponseContentType());
PortletRequestDispatcher rd = getPortletContext().getRequestDispatcher(
getJspFilePath(request, VIEW_JSP));
rd.include(request, response);
// 讓 DWR servlet 與 portlet 共享同一個 session
PortletRequestDispatcher rd2 =
getPortletContext().getRequestDispatcher("/dwr/");
rd2.include(request, response);
}
// getJspFilePath / getMarkup / getJspExtension 依 markup 類型挑選 JSP
}
OrdersView.jsp 把訂單渲染成表格,每一列的訂單號都是一個觸發點:
<jsp:include page="javascriptFunctions.jsp" />
<a href="" onclick="return <portlet:namespace />sendOrderNr('<%= orders[i]%>');">
<%=orders[i]%>
</a>
另外兩個 portlet(OrderDetailsPortlet、CustomerDetailsPortlet)沿用同一份類別碼,只把 VIEW_JSP 換成各自的檢視檔,並從 PortletSession.APPLICATION_SCOPE 取出被寫入的訂單號與明細,填進帶有固定 id 的 <div> 容器中——那些 id 正是 showOrderDetails 與 showCustomerDetails 要更新的目標。
把 portlet 打包成 WAR,複製到 <Jetspeed install dir>/webapps/jetspeed/WEB-INF/deploy,Jetspeed 會自動完成安裝。接著以管理者身分登入入口網站,新增一個名為 Inter-Portlet Messaging 的頁面:

進入該頁面的編輯模式,加入 Orders、Order Details、Customer Details 三個 portlet:

Orders portlet 列出訂單清單:

點下任一訂單號,Customer Details 立即顯示對應客戶資訊(同樣取自 MockupDB):

Order Details 也同步刷新為該筆訂單的內容:

值得一提的是,這些 portlet 甚至可以分散在不同頁面上——因為傳遞媒介是使用者工作階段中的共用狀態,而非同一頁面的 DOM。
這個範例示範了一條以 Ajax 打通 portlet 間通訊的可行路徑。Ajax 能消除入口網站中典型的請求—回應延遲,對使用者體驗的提升相當明顯;而 DWR 的價值在於幾乎抹平了 Ajax 的複雜度,讓 JavaBean 感覺上就像 natively 活在瀏覽器裡,開發者得以專注在真正要解決的問題上。

作者 Sami Salkosuo 自 1999 年起任職於 IBM,主要關注 Java 技術,為 Sun 認證 Java 程式設計師,並持有 IBM XML 相關技術、WebSphere Portal 解決方案等認證;此外亦熟悉 Python、Perl、PHP、Fortran、LabVIEW 等語言。