DIV CSS 佈局教程網

jQuery ajaxQueue 實作:為 Ajax 請求加上 FIFO 佇列
編輯:JQuery特效代碼     

當同一時間有多個 Ajax 請求需要嚴格控制順序時(例如逐步提交、依序載入、避免伺服器被同時轟炸),原生 $.ajax 並不保證完成順序。ajaxQueue 的解法很單純:用一個陣列當佇列,前一個 complete 之後才送下一個。

;(function($) {
  $.ajaxQueue = {
    // 管理 ajax 請求的佇列
    requests: new Array(),

    // 把待發送的 ajax 請求加入佇列
    offer: function(options) {
      var _self = this,
      // 對 complete、beforeSend 進行「劫持」,加入佇列處理方法 poll
      xhrOptions = $.extend({}, options, {
        // 如果請求完成,發送下一個請求
        complete: function(jqXHR, textStatus) {
          if (options.complete) options.complete.call(this, jqXHR, textStatus);
          _self.poll();
        },
        // 如果請求被取消,繼續發送下一個請求
        beforeSend: function(jqXHR, settings) {
          if (options.beforeSend) {
            var ret = options.beforeSend.call(this, jqXHR, settings);
            if (ret === false) { _self.poll(); return ret; }
          }
        }
      });
      this.requests.push(xhrOptions);
      if (this.requests.length == 1) { $.ajax(xhrOptions); }
    },

    // 以 FIFO 方式發送 ajax 請求
    poll: function() {
      if (this.isEmpty()) { return null; }
      var processedRequest = this.requests.shift();
      var nextRequest = this.peek();
      if (nextRequest != null) { $.ajax(nextRequest); }
      return processedRequest;
    },
    // 回傳佇列頭部的請求(不取出)
    peek: function() { return this.isEmpty() ? null : this.requests[0]; },
    // 判斷佇列是否為空
    isEmpty: function() { return this.requests.length == 0; }
  }
})(jQuery);

設計要點

整個機制的巧思在於「劫持兩個回呼」:

  • complete 被包成「先執行使用者原本的 complete,再呼叫 poll() 送出下一個」。用 complete 而非 success,是因為即使請求失敗也必須讓佇列繼續流動,否則一個失敗就會卡死整條隊伍。
  • beforeSend 也被包了一層,處理「請求在送出前就被 abort」的情況——這時 complete 不會觸發,必須手動補一次 poll(),避免佇列停擺。
  • $.extend({}, options, {...}) 建立的是新物件,不會污染呼叫端傳進來的設定。
  • 只有當 requests.length == 1(也就是原本是空的)時才立刻送出,其餘一律排隊。

使用方式

$.ajaxQueue.offer(settings);

其中 settings 的內容與 jQuery 官方文件的 $.ajax 設定完全一致,可以直接把原本的 $.ajax({...}) 換成 $.ajaxQueue.offer({...}),其餘程式碼不必更動。

補充

若只是要限制「同一時間最多 n 個並行請求」,佇列版本顯得過於嚴格;那種情境改用 jQuery 1.5 之後提供的 jqXHR 物件搭配計數器,或使用 $.when() 批次等待,會更合適。但若是「必須嚴格依序、前一笔處理完才能送下一笔」的場景(例如避免同一筆資料被重複鎖定),這個 FIFO 佇列就是最直接的解法。

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