頁面重載是最大的可用性障礙之一,對 Java 開發者而言更是一道難題。本文作者 Philip McCarthy 介紹了透過「後台通道」打造動態 Web 應用的經驗。
Ajax(Asynchronous JavaScript and XML)結合了 Java 技術、XML 與 JavaScript,讓你能構建基於 Java 的 Web 應用,同時打破整頁重載的慣例。它的做法是:用客戶端腳本與 Web 伺服器交換資料,頁面不必中斷互動流程重新載入,就能動態更新。使用 Ajax,你可以做出接近本機桌面水準的、直接、高可用、更豐富也更動態的 Web 界面。
Ajax 與其說是一項技術,不如說是一種模式——標識並描述有用設計技巧的方法。對剛認識它的開發者來說感覺很新,但組成它的所有元件其實都已存在多年。
當前這股熱潮源自 2004 到 2005 年間出現的一批動態 Web UI,尤其是 Google 的 Gmail 與 Maps,以及照片分享網站 Flickr。這些界面充分利用了後台通道,被一些開發者稱為「Web 2.0」,也引爆了社群對 Ajax 應用的興趣。
本系列會把開發自有 Ajax 應用所需的一切工具交到你手上。第一篇先解釋背後的概念,示範為 Web 應用建立 Ajax 界面的基本步驟,用範例程式碼展示伺服器端 Java 與客戶端 JavaScript 的配合,最後點出常見錯誤以及可用性與可訪問性層面更廣泛的考量。
你可以用 Ajax 強化傳統 Web 應用,透過消除頁面載入讓互動更順暢。示範用一個購物車:加入商品時動態更新。整合進在線商店後,使用者不必等待點擊後的整頁重載,就能持續瀏覽並挑選商品放進購物車。
本文程式碼雖針對購物車,但展示的技術可以搬到任何 Ajax 應用。
一次 Ajax 互動從名為 XMLHttpRequest 的 JavaScript 物件開始。顧名思義,它允許客戶端腳本執行 HTTP 請求並解析 XML 格式的伺服器回應。第一步是建立一個 XMLHttpRequest 實例,設定 HTTP 方法(GET 或 POST)並指定目標 URL。
接著回想 Ajax 為何首先強調「非同步」:送出 HTTP 請求時,你不希望瀏覽器掛起等待回應,而是希望它繼續響應使用者的界面操作,等回應真正抵達後再處理。做法是向 XMLHttpRequest 註冊一個回呼函數,然後非同步地送出請求;控制權立刻回到瀏覽器,回應到達時回呼被觸發。
在 Java Web 伺服器上,到達的請求與其他 HttpServletRequest 沒有差別。解析請求參數後,servlet 執行必要的應用邏輯,把回應序列化成 XML,寫回 HttpServletResponse。
回到客戶端,註冊在 XMLHttpRequest 上的回呼函數被呼叫,處理伺服器返回的 XML 文件;最後用 JavaScript 操作頁面的 HTML DOM,完成界面更新。
以上是 Ajax 處理過程的高層視圖。接下來逐步深入細節;如果中途迷路,回頭對照圖 1 即可——由於本質是非同步的,時序圖並不是一條筆直的線。
從時序圖的起點開始:瀏覽器建立並送出 XMLHttpRequest。不幸的是,各家瀏覽器的建立方式都不同。下面的函數消除了這些差異,會正確偵測當前瀏覽器的方法並返回可用實例。最好把它當成備用程式碼,複製到你的 JavaScript 庫中,需要時直接呼叫。
/*
* 返回一個新建的 XMLHttpRequest 物件;
* 若瀏覽器不支援則失敗
*/
function newXMLHttpRequest() {
var xmlreq = false;
if (window.XMLHttpRequest) {
// 在非 Microsoft 瀏覽器中建立
xmlreq = new XMLHttpRequest();
} else if (window.ActiveXObject) {
// 透過 MS ActiveX 建立
try {
// 嘗試按新版 Internet Explorer 方式建立
xmlreq = new ActiveXObject("Msxml2.XMLHTTP");
} catch (e1) {
// 建立要求的 ActiveX 物件失敗
try {
// 嘗試按舊版 Internet Explorer 方式建立
xmlreq = new ActiveXObject("Microsoft.XMLHTTP");
} catch (e2) {
// 無法透過 ActiveX 建立 XMLHttpRequest
}
}
}
return xmlreq;
}
稍後我會討論如何應對不支援 XMLHttpRequest 的瀏覽器。目前先假設這個函數总能返回一個可用實例。
回到購物車場景:只要使用者對某個目錄項目點擊「Add to Cart」,就要觸發一次 Ajax 互動。名為 addToCart() 的 onclick 函數負責透過 Ajax 呼叫更新購物車狀態。
因為這個請求會修改伺服器狀態,我使用 HTTP POST。透過 POST 傳送資料需要三步:首先開啟一個到進行通訊的伺服器資源的 POST 連線(本例中是一個 URL 映射為 cart.do 的 servlet);接著設定 XMLHttpRequest 的標頭,標識請求內容為表單編碼;最後把表單編碼資料作為請求主體送出。
/*
* 透過產品編碼,在購物車中添加一個條目
* itemCode - 需要添加條目的產品編碼
*/
function addToCart(itemCode) {
// 獲取一個 XMLHttpRequest 實例
var req = newXMLHttpRequest();
// 設定用來從請求物件接收回呼通知的處理函數
var handlerFunction = getReadyStateHandler(req, updateCart);
req.onreadystatechange = handlerFunction;
// 開啟一個連接到購物車 servlet 的 HTTP POST 連線
// 第三個參數表示請求是非同步的
req.open("POST", "cart.do", true);
// 指示請求主體包含表單資料
req.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
// 送出標識需要加入購物車的條目
req.send("action=add&item=" + itemCode);
}
至此,Ajax 處理過程的第一部分——在客戶端建立並送出 HTTP 請求——就完成了。下一步是處理請求的 Java Servlet 程式碼。
用 servlet 處理 XMLHttpRequest,與處理來自瀏覽器的普通 HTTP 請求基本相同。可以透過呼叫 HttpServletRequest.getParameter() 取得由 POST 請求主體傳送的表單編碼資料。
Ajax 請求與普通 Web 請求一樣,都屬於該應用的同一個 HttpSession 會話進程。這對購物車例子很有幫助:我們可以透過 session 把多個請求的狀態保存到同一個可序列化的購物車 JavaBean 中。
public void doPost(HttpServletRequest req, HttpServletResponse res)
throws java.io.IOException {
Cart cart = getCartFromSession(req);
String action = req.getParameter("action");
String item = req.getParameter("item");
if ((action != null) && (item != null)) {
if ("add".equals(action)) {
cart.addItem(item);
} else if ("remove".equals(action)) {
cart.removeItems(item);
}
}
// 把購物車狀態序列化成 XML
String cartXml = cart.toXML();
// 寫入回應。務必設定 contentType,否則
// XMLHttpRequest 無法把內容解析為 XML DOM
res.setContentType("application/xml");
res.getWriter().write(cartXml);
}
以下是由 Cart.toXml() 產生的 XML。注意 cart 元素上的 generated 屬性,它是一個以 System.currentTimeMillis() 產生的時間戳:
<?xml version="1.0"?>
<cart generated="1123969988414" total="$171.95">
<item code="hat001">
<name>Hat</name>
<quantity>2</quantity>
</item>
<item code="cha001">
<name>Chair</name>
<quantity>1</quantity>
</item>
<item code="dog001">
<name>Dog</name>
<quantity>1</quantity>
</item>
</cart>
範例中的 Cart.java 只是簡單的字串拼接來生成 XML,對這個例子已經夠用;系列後續會介紹更好的做法。
XMLHttpRequest 的 readyState 屬性是一個數字,表示請求生命週期的狀態,從代表「未初始化」的 0 變到代表「完成」的 4。每次 readyState 改變都會引發 readystatechange 事件,透過 onreadystatechange 設定的回呼處理函數便會被呼叫。
前面我們用 getReadyStateHandler() 建立處理函數並指派給 onreadystatechange。這個函數利用了一個事實:函數在 JavaScript 中是一等物件,可以作為參數傳遞,也可以被建立並返回。getReadyStateHandler() 要做的就是返回一個函數,檢查 XMLHttpRequest 是否已完成,並把 XML 回應轉交給呼叫者指定的處理函數。
/*
* 返回一個函數:等待指定的 XMLHttpRequest 完成,
* 然後把它的 XML 回應傳給指定的處理函數
* req - 狀態正在改變的 XMLHttpRequest
* responseXMLHandler - 接收 XML 回應的處理函數
*/
function getReadyStateHandler(req, responseXMLHandler) {
// 返回一個監聽該 XMLHttpRequest 實例的匿名函數
return function () {
// 如果請求狀態是「完成」
if (req.readyState == 4) {
// 檢查是否成功接收到伺服器回應
if (req.status == 200) {
responseXMLHandler(req.responseXML);
} else {
// 發生了 HTTP 問題
alert("HTTP error: " + req.status);
}
}
};
}
XMLHttpRequest 的 status 屬性用來判斷請求是否成功完成。處理簡單的 GET 與 POST 時,你可以認為只要不是 200(OK)就表示出錯了。若伺服器送出重定向回應(如 301 或 302),瀏覽器會透明地完成重定向並從新位置取回資源,XMLHttpRequest 看不到重定向狀態碼。同時,瀏覽器會自動為所有 XMLHttpRequest 加上 no-cache 標頭,因此客戶端程式碼不必處理 304(未修改)回應。
這段程式碼相對複雜,特別是對不習慣讀 JavaScript 的人。折中方案是把它放進你的 JavaScript 庫,這樣你就能專心處理 Ajax 伺服器回應,不必操心 XMLHttpRequest 的內部細節。重點在於理解怎麼用它:
handlerFunction = getReadyStateHandler(req, updateCart)
由它返回的函數會檢查 req 中的 XMLHttpRequest 是否已完成,並呼叫 updateCart 指定的回呼方法來處理回應 XML。
updateCart() 使用 DOM 解析購物車 XML 文件,並更新頁面以反映新內容。注意它如何從 XML DOM 中提取資料:
function updateCart(cartXML) {
// 從文件中取得根元素 cart
var cart = cartXML.getElementsByTagName("cart")[0];
// 確認文件是最新的
var generated = cart.getAttribute("generated");
if (generated > lastCartUpdate) {
lastCartUpdate = generated;
// 清空用來顯示購物車內容的 HTML 列表
var contents = document.getElementById("cart-contents");
contents.innerHTML = "";
// 遍歷購物車中的每個條目
var items = cart.getElementsByTagName("item");
for (var i = 0; i < items.length; i++) {
var item = items[i];
// 從 name 與 quantity 元素提取文字節點
var name = item.getElementsByTagName("name")[0].firstChild.nodeValue;
var quantity = item.getElementsByTagName("quantity")[0].firstChild.nodeValue;
// 建立並加入 HTML 列表項目
var li = document.createElement("li");
li.appendChild(document.createTextNode(name + " x " + quantity));
contents.appendChild(li);
}
}
// 更新購物車金額
document.getElementById("total").innerHTML = cart.getAttribute("total");
}
cart 元素上的 generated 屬性(序列化時產生的時間戳)可以用來確保不會用舊資料覆蓋新資料。Ajax 請求天生是非同步的,這個檢查能有效避免先後到達順序顛倒的回應互相干擾。
到這裡,Ajax 處理過程的教學就結束了。這個例子非常簡單,改進空間很大——比如伺服器端已經寫了從購物車移除條目的程式碼,客戶端 UI 卻還沒有入口。作為練習,試著在既有 JavaScript 基礎上把這個功能補上。
與任何技術一樣,用 Ajax 在很多地方都可能犯錯。以下問題目前都還缺少標準解法,隨著技術成熟會逐步改善;社群也會沉澱出最佳實踐與指導方針。
XMLHttpRequest 的可用性: 這是 Ajax 開發者最大的難題之一——當 XMLHttpRequest 不可用時該如何反應?雖然多數現代瀏覽器都支援,但仍有用戶的瀏覽器不支援,或因安全設定而被禁用。若你的應用發佈在企業內部 Intranet,你很可能可以指定支援的瀏覽器種類;但在公開網路上,你必須意識到:一旦預設 XMLHttpRequest 可用,等於把舊瀏覽器、手持裝置使用者擋在門外。你應該努力讓系統「正常降級」——例如購物車例子裡,保留一個走傳統提交、透過刷新頁面反映狀態變化的「Add to Cart」按鈕。Ajax 行為可以在頁面載入時以 JavaScript 動態附加,只在 XMLHttpRequest 可用時才掛上處理函數;另一個做法是在使用者登入時偵測,再決定提供 Ajax 版還是傳統表單版。
可用性考量: 讓使用者知道他們的輸入已被接收並處理非常重要,因為 XMLHttpRequest 處理期間不會出現熟悉的旋轉漏斗游標。一種做法是把「確認」按鈕文字換成「正在更新中……」,避免使用者重複點擊。另一個問題是使用者在不知不覺中頁面已被更新,可以用視覺提示把注意力引導到更新區域。還有,Ajax 更新頁面會破壞瀏覽器「后退」的正常運作,網址列無法反映頁面全部狀態,書籤功能也隨之失效。
伺服器負載: 用 Ajax 界面取代傳統表單界面,可能戲劇性地增加送到伺服器的請求數量。普通 Google 搜尋只造成一次命中,而 Google Suggest 會在使用者打字時不斷送出請求。開發 Ajax 應用時要留意請求量與伺服器負載指標,可以透過在客戶端適當快取請求與回應來緩解壓力,並盡量把更多邏輯放在客戶端處理。
處理非同步: 一定要記住:沒有任何東西保證 XMLHttpRequest 會按送出順序依次結束。實際上,你在設計系統時就應該始終假設它們不會。購物車例子用最後更新的時間戳來避免新資料被覆寫,這個方法在該場景可行,但未必適用於其他情況。設計時就要想清楚如何處理非同步回應。
現在你應該對 Ajax 的基本原理有了不錯的掌握,也理解了一些更高層次的設計問題。打造一個成功的 Ajax 應用需要一整套方法——從 JavaScript UI 設計到伺服器端架構——但 Ajax 的核心知識,你現在已經具備了。