本文介紹一個開源 JavaScript 庫,能為 Ajax 應用加上書籤與「后退/前進」按鈕的能力。Ajax 應用普遍面臨這個嚴重問題,而 Really Simple History(RSH)框架正是為了解決它而生,並附上幾個可直接跑起來的範例。
讀完這篇教學,開發者就能拿到一個連當年 Google Maps、Gmail 都還不具備的能力:一個強健可用的書籤與歷史導航機制,行為與其他傳統 Web 應用一致。
這個框架的關鍵發現有兩點。第一,用一個隱藏的 HTML 表單快取大量短暫的客戶端狀態,為頁面導航提供支撐。第二,用一個隱藏的 IFrame 搭配超連結,攔截並記錄瀏覽器的歷史事件,從而支援后退與前進。兩者都被包裝進一個簡單的 JavaScript 庫,讓開發成本降到很低。
在多頁面的傳統 Web 應用裡,書籤和后退按鈕運作得很好。使用者瀏覽時,網址列會隨新的 URL 更新,這些記錄可以複製到郵件或書籤中留待日後使用;后退與前進按鈕則讓人輕地在走過的頁面之間翻動。
Ajax 應用完全不同:它是一個跑在單一頁面裡的複雜程式。瀏覽器不是為這類程式設計的——它假定每次點擊都要重新載入整頁。在 Gmail 這類應用中,使用者切換功能、程式狀態改變時,網址列卻紋絲不動,書籤因此失效。更糟的是,當使用者按下「后退」想撤銷上一步操作,瀏覽器與應用狀態脫節的錯愕感會讓人非常困惑。
開源的 Really Simple History(RSH)框架可以為 Ajax 應用補上書籤與歷史控制能力。它目前仍是 Beta,可在 Firefox 1.0、Netscape 7+、Internet Explorer 6+ 上運作,Safari 尚不支援。
當時也有幾類 Ajax 框架嘗試解決書籤與歷史問題,但因為實作路徑不同,各自都還帶著不小的 bug。Backbase、Dojo 等框架未來可望整合歷史瀏覽功能,但它們採用的是完全不同的程式模型,會逼得開發者換一套寫法。
RSH 走的是另一條路:它是可以直接嵌入既有 Ajax 系統的單一模組,後續版本還會避免與其他框架的相似功能打架。
DHtmlHistory 為 Ajax 應用提供歷史記錄的抽象層。頁面呼叫 add() 把新的位置與相關歷史數據註冊進瀏覽器;類別透過 Hash 更新網址列(例如 #new-location),並把數據與該 URL 關聯。應用註冊為歷史監聽器後,使用者一旦按下前進/后退,事件便被觸發。
HistoryStorage 則讓開發者保存任意歷史數據。普通網頁中,使用者離開時瀏覽器會卸載並清除頁面狀態,回來時數據全丟。HistoryStorage 以類似 Hash 表的 API(put()、get()、hasKey())解決這件事——最初的實作正是利用瀏覽器會自動保留表單欄位值這一特性。
1. 引入腳本
<!-- Load the Really Simple History framework -->
<script type="text/javascript"
src="../../framework/dHtmlHistory.js">
</script>
同時必須在同級目錄放一個 blank.html。RSH 會用一個隱藏 Iframe 來記錄 IE 的歷史變化,而 Iframe 需要指向真實檔案才能正常工作。
2. 初始化
RSH 會建立一個名為 dHtmlHistory 的全域物件,它是控制瀏覽器歷史的入口。頁面載入完成後先初始化:
window.onload = initialize;
function initialize() {
// 初始化 DHtml History 框架
dHtmlHistory.initialize();
// 訂閱歷史變化事件
dHtmlHistory.addListener('historyChange');
}
回呼函數會收到兩個參數:新位置與可選的歷史數據。
/** 接收歷史變化事件的回呼 */
function historyChange(newLocation, historyData) {
debug("A history change has occurred: "
+ "newLocation=" + newLocation
+ ", historyData=" + historyData, true);
}
debug() 只是把訊息印到頁面上的小工具,第二個參數為布爾值,設為真時會先清掉舊訊息。
3. 註冊歷史條目
if (dHtmlHistory.isFirstLoad()) {
debug("Adding values to browser history", false);
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 value";
complexObject.value3 = new Array();
complexObject.value3[1] = "array 2";
dHtmlHistory.add("complexObject", complexObject);
}
add() 執行後,新位置會以 Hash 形式出現在網址列。例如原本位址是 https://example.org/my_ajax_app,執行 dHtmlHistory.add("helloworld", "Hello World Data") 之後,使用者會看到 https://example.org/my_ajax_app#helloworld。使用者可以把它存成書籤,下次開啟時應用只要讀取 #helloworld 就能還原狀態。URL 的編解碼由框架透明處理。
第二個參數 historyData 在需要保存較複雜狀態時很有用,可以是數字、字串、物件等任意 JavaScript 型別。典型場景是網頁編輯器:使用者離開時把編輯內容存進去,按后退回來時監聽器就能取回該物件。你也可以塞進嵌套物件與陣列,但 DOM 物件與 XMLHttpRequest 這類瀏覽器物件無法保存。另外要注意:historyData 不會隨書籤持久化,瀏覽器關閉、快取清除或使用者清空歷史時它就消失了。