現在很多專案都在做標準的靜態頁面,為了提升使用者體驗,經常會用到 Ajax 效果。而實作 Ajax 最重要的一件工具,就是 XMLHttpRequest 物件。這篇把它的屬性與方法整理成一份可查的對照表。
XmlHttp 是一套 API,讓 JavaScript、VBScript、JScript 等腳本語言能透過 HTTP 協定傳送或接收 XML 及其他格式的資料。它最大的用處是:可以更新網頁的部分內容,而不必重新載入整個頁面——這正是 Ajax 最核心的特點。
IE 把 XHR 實作為 ActiveX 物件,其他瀏覽器(Firefox、Safari、Opera)則實作為原生的 JavaScript 物件,所以要分開處理:
<script language="javascript" type="text/javascript">
var xmlhttp;
function createXMLHTTPRequest(){
if(window.ActiveXObject){ // 判斷是否支援 ActiveX 控制項
xmlhttp = new ActiveXObject("Microsoft.XMLHTTP");
}else if(window.XMLHttpRequest){ // 是否實作為原生 JavaScript 物件
xmlhttp = new XMLHttpRequest();
}
}
</script>
建立一個新的 HTTP 請求,指定方法、網址與驗證資訊。
oXMLHttpRequest.open(bstrMethod, bstrUrl, varAsync, bstrUser, bstrPassword);
onreadystatechange 指定的函式。呼叫後,接著用 send() 把資料送出去。
送出請求並接收回應。同步或非同步取決於 open() 的 varAsync:若為 false,此方法會等到請求完成或逾時才返回;若為 true 則立即返回。
可接受的參數型別包括字串、位元組陣列、XML DOM 物件與資料流。若傳入字串,回應會被編碼為 UTF-8,需要在適當位置設定含 charset 的標頭;若傳入 XML DOM 物件,則使用 XML 文件中宣告的編碼,未宣告時預設 UTF-8。
單獨指定某個請求標頭。若同名標頭已存在則覆寫。必須在 open() 之後呼叫。
oXMLHttpRequest.setRequestHeader(bstrHeader, bstrValue);
前者取得回應的所有 HTTP 標頭,每組名稱與值以冒號分隔、以 CRLF 結束;後者取得指定的單一標頭。兩者都必須在 send() 完成後才能呼叫。
取消目前的請求,呼叫後物件會回到未初始化狀態。
指定 readyState 改變時要執行的事件處理常式。此屬性只寫,是 W3C 文件物件模型的擴展。
只讀,以整數表示目前狀態:
open()send()send() 已呼叫,但目前狀態與標頭未知responseBody 或 responseText 取部分資料會出錯responseText 以字串形式回傳回應。XHR 預設將回應編碼定為 UTF-8;若伺服器回傳的資料帶有 BOM,則可解碼任何 UCS-2(大端或小端)或 UCS-4 資料。注意若伺服器回傳的是 XML 文件,此屬性不會處理文件中的編碼宣告,這種情況要用 responseXML。
responseXML 把回應格式化為 XML 文件物件後回傳。若回應不是有效的 XML,此屬性本身不會返回解析錯誤,需要從處理過的文件物件取得錯誤資訊。
前者以未解碼的位元組陣列回傳二進位資料;後者以 ADO Stream 物件形式回傳回應資訊。兩者主要用於處理非文字內容。
status 回傳標準 HTTP 狀態碼(長整數,只讀),statusText 回傳伴隨的狀態字串。兩者都必須在資料傳送並接收完畢後才能取得。常見狀態碼包括 200(OK)、201(Created)、204(No Content)、301(Moved Permanently)、304(Not Modified)、400(Bad Request)、401(Unauthorized)、403(Forbidden)、404(Not Found)、408(Request Timeout)、500(Internal Server Error)、503(Service Unavailable)等。
把上面的東西排出順序,其實就是固定套路:
open() 設定方法與網址setRequestHeader() 設定 Content-Typeonreadystatechange 處理函式send() 送出readyState == 4 與 status == 200responseText 或 responseXML 取出資料把這六步記熟,之後無論用原生 XHR 還是任何框架,都能對照回來看它幫你做了什麼。