一次 Ajax 請求會觸發一連串事件,jQuery 把它們分成局部與全局兩類,理解順序之後才好安排 loading 提示、錯誤處理等共用邏輯。
局部事件伴隨 $.ajax 的設定物件一起宣告,只對這一次請求生效:
$.ajax({ beforeSend: function(){ // Handle the beforeSend event }, complete: function(){ // Handle the complete event } // ... });
全局事件則可用 bind 綁定、unbind 取消,行為與 click、keyup 這類事件相近,只是它能被掛到任何 DOM 元素上:
$("#loading").bind("ajaxSend", function(){ //使用bind $(this).show(); }).ajaxComplete(function(){ //直接使用ajaxComplete $(this).hide(); });
若某個請求不希望觸發全局事件,加上 global: false 即可:
$.ajax({ url: "test.html", global: false, // ... });
ajaxStart(全局):新的 Ajax 請求開始,且此刻沒有其他請求正在進行。
beforeSend(局部):請求即將送出時觸發,需要時可在此調整 XHR 物件。
ajaxSend(全局):請求送出前的全局通知。
success(局部):伺服器回應正常、資料格式也無誤時觸發。
ajaxSuccess(全局):對應的全局成功通知。
error(局部):僅在發生錯誤時觸發,與 success 不會同時執行。
ajaxError(全局):對應的全局錯誤通知。
complete(局部):不論成功或失敗,請求結束時都會觸發。
ajaxComplete(全局):對應的全局結束通知。
ajaxStop(全局):所有進行中的 Ajax 都結束後觸發。
局部回調的參數在官方文件中已有完整說明。全局事件方面,除了 ajaxStart 與 ajaxStop 之外,其餘都會收到三個參數:event、XMLHttpRequest、ajaxOptions。其中第三個最實用,它保存了當時呼叫 ajax 時傳入的設定物件。
ajaxError 另外還有第四個參數 thrownError,只在真的拋出異常時才會帶值。
利用 ajaxOptions 就能寫出一個共用的狀態提示區:
$("#msg").beforeSend(function(e,xhr,o) { $(this).html("正在請求"+o.url); }).ajaxSuccess(function(e,xhr,o) { $(this).html(o.url+"請求成功"); }).ajaxError(function(e,xhr,o) { $(this).html(o.url+"請求失敗"); });
因為 get、post、load、getScript、getJSON 等方法本質上都是包裝過的 ajax,ajaxOptions.url 永遠拿得到值。
既然第三個參數就是傳給 ajax 的設定,那麼自行塞入額外欄位也完全可行,藉此區分不同請求:
//自定義參數msg $.ajax({url:"test1.html",type:"get",msg:"頁面一"}); $.ajax({url:"test2.html",type:"get",msg:"頁面二"}); $.ajax({url:"test3.html",type:"get",msg:"頁面三"}); $.ajax({url:"test4.html",type:"get",msg:"頁面四"}); //這裡就能獲取到自定義參數msg。 //這可以用來區別對待不同的ajax請求。 $("#msg").beforeSend(function(e,xhr,o) { $(this).html("正在請求"+o.msg); }).ajaxSuccess(function(e,xhr,o) { $(this).html(o.msg+"請求成功"); }).ajaxError(function(e,xhr,o) { $(this).html(o.msg+"請求失敗"); });
get、post、getJSON 這些簡便方法,回調實際上綁的是 success;只有 load 綁的是 complete。照理說它的回調應該只有 XMLHttpRequest 與 textStatus 兩個參數,但實測時 load 會傳入三個:XMLHttpRequest.responseText、textStatus、XMLHttpRequest。
因此在 load 的回調裡,可以用 textStatus == "success" 或 "error" 判斷結果,也能直接檢查 XMLHttpRequest.status 是 200 還是 404。這一點比單純的 get、post 靈活,因為後者無法為個別請求指定 error 處理,改用全域的 ajaxError 反而是務實的折衷。