摘要：屬性該方法用于存儲的整個事件名稱與回調(diào)函數(shù)的集合，初始值為。當(dāng)該屬性當(dāng)前值為一個對象且其函數(shù)不等于函數(shù)時，則會將其轉(zhuǎn)換為一個包含這兩個事件對象的事件對象數(shù)組。

事件監(jiān)聽在前端的開發(fā)過程中是一個很常見的情況。DOM上的事件監(jiān)聽方式，讓我們看到了通過事件的方式來進(jìn)行具體的業(yè)務(wù)邏輯的處理的便捷。

在具體的一些業(yè)務(wù)場景中，第三方的自定義事件能夠在層級較多，函數(shù)調(diào)用困難以及需要多個地方響應(yīng)的時候有著其獨(dú)特的優(yōu)勢——調(diào)用方便，避免多層嵌套，降低組件間耦合性。

這篇文章所提到的EventEmitter3，就是一個典型的第三方事件庫，能夠讓我們通過自定義的實(shí)踐來實(shí)現(xiàn)多個函數(shù)與組件間的通信。

EventEmitter3的設(shè)計(jì)較為的簡單，具體結(jié)構(gòu)可以看下圖所示。

下面我們將按照一般人的正常思路來對這個結(jié)構(gòu)進(jìn)行介紹。

function EE(fn, context, once) {
    this.fn = fn;
    this.context = context;
    this.once = once || false;
}

從類EE的代碼中我們能夠很明確的了解到，第一個參數(shù)為回調(diào)函數(shù)，第二個參數(shù)為回調(diào)函數(shù)的上下文，第三個參數(shù)是一個once的標(biāo)志位。由于代碼簡單，在這里就簡單介紹下了。

該方法用于存儲eventEmitter的整個事件名稱與回調(diào)函數(shù)的集合，初始值為undefined。

作用：返回當(dāng)前已經(jīng)注冊的事件名稱的列表

參數(shù)：無

作用：返回某一個事件名稱的所有監(jiān)聽函數(shù)

參數(shù)：event——事件名稱，exists——是否只判斷存在與否

作用：觸發(fā)某個事件

參數(shù)：event——事件名，a1~a5——參數(shù)1~5

作用：為某個事件添加一個監(jiān)聽函數(shù)

參數(shù)：event——事件名，fn——回調(diào)函數(shù)，context——上下文

作用：類似on,區(qū)別在于該函數(shù)只會觸發(fā)一次

參數(shù)：event——事件名，fn——回調(diào)函數(shù)，context——上下文

作用：移除某個事件的監(jiān)聽函數(shù)

參數(shù)：event——事件名，fn——事件監(jiān)聽函數(shù)，context——只移除上下文匹配的事件監(jiān)聽函數(shù)，once——只移除類型匹配的事件監(jiān)聽函數(shù)

作用：移除某個時間的所有監(jiān)聽函數(shù)

參數(shù)：event——事件名

下面我們將從添加監(jiān)聽函數(shù)， 事件觸發(fā)與刪除監(jiān)聽函數(shù)來進(jìn)行具體的代碼分析，從而了解該庫的實(shí)現(xiàn)思路。

具體代碼如下所示：

 //一個單一的事件監(jiān)聽函數(shù)的單元
 //
 // @param {Function} fn Event handler to be called. 回調(diào)函數(shù)
 // @param {Mixed} context Context for function execution. 函數(shù)執(zhí)行上下文
 // @param {Boolean} [once=false] Only emit once 是否執(zhí)行一次的標(biāo)志位
 // @api private 私有API
 
function EE(fn, context, once) {
    this.fn = fn;
    this.context = context;
    this.once = once || false;
}

該類為eventEmitter中用于存儲事件監(jiān)聽函數(shù)的最小類。

on函數(shù)具體代碼如下所示：

 // Register a new EventListener for the given event.
 // 注冊一個指定的事件的事件監(jiān)聽函數(shù)
 //
 // @param {String} event Name of the event. 事件名
 // @param {Function} fn Callback function. 回調(diào)函數(shù)
 // @param {Mixed} [context=this] The context of the function. 上下文
 // @api public 公有API
 
 EventEmitter.prototype.on = function on(event, fn, context) {
    var listener = new EE(fn, context || this)
        , evt = prefix ? prefix + event : event;

    if (!this._events) this._events = prefix ? {} : Object.create(null);
    if (!this._events[evt]) {
        this._events[evt] = listener;//第一次存儲為一個事件監(jiān)聽對象
    } else {
        if (!this._events[evt].fn) {//第三次及以后則直接向?qū)ο髷?shù)組中添加事件監(jiān)聽對象
            this._events[evt].push(listener);
        } else {//第二次將存儲的對象與新對象轉(zhuǎn)換為事件監(jiān)聽對象數(shù)組
            this._events[evt] = [
                this._events[evt], listener
            ];
        }
    }

    return this;
}

當(dāng)我們向事件E添加函數(shù)F時，會調(diào)用on方法，此時on方法會檢查eventEmitter中prototype屬性events的E屬性。

當(dāng)這個屬性為undefined時，直接將該函數(shù)所在的事件對象賦值給evt屬性。

當(dāng)該屬性當(dāng)前值為一個對象且其函數(shù)fn不等于函數(shù)F時，則會將其轉(zhuǎn)換為一個包含這兩個事件對象的事件對象數(shù)組。

當(dāng)這個屬性已經(jīng)是一個對象數(shù)組時，則直接通過push方法向數(shù)組中添加對象。

prefix是用來判斷Object.create()方法是否存在，如果存在則直接調(diào)用該方法來創(chuàng)建屬性，否則通過在屬性前添加~來避免覆蓋原有屬性。

once的函數(shù)實(shí)現(xiàn)與on函數(shù)基本一致，所以在此就不再進(jìn)行分析。

emit函數(shù)代碼如下所示：

// Emit an event to all registered event listeners.
// 觸發(fā)已經(jīng)注冊的事件監(jiān)聽函數(shù)
//
// @param {String} event The name of the event. 事件名
// @returns {Boolean} Indication if we"ve emitted an event. 如果觸發(fā)事件成功,則返回true,否則返回false
// @api public 公有API

EventEmitter.prototype.emit = function emit(event, a1, a2, a3, a4, a5) {
    var evt = prefix ? prefix + event : event;

    if (!this._events || !this._events[evt]) return false;

    var listeners = this._events[evt]
        , len = arguments.length
        , args
        , i;

    if ("function" === typeof listeners.fn) {
        if (listeners.once) this.removeListener(event, listeners.fn, undefined, true);

        switch(len) {
            case 1:
                return listeners.fn.call(listeners.context), true;
            case 2:
                return listeners.fn.call(listeners.context, a1), true;
            case 3:
                return listeners.fn.call(listeners.context, a1, a2), true;
            case 4:
                return listeners.fn.call(listeners.context, a1, a2, a3), true;
            case 5:
                return listeners.fn.call(listeners.context, a1, a2, a3, a4), true;
            case 6:
                return listeners.fn.call(listeners.context, a1, a2, a3, a4, a5), true;
        }

        for(i = 1, args = new Array(len - 1); i < len; i++) {
            args[i - 1] = arguments[i];
        }

        listeners.fn.apply(listeners.context, args);
    } else {
        //由于篇幅原因省略E屬性為數(shù)組時通過循環(huán)調(diào)用來實(shí)現(xiàn)事件觸發(fā)的過程
    }

    return true;
};

當(dāng)我們觸發(fā)事件E時，我們只需要調(diào)用emit方法。該方法會自動檢索事件E中所有的事件監(jiān)聽對象，觸發(fā)所有的事件監(jiān)聽函數(shù)，同時移除掉通過once添加，只需要觸發(fā)一次的事件監(jiān)聽函數(shù)。

removeListener函數(shù)代碼如下：

// Remove event listeners.
// 移除事件監(jiān)聽函數(shù)
//
// @param {String} event The event we want to remove. 需要被移除的事件名
// @param {Function} fn The listener that we need to find. 需要被移除的事件監(jiān)聽函數(shù)
// @param {Mixed} context Only remove listeners matching this context. 只移除匹配該參數(shù)指定的上下文的監(jiān)聽函數(shù)
// @param {Boolean} once Only remove once listeners. 只移除匹配該參數(shù)指定的once屬性的監(jiān)聽函數(shù)
// @api public 公共API

EventEmitter.prototype.removeListener = function removeListener(event, fn, context, once) {
    var evt = prefix ? prefix + event : event;

    if (!this._events || !this._events[evt]) return this;

    var listeners = this._events[evt]
        , events = [];

    if (fn) {
        if (listeners.fn) {
            if (
                listeners.fn !== fn
                || (once && !listeners.once)
                || (context && listeners.context !== context)
            ) {
                events.push(listeners);
            }
        } else {
            //由于篇幅原因省去便利listeners屬性查找函數(shù)刪除的代碼
        }
    }

    //
    // Reset the array, or remove it completely if we have no more listeners.
    //
    if (events.length) {
        this._events[evt] = events.length === 1 ? events[0] : events;
    } else {
        delete this._events[evt];
    }

    return this;
};

removeListener函數(shù)實(shí)現(xiàn)較為簡單。當(dāng)我們需要移除事件E的某個函數(shù)時，它使用一個event屬性來保存不需要被移除的事件監(jiān)聽對象，然后便利整個事件監(jiān)聽數(shù)組（單個時為對象），并且最后將event屬性的值賦值給E屬性從而覆蓋掉原有的屬性，達(dá)到刪除的目的。

該庫中還有一些其他的函數(shù)，由于對整個庫的理解不產(chǎn)生太大影響，因此沒有在此進(jìn)行講解，有需要的可以前往我的github倉庫進(jìn)行查看。

eventEmitter的代碼雖然結(jié)構(gòu)清晰，但是仍然存在一些問題。例如on和once方法的實(shí)現(xiàn)中，只有一個屬性不同，其余代碼都一模一樣，其實(shí)可以抽出一個特定的函數(shù)來進(jìn)行處理，通過屬性來進(jìn)行區(qū)分調(diào)用即可。

同時，在同一個函數(shù)例如emit中，也存在大量的重復(fù)代碼，可以進(jìn)行進(jìn)一步的抽象和整理，使得代碼更加簡單。

eventEmitter第三方事件庫從實(shí)現(xiàn)上來看較為簡單，并且結(jié)構(gòu)清晰容易閱讀，推薦有興趣的可以花大約一個小時的時間來學(xué)習(xí)下。

本人github地址——eventEmitter3
官方github地址