DIV CSS 佈局教程網

jQuery ajax 取消請求:abort() 用法與一個容易踩到的回呼陷阱
編輯:JQuery特效代碼     

jQuery 的手冊裡翻不到 abort() 的正式條目,因為它其實不是 jQuery 自己發明的方法,而是原生 XMLHttpRequest 物件上的標準方法——只是 $.get()、$.post() 這類別名會回傳 XHR 物件,所以我們才有機會碰到它。

基本用法

把請求的返回值接住,就能在需要時中止它:

current_request = $.get('/events', { '七夕': '發春' }, function(resp) {
    alert(resp);
});

if (current_request) {
    current_request.abort();
}

current_request 就是底層的 XHR 物件,abort() 會立刻中斷這次傳輸。

陷阱:abort 之後 success 仍然會觸發

這是最容易讓人困惑的一點。呼叫 abort() 取消請求後,$.ajax 的 success 事件實際上還是會被觸發,此時回傳的內容是空的。如果你的回呼裡寫了假設「資料一定存在」的邏輯,就會在這裡出錯。

因此正確做法是在 success 的回呼中先檢查請求物件是否仍然有效,確定存在才執行後續處理:

current_request = $.ajax({
    url: "/events",
    success: function(resp) {
        if (!current_request) { return; }   // 已被取消,直接退出
        $("#result").html(resp);
    }
});

// 想取消時
if (current_request) {
    current_request.abort();
    current_request = null;                 // 記得清掉參照
}

更嚴謹的寫法:用 error 判斷

如果希望程式邏輯更明確,可以改用完整的 $.ajax 寫法,並在 error 裡辨識被中止的狀態。當請求被 abort 時,status 會是 "abort":

var xhr = $.ajax({
    url: "/events",
    success: function(resp){ $("#result").html(resp); },
    error: function(xhr, status){
        if (status === "abort") { return; }   // 是我們主動取消的,不用處理
        $("#result").text("請求失敗");
    }
});

// 稍後取消
xhr.abort();

什麼情況會需要它

最常見的場景是「搜尋框即時查詢」:使用者每打一個字就發一次請求,如果打字速度快,舊請求可能還沒回來、新請求又發出去,最後畫面顯示的會是回來順序最慢的那個結果,而不是最新的關鍵字。把前一次未完成的請求 abort 掉,就能確保只有最後一次的查詢結果會被呈現。

var timer, xhr;
$("#search").keyup(function(){
    clearTimeout(timer);
    if (xhr) { xhr.abort(); }               // 取消上一個還在跑的請求
    timer = setTimeout(function(){
        xhr = $.get("/search", { q: $(this).val() }, render);
    }.bind(this), 300);
});

結論很簡單:abort() 本身沒問題,問題在於你以為取消之後就什麼都不會發生。記得在回呼裡加上防禦判斷,或者改用 error 分辨 abort 狀態,就能避開這個坑。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved