jQuery源码二周目#6 Callbacks

Callbacks是jQuery中一个独立的模块,这个模块就我所了解的好像是从$.Deferred中抽离出来的,但不仅仅只为$.Deferred服务。Callbacks顾名思义就是回调,但和回调没什么关系,这个模块实际上是观察者模式的实现。

贴一段代码来展示Callbacks的整体结构

    // 回调模块
    jQuery.Callbacks = function () {

        var
            list = [], // 观察者集合

            fire = function () {
                for (var i = 0; i < list.length; i++) {
                    list[i]();
                }
            },

            self = {
                add: function () {
                    list.push(fn);
                },

                fire: function() {
                    fire();
                }
            };

        return self;
    }

真正的观察者模式就这么简单,但jQuery的Callbacks模块在这个基础上实现了4种不同的模式

模式 描述
once 确保回调列表只执行一次(即只能调用一次fire()方法,再次调用不会执行任何逻辑)
memory 每当添加新的函数时,立即执行该函数,并且将最后一次调用fire()时传入的参数作为该函数的参数
unique 确保添加的回调函数没有重复
stopOnFalse 当回调函数返回false时中断调用

以下是实现这四种模式后的代码

    // 回调模块
    jQuery.Callbacks = function (options) {
        options = typeof options === 'string' ?
            createOptions(options) :
            jQuery.extend({}, options);

        var
            firing,             // list是否使用中
            fired,              // list是否使用过
            locked,             // list是否锁定中
            memory,             // { Callbacks对象, fire()的参数 }
            list = [],          // 观察者集合
            queue = [],         // 保存着上一次调用fire()时传入的参数
            firingIndex = -1,   // 当传入参数有memory时要用到这个参数定位

            fire = function () {
                // 标记list使用中并且已经执行过一次了
                fired = firing = true;

                memory = queue.shift();
                for (; ++firingIndex < list.length;) {
                    var result = list[firingIndex].apply(memory[0], memory[1]);
                    if (options.stopOnFalse && result === false) {
                        break;
                    }
                }

                if (options.once) {
                    list = [];
                }

                // 重置firingIndex
                firingIndex = -1;
                // list使用结束
                firing = false;
            },

            self = {
                add: function () {
                    if (memory && !firing) {
                        firingIndex = list.length - 1;
                        queue.push(memory);
                    }

                    jQuery.each(arguments, function (fn) {
                        // unique并且list中已经添加过该方法了
                        if (options.unique && list.indexOf(fn) !== -1) {
                            return;
                        }

                        list.push(fn);
                    })

                    // 如果options中有memory,add过程中会立即执行当前函数
                    if (memory && !firing) {
                        fire();
                    }
                },

                fireWith: function(context, args) {
                    args = args || [];
                    args = [context, args.slice ? args.slice() : args];
                    // 把[context, 参数]放进queue里面
                    queue.push(args);
                    if (!firing) {
                        fire();
                    }
                    return this;
                },

                fire: function() {
                    return self.fireWith(this, arguments);
                }
            };

        return self;
    }

其他辅助性代码

    var rnothtmlwhite = /[^\W]+/g;

    // 供jQuery.Callbacks使用
    function createOptions(options) {
        var object = {};
        jQuery.each(options.match(rnothtmlwhite) || [], function (item) {
            object[item] = true;
        })
        return object;
    }

虽然jQuery源码比上面代码多得多,但以上代码已经将主要的功能实现,代码我也亲测过,请放心使用。

4中模式里面once、unique和stopOnFalse实现起来都很容易,memory实现最复杂。接下来讲讲这个模块的一些小细节。
1.首先是回调模块中有个参数firing用于标识list是否使用中,如果为true则不会执行fire()方法,这是用来规避多线程问题的,但js是单线程语言,感觉这一步处理没什么必要。
2.add()函数中jQuery.each(arguments, function (fn) {这种写法是处理一次性添加多个函数的情况,考虑的很周到。而且fire()函数也同样没有定义形参,而是用arguments解决参数问题,这也是出于参数可能不止一个的考虑。
3.使用memoryqueue两个变量来保存最后一次调用fire()时传入的参数,由于我自己写的代码有一些bug没有解决掉,所以memory这一块的实现我是照搬的jQuery源码

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,271评论 5 466
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,725评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,252评论 0 328
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,634评论 1 270
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,549评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 47,985评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,471评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,128评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,257评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,233评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,235评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,940评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,528评论 3 302
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,623评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,858评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,245评论 2 344
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,790评论 2 339