近來負責製作標準化的靜態頁面,為了提升使用者體驗,Ajax 效果幾乎是必備技能,而這條路上最核心的一塊拼圖就是 XMLHttpRequest 物件。以下把整理好的筆記分享出來,看過的朋友就當複習。
最通用的定義是:XMLHttpRequest 是一套 API,讓 JavaScript、VBScript、JScript 等腳本語言能透過 HTTP 協議傳送與接收 XML 及其他格式的資料。它最大的價值在於——不必刷新整個頁面,就能更新頁面的局部內容,這正是 Ajax 的關鍵特徵。
微軟技術文件(MSDN)的說法則是:XMLHttpRequest 提供用戶端與 HTTP 伺服器通訊的協議,用戶端可以透過該物件(MSXML2.XMLHTTP.3.0)送出請求,並以 XML DOM 處理回應。
值得補充的是,這項技術其實早就存在,只是早期瀏覽器支援有限,基本上只有 IE 能用,因此多數網頁工程師並未真正採用。如今局勢已大不相同:Mozilla 與 Safari 把它當成事實標準實作,主流瀏覽器無不支持。不過要特別留意——XMLHttpRequest 至今並非 W3C 正式標準,因此各瀏覽器上的行為仍存在細微差異。
差異從建立方式就開始了。IE 把 XMLHttpRequest 實作為 ActiveX 物件,而 Firefox、Safari、Opera 等則把它實作為原生的 JavaScript 物件。發送請求與處理回應之前,必須先取得這個物件:
<script language="Javascript" type="text/Javascript">
<!--
var xmlhttp;
function createXMLHTTPRequest(){
if(window.XMLHttpRequest){ // 原生支援(Firefox/Safari/Opera 等)
xmlhttp = new XMLHttpRequest();
}
else if(window.ActiveXObject){ // 走 IE 的 ActiveX 途徑
xmlhttp = new ActiveXObject("Microsoft.XMLHTTP");
}
}
//-->
</script>
實務上建議把原生支援的判斷放在前面,ActiveX 作為後備,並為 ActiveX 的不同版本(MSXML2.XMLHTTP.3.0、Microsoft.XMLHTTP)準備降級順序,這樣在各種 IE 環境下都能拿到可用的物件。
建立新的 HTTP 請求,指定方法、網址與驗證資訊:
onreadystatechange 指定的回呼函式。呼叫 open 之後,接著用 send 把資料送出去。
送出請求並接收回應。參數是可選的請求本文,可接受的字串、位元組陣列、XML DOM 物件或資料流。同步與非同步取決於 open 的 async 參數:若為 false,此方法會等到請求完成或超時才返回;若為 true,則立刻返回。
編碼方面要注意:傳送 BSTR 時回應以 UTF-8 編碼,需在標頭中標明 charset;傳送位元組陣列或資料流時回應原樣送出,呼叫端必須自行設定正確的 Content-Type;傳送 XML DOM 物件時,則採用 XML 文件中宣告的編碼,若未宣告則預設 UTF-8。
// 單獨指定某個請求標頭,名稱相同者會被覆寫;必須在 open 之後呼叫
xmlhttp.setRequestHeader(bstrHeader, bstrValue);
// 取得回應的所有標頭,每組以冒號分隔、以 \r\n 結束;send 完成後才可用
alert(xmlhttp.getAllResponseHeaders());
// 取得指定的回應標頭
alert(xmlhttp.getResponseHeader("Content-Type"));
取消當前請求,呼叫後該請求會退回未初始化的狀態。實務上常用於使用者放棄操作、或需要以新請求取代舊請求的時機。
onreadystatechange 就是綁在 readyState 變化上的事件處理常式,通常在做出一個寫法如下的判斷:
function HandleStateChange(){
if(xmlhttp.readyState == 4){
document.frmTest.myButton.disabled = false;
// 此處開始處理回應內容
}
}
status 回傳標準 HTTP 狀態碼(200、301、404、500 等),statusText 回傳狀態行的文字描述。兩者都只在資料送出並接收完畢後才能讀取,是撰寫錯誤處理時判斷成敗的第一道依據。
把上述元素湊起來,最精簡的骨架大致如下:
function PostOrder(url){
createXMLHTTPRequest();
xmlhttp.open("GET", url, true);
xmlhttp.onreadystatechange = HandleStateChange;
xmlhttp.send(null);
}
function HandleStateChange(){
if(xmlhttp.readyState != 4) return;
if(xmlhttp.status == 200){
alert(xmlhttp.responseText);
} else {
alert("請求失敗:" + xmlhttp.statusText);
}
}
把按鈕的 onclick 指向 PostOrder(),一個可用的非同步請求就成立了。真正進到專案裡,你會發現絕大多數的除錯時間都花在 readyState 的時序判斷與回應編碼這兩件事上——把這兩塊吃透,Ajax 就沒有什麼神秘可言了。