最通用的定義是:XMLHttpRequest 是一套 API,讓 JavaScript、VBScript、JScript 等腳本語言能透過 HTTP 協定傳送請求或接收 XML 及其他格式的資料。它最大的價值在於——可以只更新網頁的一部分內容,而不必重新載入整個頁面。這正是 Ajax 的核心能力。
微軟技術文件(MSDN)的說法是:XmlHttp 提供用戶端與 HTTP 伺服器通訊的協定,用戶端可以透過 XmlHttp 物件(MSXML2.XMLHTTP.3.0)發送請求,並以 XML DOM 處理回應。
值得補充的是,這個技術其實很早就出現了,只是早期僅 Internet Explorer 支援,因此多數網頁開發者並未真正使用它。後來 Mozilla 與 Safari 把它採用為事實上的標準,主流瀏覽器才全面跟進。不過要注意:XMLHttpRequest 早期並不是 W3C 的正式標準,因此各瀏覽器的實作細節存在差異。
IE 把它實作為 ActiveX 物件,其他瀏覽器(Firefox、Safari、Opera)則實作為原生的 JavaScript 物件。因此建立時必須做能力偵測:
<script type="text/javascript">
var xmlhttp;
function createXMLHttpRequest() {
if (window.ActiveXObject) {
// 兼容早期 IE
xmlhttp = new ActiveXObject("Microsoft.XMLHTTP");
} else if (window.XMLHttpRequest) {
// 標準瀏覽器
xmlhttp = new XMLHttpRequest();
}
}
</script>
建立一個新的 HTTP 請求。
true。為 true 時,狀態改變會觸發 onreadystatechange 指定的函式。把請求送到伺服器並接收回應。body 是要傳送的資料。同步或異步取決於 open() 的 async 參數:若為 false,此方法會等到請求完成或逾時才回傳;若為 true,則立刻返回。
單獨設定某個 HTTP 請求標頭。若同名標頭已存在則覆寫。必須在 open() 之後、send() 之前呼叫。
取得回應的所有 HTTP 標頭。每個標頭的名稱與值以冒號分隔,並以 \r\n 結尾。需在 send() 完成後才能呼叫。
取得指定的回應標頭。若伺服器回傳的 Content-Type 為 text/xml,則 getResponseHeader("Content-Type") 會回傳該字串。
取消目前的請求,此後 readyState 會回到 0(未初始化)。
指定 readyState 改變時要執行的事件處理函式。這是整個非同步流程的樞紐。
以字串形式回傳回應內容。XMLHttpRequest 會嘗試解碼為 Unicode 字串,預設編碼為 UTF-8;若回應帶有 BOM(byte-order mark),則可解碼 UCS-2 或 UCS-4 資料。注意:若伺服器回傳的是 XML 文件,此屬性不會處理 XML 內的編碼宣告,這種情況該用 responseXML。
把回應格式化為 XML Document 物件並回傳。若回應不是合法的 XML,此屬性本身不會丟出錯誤,需透過解析後的 DOM 物件取得錯誤資訊。
前者以無符號位元組陣列回傳未經解碼的二進位資料;後者以 ADO Stream 物件形式回傳回應內容。兩者皆為唯讀,主要用於處理非文字類的內容。
status 回傳標準 HTTP 狀態碼(長整數),statusText 回傳文字描述的狀態行。兩者皆為唯讀,且僅在資料傳輸完成後才能取得。
常用狀態碼:
<html>
<head>
<title>XMLHttpRequest 物件說明範例</title>
<script type="text/javascript">
var xmlhttp;
function createXMLHttpRequest() {
if (window.ActiveXObject) {
xmlhttp = new ActiveXObject('Microsoft.XMLHTTP');
} else if (window.XMLHttpRequest) {
xmlhttp = new XMLHttpRequest();
}
}
function postOrder(xmlDoc) {
createXMLHttpRequest();
xmlhttp.open("GET", "https://localhost/example.htm", false);
xmlhttp.onreadystatechange = handleStateChange;
xmlhttp.send(xmlDoc);
alert(xmlhttp.getAllResponseHeaders());
alert(xmlhttp.getResponseHeader("Content-Type"));
}
function handleStateChange() {
if (xmlhttp.readyState == 4) {
document.frmTest.myButton.disabled = false;
alert(xmlhttp.responseText);
alert(xmlhttp.responseXML.xml);
alert(xmlhttp.status);
alert(xmlhttp.statusText);
}
}
</script>
</head>
<body>
<form name="frmTest">
<input name="myButton" type="button" value="Click Me" />
</form>
</body>
</html>
務必檢查 readyState 與 status:只判斷 readyState == 4 是不夠的,還要確認 status == 200,否則伺服器錯誤時你的程式會拿著錯誤頁面的內容繼續處理。
優先使用非同步:同步請求會凍結整個瀏覽器介面,網路稍慢使用者就會以為當機。
今日請優先考慮 fetch:XMLHttpRequest 至今仍然完全可用且支援度極佳,但若是新專案,fetch() 搭配 async/await 能寫出更乾淨、更容易處理錯誤的程式碼。理解 XMLHttpRequest 的運作原理,仍有助於你搞懂底下發生了什麼事。