DIV CSS 佈局教程網

jQuery AjaxQueue 佇列封裝的改進思路與完整實作
編輯:JQuery特效代碼     

原生 $.ajax 是各自獨立、可並行送出的。但在某些場景下,我們需要「一次只能有一個請求在跑」的佇列行為,或者反過來「新請求直接作廢舊請求」的覆蓋行為。本文的改進版把這兩種策略都封裝起來。

三個主要改進點

  1. complete 回呼在 jQuery 1.5 之後可以是函數陣列,因此需依序逐一呼叫。
  2. 若前一個請求尚未回應就送出新請求,可選擇撤銷前一個請求,也就是新請求「覆蓋」舊請求。
  3. 改寫成物件導向形式,另外提供一個 AjaxManager 做簡單管理。

完整程式碼

;(function($) {
    // override:新的請求是否要覆蓋之前的請求
    function AjaxQueue(override) {
        this.override = !!override;
    }

    AjaxQueue.prototype = {
        requests: new Array(),

        offer: function(options) {
            var _self = this;
            var xhrOptions = $.extend({}, options, {
                complete: function(jqXHR, textStatus) {
                    // 支援 complete 為函數陣列的情況
                    if ($.isArray(options.complete)) {
                        var funcs = options.complete;
                        for (var i = 0, len = funcs.length; i < len; i++)
                            funcs[i].call(this, jqXHR, textStatus);
                    } else {
                        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;
                    }
                }
            });

            if (this.override) {
                this.replace(xhrOptions);   // 覆蓋模式
            } else {
                this.requests.push(xhrOptions); // 排入佇列
                if (this.requests.length == 1) {
                    $.ajax(xhrOptions);
                }
            }
        },

        // 撤銷前一個請求,送出新的請求
        replace: function(xhrOptions) {
            var prevRet = this.peek();
            if (prevRet != null) {
                prevRet.abort();  // jQuery 源碼中可見此方法
            }
            this.requests.shift();
            this.requests.push($.ajax(xhrOptions));
        },

        // 輪詢佇列,送出下一個請求
        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() {
            if (this.isEmpty()) return null;
            return this.requests[0];
        },

        // 判斷佇列是否為空
        isEmpty: function() {
            return this.requests.length == 0;
        }
    };

    var queue = {};

    // 管理 AjaxQueue 的簡單物件
    var AjaxManager = {
        createQueue: function(name, override) {
            return queue[name] = new AjaxQueue(override);
        },
        destroyQueue: function(name) {
            if (queue[name]) {
                queue[name] = null;
                delete queue[name];
            }
        },
        getQueue: function(name) {
            return (queue[name] ? queue[name] : null);
        }
    };

    // 掛到 jQuery 上,方便呼叫
    $.AM = AjaxManager;
})(jQuery);

使用方式

// 建立一個排隊型的佇列
$.AM.createQueue('serial', false);

// 建立一個覆蓋型的佇列
$.AM.createQueue('latest', true);

$.AM.getQueue('serial').offer({ url: 'a.ashx', success: fn });
$.AM.getQueue('latest').offer({ url: 'b.ashx', success: fn });

設計取捨

覆蓋模式適合用於搜尋建議、即時篩選這類「只關心最後一次輸入結果」的情境,能避免舊回應回來後把畫面覆蓋成過時的內容。排隊模式則適合有先後依賴、不可亂序的作業。

作者也提到,原本還想加上 done、fail、always 等設定,但擔心流於複雜而暫時保持簡潔。這其實是很好的判斷:封裝的第一版應該先解決核心問題,其餘擴充點留給真正有需求時再補。

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