作者：Brad Neuberg
譯者:boool
版權聲明：任何獲得Matrix授權的網站，轉載時請務必以超鏈接形式標明文章原始出處和作者信息及本聲明
作者:Brad Neuberg;
boool
原文地址:
http://www.onjava.com/pub/a/onjava/2005/10/26/ajax-handling-bookmarks-and-back-button.html
中文地址:
http://www.matrix.org.cn/resource/article/43/43972_AJAX.html
關鍵詞： ajax;bookmarks;back button
這篇文章描述了一個支持AJAX應用書簽和回退按鈕的開源的javascript庫。在這個指南的最后，開發者將會得出一個甚至不是
Google Maps 或者
Gmail那樣處理的AJAX的解決方案：健壯的，可用的書簽和向前向后的動作能夠象其他的web頁面一樣正確的工作。
AJAX：怎樣去控制書簽和回退按鈕 這篇文章說明了一個重要的成果，AJAX應用目前面對著書簽和回退按鈕的應用，描述了非常簡單的歷史庫（Really Simple History），一個開源的解決這類問題的框架，并提供了一些能夠運行的例子。
這
篇文章描述的主要問題是雙重的，一是一個隱藏的html
表單被用作一個大而短生命周期的客戶端信息的session緩存，這個緩存對在這個頁面上前進回退是強壯的。二是一個錨連接和隱藏的iframes的組合
用來截取和記錄瀏覽器的歷史事件，來實現前進和回退的按鈕。這兩個技術都被用一個簡單的javascript庫來封裝，以利于開發者的使用。
存在的問題
書簽和回退按鈕在傳統的多頁面的web應用上能順利的運行。當用戶在網站上沖浪時，他們的瀏覽器地址欄能更新URL,這些URL可以被粘貼到的email或者添加到書簽以備以后的使用。回退和前進按鈕也可以正常運行，這可以使用戶在他們訪問的頁面間移動。
AJAX應用是與眾不同的，然而，他也是在單一web頁面上成熟的程序。瀏覽器不是為AJAX而做的—AJAX他捕獲過去的事件，當web應用在每個鼠標點擊時刷新頁面。
在象Gmail那樣的AJAX軟件里，瀏覽器的地址欄正確的停留就象用戶在選擇和改變應用的狀態時，這使得作書簽到特定的應用視圖里變得不可能。此外，如果用戶按下了他們的回退按鈕去返回上一個操作，他們會驚奇的發現瀏覽器將完全離開原來他所在的應用的web頁面。
解決方案
開
源的Really Simply
History(RSH)框架解決了這些問題，他帶來了AJAX應用的作書簽和控制前進后退按鈕的功能。RSH目前還是beta版，在
Firefox1.0上，Netscape7及以上,和IE6及以上運行。Safari現在還不支持（要得到更詳細的說明，請看我的weblog中的文章
Coding in Paradise: Safari: No DHTML History Possible).
目前存在的幾個AJAX框架可以幫助我們做書簽和發布歷史，然而所有的框架都因為他們的實現而被幾個重要的bug困擾（請看
Coding in Paradise: AJAX History Libraries 得知詳情）。此外，許多AJAX歷史框架集成綁定到較大的庫上，比如Backbase 和 Dojo，這些框架提供了與傳統AJAX應用不同的編程模型，強迫開發者去采用一整套全新的方式去獲得瀏覽器的歷史相關的功能。
相應的，RSH是一個簡單的模型，能被包含在已經存在的AJAX系統中。而且，Really Simple History庫使用了一些技巧去避免影響到其他歷史框架的bug.
Really Simple History框架由2個javascript類庫組成，分別叫DhtmlHistory 和 HistoryStorage.
DhtmlHistory
類提供了一個對AJAX應用提取歷史的功能。.AJAX頁面add() 歷史事件到瀏覽器里，指定新的地址和關聯歷史數據。DhtmlHistory
類用一個錨的hash表更新瀏覽器現在的URL，比如#new-location
，然后用這個新的URL關聯歷史數據。AJAX應用注冊他們自己到歷史監聽器里，然后當用戶用前進和后退按鈕導航的時候，歷史事件被激發，提供給瀏覽器新
的地址和調用add()持續保留數據。
第二個類HistoryStorage，允許開發者存儲任意大小的歷史數據。一般的頁面，當一個用
戶導航到一個新的網站，瀏覽器會卸載和清除所有這個頁面的應用和javascript狀態信息。如果用戶用回退按鈕返回過來了，所有的數據已經丟失了。
HistoryStorage 類解決了這個問題，他有一個api
包含簡單的hashtable方法比如put(),get(),hasKey()。這些方法允許開發者在離開web頁面時存儲任意大小的數據，當用戶點了
回退按鈕返回時，數據可以通過HistoryStorage 類被訪問。我們通過一個隱藏的表單域（a hidden form
field），利用瀏覽器即使在用戶離開web頁面也會自動保存表單域值的這個特性，完成這個功能。
讓我們立即進入一個簡單的例子吧。
示例1
首先，任何一個想使用Really Simple History框架的頁面必須包含（include）dhtmlHistory.js 腳本。
<!-- Load the Really Simple
History framework -->
<script type="text/javascript"
src="../../framework/dhtmlHistory.js">
</script>
DHTML
History 應用也必須在和AJAX web頁面相同的目錄下包含一個叫blank.html 的指定文件，這個文件被Really Simple
History框架綁定而且對IE來說是必需的。另一方面，RSH使用一個hidden iframe
來追蹤和加入IE歷史的改變，為了正確的執行功能，這個iframe需要指向一個真正的地址，不需要blank.html。
RSH框架創建了一個叫dhtmlHistory 的全局對象，作為操作瀏覽器歷史的入口。使用dhtmlHistory 的第一步需要在頁面加載后初始化這個對象。
window.onload = initialize;
function initialize() {
// initialize the DHTML History
// framework
dhtmlHistory.initialize();
然后，開發者使用dhtmlHistory.addListener()方法去訂閱歷史改變事件。這個方法獲取一個javascript回調方法，當一個DHTML歷史改變事件發生時他將收到2個自變量，新的頁面地址，和任何可選的而且可以被關聯到這個事件的歷史數據。
indow.onload = initialize;
function initialize() {
// initialize the DHTML History
// framework
dhtmlHistory.initialize();
// subscribe to DHTML history change
// events
dhtmlHistory.addListener(historyChange);
historyChange()方法是簡單易懂得，它是由一個用戶導航到一個新地址后收到的新地址（newLocation）和一個關聯到事件的可選的歷史數據historyData 構成的。
/** Our callback to receive history change
events. */
function historyChange(newLocation,
historyData) {
debug("A history change has occurred: "
+ "newLocation="+newLocation
+ ", historyData="+historyData,
true);
}
上面用到的debug()方法是例子代碼中定義的一個工具函數，在完整的下載例子里有。debug()方法簡單的在web頁面上打一條消息，第2個Boolean變量，在代碼里是true,控制一個新的debug消息打印前是否要清除以前存在的所有消息。
一個開發者使用add()方法加入歷史事件。加入一個歷史事件包括根據歷史的改變指定一個新的地址，就像"edit:SomePage"標記, 還提供一個事件發生時可選的會被存儲到歷史數據historyData值.
window.onload = initialize;
function initialize() {
// initialize the DHTML History
// framework
dhtmlHistory.initialize();
// subscribe to DHTML history change
// events
dhtmlHistory.addListener(historyChange);
// if this is the first time we have
// loaded the page...
if (dhtmlHistory.isFirstLoad()) {
debug("Adding values to browser "
+ "history", false);
// start adding history
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);
在add
()方法被調用后，新地址立刻被作為一個錨值顯示在用戶的瀏覽器的URL欄里。例如，一個AJAX
web頁面停留在http://codinginparadise.org/my_ajax_app，調用了dhtmlHistory.add
("helloworld", "Hello World Data" 后，用戶將在瀏覽器的URL欄里看到下面的地址
http://codinginparadise.org/my_ajax_app#helloworld
然
后他們可以把這個頁面做成書簽，如果他們使用這個書簽，你的AJAX應用可以讀出#helloworld值然后使用她去初始化web頁面。Hash里的地
址值被Really Simple History 框架顯式的編碼和解碼（URL encoded and decoded）
（這是為了解決字符的編碼問題）
對當AJAX地址改變時保存更多的復雜的狀態來說，historyData 比一個更容易的匹配一個
URL的東西更有用。他是一個可選的值，可以是任何javascript類型，比如Number, String, 或者 Object
類型。有一個例子是用這個在一個多文本編輯器（rich text
editor）保存所有的文本，例如，如果用戶從這個頁面漂移（或者說從這個頁面導航到其他頁面，離開了這個頁面）走。當一個用戶再回到這個地址，瀏覽器
會把這個對象返回給歷史改變偵聽器（history change listener）。
開發者可以提供一個完全的
historyData 的javascript對象，用嵌套的對象objects和排列arrays來描繪復雜的狀態。只要是JSON
(JavaScript Object
Notation) 允許的那么在歷史數據里就是允許的，包括簡單數據類型和null型。DOM的對象和可編程的瀏覽器對象比如
XMLHttpRequest ，不會被保存。注意historyData
不會被書簽持久化，如果瀏覽器關掉，或者瀏覽器的緩存被清空，或者用戶清除歷史的時候，會消失掉。
使用dhtmlHistory
最后一步，是isFirstLoad()
方法。如果你導航到一個web頁面，再跳到一個不同的頁面，然后按下回退按鈕返回起始的網站，第一頁將完全重新裝載，并激發onload事件。這樣能產生
破壞性，當代碼在第一次裝載時想要用某種方式初始化頁面的時候，不會再刷新頁面。isFirstLoad()
方法讓區別是最開始第一次裝載頁面，還是相對的，在用戶導航回到他自己的瀏覽器歷史中記錄的網頁時激發load事件，成為可能。
在例子代碼中，我們只想在第一次頁面裝載的時候加入歷史事件，如果用戶在第一次裝載后，按回退按鈕返回頁面，我們就不想重新加入任何歷史事件。
window.onload = initialize;
function initialize() {
// initialize the DHTML History
// framework
dhtmlHistory.initialize();
// subscribe to DHTML history change
// events
dhtmlHistory.addListener(historyChange);
// if this is the first time we have
// loaded the page...
if (dhtmlHistory.isFirstLoad()) {
debug("Adding values to browser "
+ "history", false);
// start adding history
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);
讓
我們繼續使用historyStorage 類。類似dhtmlHistory
，historyStorage通過一個叫historyStorage的單一全局對象來顯示他的功能，這個對象有幾個方法來偽裝成一個hash
table, 象put(keyName, keyValue), get(keyName), and
hasKey(keyName).鍵名必須是字符，同時鍵值可以是復雜的javascript對象或者甚至是xml格式的字符。在我們源碼source
code的例子中，我們put() 簡單的XML 到historyStorage 在頁面第一次裝載時。
window.onload = initialize;
function initialize() {
// initialize the DHTML History
// framework
dhtmlHistory.initialize();
// subscribe to DHTML history change
// events
dhtmlHistory.addListener(historyChange);
// if this is the first time we have
// loaded the page...
if (dhtmlHistory.isFirstLoad()) {
debug("Adding values to browser "
+ "history", false);
// start adding history
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);
// cache some values in the history
// storage
debug("Storing key 'fakeXML' into "
+ "history storage", false);
var fakeXML =
'<?xml version="1.0" '
+ 'encoding="ISO-8859-1"?>'
+ '<foobar>'
+ '<foo-entry/>'
+ '</foobar>';
historyStorage.put("fakeXML", fakeXML);
}
然后，如果用戶從這個頁面漂移走（導航走）又通過返回按鈕返回了，我們可以用get（）提出我們存儲的值或者用haskey（）檢查他是否存在。
window.onload = initialize;
function initialize() {
// initialize the DHTML History
// framework
dhtmlHistory.initialize();
// subscribe to DHTML history change
// events
dhtmlHistory.addListener(historyChange);
// if this is the first time we have
// loaded the page...
if (dhtmlHistory.isFirstLoad()) {
debug("Adding values to browser "
+ "history", false);
// start adding history
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);
// cache some values in the history
// storage
debug("Storing key 'fakeXML' into "
+ "history storage", false);
var fakeXML =
'<?xml version="1.0" '
+ 'encoding="ISO-8859-1"?>'
+ '<foobar>'
+ '<foo-entry/>'
+ '</foobar>';
historyStorage.put("fakeXML", fakeXML);
}
// retrieve our values from the history
// storage
var savedXML =
historyStorage.get("fakeXML");
savedXML = prettyPrintXml(savedXML);
var hasKey =
historyStorage.hasKey("fakeXML");
var message =
"historyStorage.hasKey('fakeXML')="
+ hasKey + "<br>"
+ "historyStorage.get('fakeXML')=<br>"
+ savedXML;
debug(message, false);
}
prettyPrintXml() 是一個第一在例子源碼full example source code中的工具方法。這個方法準備簡單的xml顯示在web page ，方便調試。
注
意數據只是在使用頁面的歷史時被持久化，如果瀏覽器關閉了，或者用戶打開一個新的窗口又再次鍵入了ajax應用的地址，歷史數據對這些新的web頁面是不
可用的。歷史數據只有在用前進或回退按鈕時才被持久化，而且在用戶關閉瀏覽器或清空緩存的時候會消失掉。想真正的長時間的持久化，請看Ajax
MAssive Storage System (AMASS).
我們的簡單示例已經完成。演示他（Demo it）或者下載全部的源代碼（download the full source code.）
示例2
我
們的第2個例子是一個簡單的模擬ajax email 應用的示例，叫O'Reilly Mail,類似Gmail. O'Reilly
Mail描述了怎樣使用dhtmlHistory類去控制瀏覽器的歷史，和怎樣使用historyStorage對象去緩存歷史數據。
O'Reilly
Mail 用戶接口（user interface）有兩部分。在頁面的左邊是一個有不同email文件夾和選項的菜單，例如
收件箱，草稿，等等。當一個用戶選擇了一個菜單項，比如收件箱，我們用這個菜單項的內容更新右邊的頁面。在一個實際應用中，我們會遠程取得和顯示選擇的信
箱內容，不過在O'Reilly Mail里，我們簡單的顯示選擇的選項。
O'Reilly Mail使用Really Simple History 框架向瀏覽器歷史里加入菜單變化和更新地址欄，允許用戶利用瀏覽器的回退和前進按鈕對應用做書簽和跳到上一個變化的菜單。
我
們加入一個特別的菜單項，地址簿，來描繪historyStorage
能夠怎樣被使用。地址簿是一個由聯系的名字電子郵件和地址組成的javascript數組，在一個真實的應用里我們會取得他從一個遠程的服務器。不過，在
O'Reilly Mail里，我們在本地創建這個數組，加入幾個名字電子郵件和地址，然后把他們存儲在historyStorage
對象里。如果用戶離開了這個web頁面以后又返回的話，O'Reilly Mail應用重新從緩存里得到地址簿，勝過（不得不）再次訪問遠程服務器。
地址簿是在我們的初始化initialize()方法里存儲和重新取得的
/** Our function that initializes when the page
is finished loading. */
function initialize() {
// initialize the DHTML History framework
dhtmlHistory.initialize();
// add ourselves as a DHTML History listener
dhtmlHistory.addListener(handleHistoryChange);
// if we haven't retrieved the address book
// yet, grab it and then cache it into our
// history storage
if (window.addressBook == undefined) {
// Store the address book as a global
// object.
// In a real application we would remotely
// fetch this from a server in the
// background.
window.addressBook =
["Brad Neuberg 'bkn3@columbia.edu'",
"John Doe 'johndoe@example.com'",
"Deanna Neuberg 'mom@mom.com'"];
// cache the address book so it exists
// even if the user leaves the page and
// then returns with the back button
historyStorage.put("addressBook",
addressBook);
}
else {
// fetch the cached address book from
// the history storage
window.addressBook =
historyStorage.get("addressBook");
}
處
理歷史變化的代碼是簡單的。在下面的代碼中，當用戶不論按下回退還是前進按鈕handleHistoryChange
都被調用。我們得到新的地址（newLocation）
使用他更新我們的用戶接口來改變狀態，通過使用一個叫displayLocation的O'Reilly Mail的工具方法。
/** Handles history change events. */
function handleHistoryChange(newLocation,
historyData) {
// if there is no location then display
// the default, which is the inbox
if (newLocation == "") {
newLocation = "section:inbox";
}
// extract the section to display from
// the location change; newLocation will
// begin with the word "section:"
newLocation =
newLocation.replace(/section\:/, "");
// update the browser to respond to this
// DHTML history change
displayLocation(newLocation, historyData);
}
/** Displays the given location in the
right-hand side content area. */
function displayLocation(newLocation,
sectionData) {
// get the menu element that was selected
var selectedElement =
document.getElementById(newLocation);
// clear out the old selected menu item
var menu = document.getElementById("menu");
for (var i = 0; i < menu.childNodes.length;
i++) {
var currentElement = menu.childNodes[i];
// see if this is a DOM Element node
if (currentElement.nodeType == 1) {
// clear any class name
currentElement.className = "";
}
}
// cause the new selected menu item to
// appear differently in the UI
selectedElement.className = "selected";
// display the new section in the right-hand
// side of the screen; determine what
// our sectionData is
// display the address book differently by
// using our local address data we cached
// earlier
if (newLocation == "addressbook") {
// format and display the address book
sectionData = "<p>Your addressbook:</p>";
sectionData += "<ul>";
// fetch the address book from the cache
// if we don't have it yet
if (window.addressBook == undefined) {
window.addressBook =
historyStorage.get("addressBook");
}
// format the address book for display
for (var i = 0;
i < window.addressBook.length;
i++) {
sectionData += "<li>"
+ window.addressBook[i]
+ "</li>";
}
sectionData += "</ul>";
}
// If there is no sectionData, then
// remotely retrieve it; in this example
// we use fake data for everything but the
// address book
if (sectionData == null) {
// in a real application we would remotely
// fetch this section's content
sectionData = "<p>This is section: "
+ selectedElement.innerHTML + "</p>";
}
// update the content's title and main text
var contentTitle =
document.getElementById("content-title");
var contentValue =
document.getElementById("content-value");
contentTitle.innerHTML =
selectedElement.innerHTML;
contentValue.innerHTML = sectionData;
}
演示（Demo）O'Reilly Mail或者下載（download）O'Reilly Mail的源代碼。
結束語
你現在已經學習了使用Really Simple History API 讓你的AJAX應用響應書簽和前進回退按鈕，而且有代碼可以作為創建你自己的應用的素材。我熱切地期待你利用書簽和歷史的支持完成你的AJAX創造。
資源
·onjava.com:
onjava.com
·Matrix-Java開發者社區:
http://www.matrix.org.cn/
·
Download all sample code for this article.
·
Download the Really Simple History framework.
·Demo O'Reilly Mail or
download the O'Reilly Mail source code. The full example download also includes more examples for you to play with.
·
Coding in Paradise:
The author's weblog, covering AJAX, DHTML, and Java techniques and new
developments in collaborative technologies, such as WikiWikis.
感謝
特別的要感謝每個檢閱這篇文章的the Really Simple History框架的人：
Michael
Eakes, Jeremy Sevareid, David Barrett, Brendon Wilson, Dylan Parker,
Erik Arvidsson, Alex Russell, Adam Fisk, Alex Lynch, Joseph Hoang Do,
Richard MacManus, Garret Wilson, Ray Baxter, Chris Messina, and David
Weekly.