timeout(Number)請求逾時時間(毫秒),此設定會覆蓋全域設定。
async(Boolean,預設 true)預設所有請求皆為非同步。若需同步請求請設為 false,但要注意同步請求會鎖住瀏覽器,使用者其他操作必須等請求完成才能執行。
beforeSend(Function)送出請求前可修改 XMLHttpRequest 物件的函式,常用於加上自訂 HTTP 標頭。XMLHttpRequest 物件是唯一的參數。
function (XMLHttpRequest) {
this; // 本次 ajax 請求的 options
}
cache(Boolean,預設 true)設為 false 將不從瀏覽器快取載入請求資訊。
complete(Function)請求完成後的回呼,成功或失敗都會觸發。參數為 XMLHttpRequest 物件與狀態字串。
contentType(String,預設 "application/x-www-form-urlencoded")送往伺服器時的內容編碼型別,預設值適用大多數場合。
data(Object 或 String)送往伺服器的資料,會自動轉為請求字串格式,GET 請求會附加在 URL 後。必須是 key/value 格式;若為陣列,jQuery 會自動為不同值對應同一個名稱,例如 {foo:["bar1","bar2"]} 會轉為 &foo=bar1&foo=bar2。
dataType(String)預期伺服器回傳的型別。不指定時 jQuery 會依 HTTP 標頭的 MIME 自動判斷,並作為回呼參數傳入。
global(Boolean,預設 true)是否觸發全域 AJAX 事件。設為 false 則不觸發 ajaxStart、ajaxStop 等事件。
ifModified(Boolean,預設 false)僅在伺服器資料有變動時才取新資料,依 HTTP 標頭的 Last-Modified 判斷。
processData(Boolean,預設 true)預設會把資料轉為物件以配合預設的內容型別。若要傳送 DOM 樹或其他不希望被轉換的內容,設為 false。
success(Function)請求成功後的回呼,參數為伺服器回傳的資料與狀態。
"xml":回傳 XML 文件,可用 jQuery 處理。
"html":回傳純文字 HTML,包含 script 元素。
"script":回傳純文字 JavaScript 程式碼,結果不會自動快取。
"json":回傳 JSON 資料。
"jsonp":JSONP 格式。使用 "myurl?callback=?" 形式時,jQuery 會自動把 ? 替換為正確的函式名以執行回呼。
$(document).ready(function () {
jQuery("#clearCac").click(function () {
jQuery.ajax({
url: "/Handle/Do.aspx",
type: "post",
data: { id: '0' },
dataType: "json",
success: function (msg) {
alert(msg);
},
error: function (XMLHttpRequest, textStatus, errorThrown) {
alert(XMLHttpRequest.status);
alert(XMLHttpRequest.readyState);
alert(textStatus);
},
complete: function (XMLHttpRequest, textStatus) {
this; // 本次 AJAX 請求的 options
}
});
});
});
簽名是 error: function (XMLHttpRequest, textStatus, errorThrown)。發生錯誤時,textStatus 除了 null 之外,可能是 "timeout"、"error"、"notmodified"、"parsererror" 其中之一。通常 textStatus 與 errorThrown 只有一個有值。
第一個參數 XMLHttpRequest 有兩個關鍵屬性:
readyState
0 - 未初始化,尚未呼叫 send() 1 - 載入中,已呼叫 send(),正在送出請求 2 - 載入完成,send() 執行完畢,已收到全部回應內容 3 - 互動中,正在解析回應內容 4 - 完成,回應解析完畢,用戶端可使用了
status:HTTP 狀態碼。
第一,data 即使為空也要傳 {}。若不傳,jQuery 可能改以 XML 格式解析回應,進而拋出 parsererror。
第二,parsererror 與回應標頭密切相關。伺服器端必須明確輸出正確的 Content-Type 與編碼,例如 header('Content-type: text/html; charset=utf8');。標頭與實際內容不符,jQuery 就無法正確判斷 dataType,解析自然失敗。
1xx 資訊:臨時回應,用戶端準備接收常規回應。
100 繼續、101 切換協議。
2xx 成功:伺服器成功接受請求。
200 確定、201 已建立、202 已接受、204 無內容、206 部分內容。
3xx 重定向:瀏覽器必須採取更多動作。
301 永久移走、302 臨時移動、304 未修改、307 臨時重定向。
4xx 用戶端錯誤:請求本身有問題。
400 錯誤的請求、401 未授權、403 禁止存取、404 未找到、405 方法不被允許、408 請求逾時、413 請求實體太大、414 請求 URI 太長、415 不支援的媒體型別。
其中 401 與 403 在 IIS 上有更細的子狀態碼,例如 401.1 登入失敗、401.3 因 ACL 限制未獲授權、403.1 禁止執行存取、403.4 要求 SSL、403.6 IP 位址被拒絕等,這些細節會顯示在瀏覽器中但不出現在 IIS 記錄裡。
5xx 伺服器錯誤:伺服器無法完成請求。
500 內部伺服器錯誤、502 作為閘道或代理時收到無效回應、503 服務不可用、504 閘道逾時、505 HTTP 版本不受支援。
比起在 error 回呼裡逐一 alert,更有效率的做法是打開開發者工具的 Network 面板,直接看請求的標頭、酬載與回應內容,並在 complete 裡用 console.log(XMLHttpRequest.status, textStatus) 輸出。另外別忘了 async: false 會凍結整個頁面,除特殊情境外應避免,改用非同步搭配回呼或 Promise 才是常態做法。