本文將展示一個開源的 JavaScript 庫,它為 AJAX 應用帶來了書籤與後退按鈕支援。學完本教程後,開發者將能獲得一個連 Google Maps 與 Gmail 當時都尚未提供的解決方案:一個強大、可用、行為與其他 Web 應用無異的書籤與後退/前進功能。
本文將闡述當前 AJAX 應用在書籤與後退按鈕方面面臨的嚴重問題,並展示 Really Simple History(RSH)——一個能解決上述問題的開源框架,附上幾個運行中的示例。
這個框架的核心發明有兩部分:其一是隱藏的 HTML 表單,用於緩存大量短期會話的客戶端資訊,為頁面導航提供強力支援;其二是超連結錨點與隱藏 Iframe 的組合,用以截獲並記錄瀏覽器的歷史事件。兩者都被封裝進一個簡單的 JavaScript 庫中以簡化開發。
書籤與後退按鈕在傳統多頁面 Web 應用中運行良好:瀏覽時位址欄隨新 URL 更新,可粘貼到郵件或書籤中備用,後退與前進也能正常翻動。但 AJAX 應用不同——它們是運行於單一頁面中的複雜程式,而瀏覽器並非為此設計。在 Gmail 這類軟體中,位址欄在切換功能、改變狀態時保持不變,導致無法對特定視圖加書籤;而按下後退鍵想「撤銷」上次操作時,使用者會驚訝地發現瀏覽器直接離開了應用。
開源的 RSH 框架能解決這些問題,為 AJAX 應用提供書籤與控制後退、前進的功能。它目前仍處於 Beta 階段,可在 Firefox 1.0、Netscape 7+、IE 6+ 上運行,暫不支援 Safari。相比那些綁定大型庫(如 Backbase、Dojo)、迫使開發者採用全新編程模型的框架,RSH 只是一個可嵌入既有 AJAX 系統的簡單模塊,並以特定技術規避了影響其他歷史記錄框架的 Bug。
RSH 由兩個 JavaScript 類組成:
DHtmlHistory 類為 AJAX 應用提供歷史記錄抽象。頁面用 add() 方法添加歷史事件,指定新位址與相關數據;該類以錨點(如 #new-location)更新當前 URL,並把歷史數據與新 URL 關聯。應用註冊為監聽器後,當使用者用後退/前進瀏覽時,歷史事件被觸發,提供新位置與隨 add() 保存的數據。
HistoryStorage 類則允許保存任意數量的歷史數據。普通頁面導航時,瀏覽器會卸載並清除所有狀態,返回時數據盡失;HistoryStorage 透過一個含 put()、get()、hasKey() 等方法的 API 解決此問題——內部利用瀏覽器會自動保存表單字段值的特性來實現。
任何使用 RSH 的頁面都必須包含 dHtmlHistory.js:
<!-- Load the Really Simple History framework --> <script type="text/javascript" src="../../framework/dHtmlHistory.js"></script>
此外還需在相同目錄下放入與框架打包的 blank.html——RSH 用一個隱藏 Iframe 追蹤 IE 的歷史變化,而該 Iframe 需指定實際檔案位置才能工作。
RSH 創建了一個名為 dhtmlHistory 的全局物件,作為操作瀏覽器歷史的入口。第一步是在頁面加載完成後初始化它,並訂閱歷史變化事件:
window.onload = initialize;
function initialize() {
dHtmlHistory.initialize();
dHtmlHistory.addListener(historyChange);
if (dHtmlHistory.isFirstLoad()) {
dHtmlHistory.add("helloworld", "Hello World Data");
dHtmlHistory.add("foobar", 33);
dHtmlHistory.add("boobah", true);
var complexObject = new Object();
complexObject.value1 = "This is the first value";
complexObject.value2 = "This is the second data";
complexObject.value3 = new Array();
complexObject.value3[0] = "array 1";
complexObject.value3[1] = "array 2";
dHtmlHistory.add("complexObject", complexObject);
}
}
historyChange 回調函數接收新位置 newLocation 與可選的 historyData:
function historyChange(newLocation, historyData) {
debug("A history change has occurred: newLocation=" + newLocation
+ ", historyData=" + historyData, true);
}
add() 被調用後,新位址會作為錨值立即出現在位址欄。例如對 https://codinginparadise.org/my_ajax_app 調用 dHtmlHistory.add("helloworld", "Hello World Data") 後,使用者會看到 https://codinginparadise.org/my_ajax_app#helloworld。使用者可將其加成書籤,日後 AJAX 應用可讀取 #helloworld 值來初始化頁面。
historyData 用於保存比簡單 URL 更複雜的狀態,可為任何 JavaScript 類型(Number、String 或 Object),支援嵌套物件與陣列,但不保存 DOM 物件與可腳本化的瀏覽器物件(如 XMLHttpRequest)。請注意,historyData 不隨書籤保存,當瀏覽器關閉、緩存清空或使用者清除歷史時便會消失。
isFirstLoad() 方法則用於區分「第一次加載」與「用戶導航回歷史頁面時觸發的假加載」,避免在後者時重複添加歷史事件。
HistoryStorage 類透過名為 historyStorage 的全局物件公開功能,提供 put(key, value)、get(key)、hasKey(key) 等模擬散列的方法。鍵名須為字串,鍵值則可為複雜的 JavaScript 物件甚至 XML 字串。示例中在首次加載時用 put() 存入一段簡單 XML:
var fakeXML = ''
+ '<foobar>' + '<foo-entry/>' + '</foobar>';
historyStorage.put("fakeXML", fakeXML);
之後若使用者離開又按後退返回,便可用 get() 提取、或用 hasKey() 檢查是否存在:
var savedXML = historyStorage.get("fakeXML");
var hasKey = historyStorage.hasKey("fakeXML");
請注意,這些數據只在該頁面的歷史中持久化;瀏覽器關閉或使用者開新窗口重新輸入位址時便不可用。若要真正長期持久化,可參考 AJAX Massive Storage System(AMASS)。
第二個示例是一個類似 Gmail 的簡單 AJAX 郵件模擬程式 O'Reilly Mail,用以說明如何用 dHtmlHistory 控制歷史、用 historyStorage 緩存數據。介面左側是含收件箱、草稿箱等文件夾與選項的菜單,選擇某項即更新右側內容。
它透過 RSH 把菜單變化加入歷史並更新位址欄,讓使用者能用後退/前進鍵翻動、也能對應用做書籤。其中特別加入「地址簿」菜單以示範 historyStorage:地址簿是一個由聯絡人名稱與郵件地址組成的 JavaScript 陣列,程式先於本地創建並存入 historyStorage;使用者離開再返回時,便從緩存重新讀取,而不必再次聯繫遠程服務器。
initialize() 負責保存與檢索地址簿:
function initialize() {
dHtmlHistory.initialize();
dHtmlHistory.addListener(handleHistoryChange);
if (window.addressBook == undefined) {
window.addressBook = [
"Brad Neuberg 'bkn3@columbia.edu'",
"John Doe 'johndoe@example.com'",
"Deanna Neuberg 'mom@mom.com'"
];
historyStorage.put("addressBook", addressBook);
} else {
window.addressBook = historyStorage.get("addressBook");
}
}
處理歷史變化的 handleHistoryChange 也很簡單:無論後退或前進,它都會被調用,再據 newLocation 更新介面到正確狀態;而 displayLocation() 則負責切換選中菜單項、更新右側內容,並在切到地址簿時從緩存讀取聯絡人格式化顯示。
至此,我們已了解如何以 RSH API 讓 AJAX 應用支援書籤與後退/前進按鈕,並附有可供參考的完整示例代碼。希望你能善用書籤與歷史記錄支援,進一步增強你的 AJAX 應用。