設計 AJAX 時最關鍵的技術就是 XMLHttpRequest 物件。以下把它的定義、建立方式與完整的屬性方法整理出來,方便隨時查閱。
最通用的定義是:XmlHttp 是一套讓 JavaScript、VBScript、JScript 等腳本語言能透過 HTTP 協定傳送或接收 XML 及其他資料的 API。它最大的用處,是在不重新整理整個頁面的前提下更新網頁的部分內容——這正是 AJAX 的核心特點。
MSDN 的說法則是:XmlHttp 提供用戶端與 HTTP 伺服器通訊的協定。用戶端可以透過 XmlHttp 物件(MSXML2.XMLHTTP.3.0)向伺服器送出請求,並用 Microsoft XML DOM 處理回應。
補充一點背景:這個東西其實很早就出現了,只是早期瀏覽器支援不足,只有 IE 內建,多數 Web 工程師用不上。後來 Mozilla 與 Safari 把它採為事實標準,主流瀏覽器紛紛跟進。但要注意,XMLHttpRequest 當時並不是 W3C 的正式標準,因此各家瀏覽器的行為略有差異。
IE 把 XMLHttpRequest 實作為一個 ActiveX 物件,其他瀏覽器(Firefox、Safari、Opera 等)則實作為原生的 JavaScript 物件,因此需要做能力偵測:
var xmlhttp;
// 建立 XMLHttpRequest 物件
function createXMLHTTPRequest(){
if (window.ActiveXObject) { // 是否支援 ActiveX 控制項
xmlhttp = new ActiveXObject("Microsoft.XMLHTTP");
} else if (window.XMLHttpRequest) { // 是否實作為原生 JS 物件
xmlhttp = new XMLHttpRequest();
}
}
下面的範例把主要方法與屬性都列出並附註解說明:
<html>
<head>
<title>XMLHttpRequest 物件說明 DEMO</title>
<script language="javascript" type="text/javascript">
<!--
var xmlhttp;
function createXMLHTTPRequext(){
if (window.ActiveXObject) {
xmlhttp = new ActiveXObject('Microsoft.XMLHTTP');
} else if (window.XMLHTTPRequest) {
xmlhttp = new XMLHTTPRequest();
}
}
function PostOrder(xmldoc) {
createXMLHTTPRequext();
// 方法:open
// 語法:oXMLHttpRequest.open(bstrMethod, bstrUrl, varAsync, bstrUser, bstrPassword);
// bstrMethod :http 方法,如 POST、GET、PUT、PROPFIND,大小寫不敏感
// bstrUrl :請求的 URL,可為絕對或相對位址
// varAsync[選] :布林值,是否非同步,預設 true。為 true 時狀態改變會呼叫 onreadystatechange
// bstrUser[選] :伺服器需要驗證時的帳號
// bstrPassword[選]:驗證用的密碼
xmlhttp.Open("get", "https://localhost/example.htm", false);
// 屬性:onreadystatechange
// 指定 readyState 改變時的事件處理常式,此屬性只寫
xmlhttp.onreadystatechange = HandleStateChange;
// 方法:send
// 語法:oXMLHttpRequest.send(varBody);
// varBody 為要送出的資料。同步或異步取決於 open 的 varAsync 參數
xmlhttp.Send(xmldoc);
// 方法:getAllResponseHeaders
// 取得回應的所有 http 標頭,每筆以冒號分隔名稱與值,並以 \r\n 結尾
alert(xmlhttp.getAllResponseHeaders());
// 方法:getResponseHeader
// 語法:strValue = oXMLHttpRequest.getResponseHeader(bstrHeader);
alert(xmlhttp.getResponseHeader("Content-Type"));
document.frmTest.myButton.disabled = true;
// 方法:abort
// 取消當前請求,呼叫後請求回到 UNINITIALIZED 狀態
// xmlhttp.abort();
// 方法:setRequestHeader
// 語法:oXMLHttpRequest.setRequestHeader(bstrHeader, bstrValue);
// 同名標頭會被覆蓋,且必須在 open 之後呼叫
// xmlhttp.setRequestHeader(bstrHeader, bstrValue);
}
function HandleStateChange() {
// 屬性:readyState(唯讀)
// 0 未初始化:物件已建立,尚未呼叫 open
// 1 初始化 :已呼叫 open,尚未呼叫 send
// 2 傳送中 :已呼叫 send,狀態與標頭未知
// 3 接收中 :已收到部分資料,此時取 responseBody/responseText 會出錯
// 4 完成 :資料接收完畢,可取完整回應
if (xmlhttp.readyState == 4) {
document.frmTest.myButton.disabled = false;
// 屬性:responseBody(唯讀)——未解碼的二進位資料
alert(xmlhttp.responseBody);
// 屬性:responseStream(唯讀)——以 ADO Stream 物件回傳
alert(xmlhttp.responseStream);
// 屬性:responseText(唯讀)——以字串回傳回應
// 預設以 UTF-8 解碼;若回應含 BOM,可解 UCS-2 / UCS-4
alert(xmlhttp.responseText);
// 屬性:responseXML(唯讀)——格式化為 XML Document 物件
// 若回應不是合法 XML,需透過 DOM Document 取得錯誤資訊
alert("Result = " + xmlhttp.responseXML.xml);
// 屬性:status(唯讀)——標準 http 狀態碼,如 200、404、500
alert(xmlhttp.status);
// 屬性:statusText(唯讀)——回應行狀態文字
alert(xmlhttp.statusText);
}
}
//-->
</script>
</head>
<body>
<form name="frmTest">
<input name="myButton" type="button" value="Click Me" onclick="PostOrder('https://localhost/example.htm');">
</form>
</body>
</html>
幾個實務上要牢牢記住的規則:
open() 一定要在 setRequestHeader() 與 send() 之前呼叫。getResponseHeader() 與 getAllResponseHeaders() 必須在 send() 之後才能取用。readyState == 4 時,responseText/responseXML/status 才是可靠的;readyState == 3 時取用可能丟出錯誤。status,特別是 200 以外還可能遇到 304、401 或跨網域的 0。最後補一句現況:如今 XMLHttpRequest 已是 W3C 標準的一部分,各家瀏覽器實作高度一致,IE 專屬的 ActiveX 分支早已不必寫;新專案若只是單純取資料,fetch 的介面會更簡潔。