nodeJS之事件events

events子產品是node的核心子產品，幾乎所有常用的node子產品都繼承了events子產品，比如http、fs等。本文将詳細介紹nodeJS中的事件機制

EventEmitter

　　多數 Node.js 核心 API 都是采用慣用的異步事件驅動架構，其中某些類型的對象（稱為觸發器）會周期性地觸發命名事件來調用函數對象（監聽器）。例如，一個net.Server對象會在每次有新連接配接時觸發一個事件；一個 fs.ReadStream 會在檔案被打開時觸發一個事件；一個 stream會在資料可讀時觸發事件。

【EventEmitter】

　　EventEmitter 類由 events 子產品定義和開放的，所有能觸發事件的對象都是 EventEmitter 類的執行個體

var EventEmitter = require('events');/*{ [Function: EventEmitter]
  EventEmitter: [Circular],
  usingDomains: false,
  defaultMaxListeners: [Getter/Setter],
  init: [Function],
  listenerCount: [Function] } */console.log(EventEmitter);      

　　events子產品的EventEmitter屬性指向該子產品本身

var events = require('events');
console.log(events.EventEmitter === events);//true      

　　EventEmitter是一個構造函數，可以用來生成事件發生器的執行個體emitter

var EventEmitter = require('events');var emitter = new EventEmitter();/*EventEmitter {
  domain: null,
  _events: {},
  _eventsCount: 0,
  _maxListeners: undefined } */console.log(emitter);      

方法

【emitter.emit(eventName[, ...args])】

eventName <any>...args <any>      

　　該方法按監聽器的注冊順序，同步地調用每個注冊到名為eventName事件的監聽器，并傳入提供的參數。如果事件有監聽器，則傳回true，否則傳回false

var EventEmitter = require('events');var emitter = new EventEmitter();
emitter.on('test1',function(){});
console.log(emitter.emit('test1'));//trueconsole.log(emitter.emit('test2'));//false      

【emitter.on(eventName, listener)】

　　該方法用于添加listener函數到名為eventName的事件的監聽器數組的末尾

eventName <any> 事件名
listener <Function> 回調函數      

　　[注意]不會檢查listener是否已被添加。多次調用并傳入相同的eventName和listener會導緻listener被添加與調用多次

var EventEmitter = require('events');var emitter = new EventEmitter();
emitter.on('test',function(){
    console.log(1);
});
emitter.on('test',function(){
    console.log(2);
});
emitter.emit('test');//1 2      

　　該方法傳回一個 EventEmitter 引用，可以鍊式調用

var EventEmitter = require('events');var emitter = new EventEmitter();
emitter.on('test',function(){
    console.log(1);
}).on('test',function(){
    console.log(2);
});
emitter.emit('test');//1 2      

【emitter.addListener(eventName, listener)】

　　emitter.on(eventName, listener) 的别名

var EventEmitter = require('events');var emitter = new EventEmitter();
emitter.addListener('test',function(){
    console.log(1);
});
emitter.emit('test');//1      

【emitter.prependListener()】

　　與on()方法不同，prependListener()方法可用于将事件監聽器添加到監聽器數組的開頭

var EventEmitter = require('events');var emitter = new EventEmitter();
emitter.on('test',function(){
    console.log(1);
}).prependListener('test',function(){
    console.log(2);
});
emitter.emit('test');//2 1      

【emitter.once(eventName, listener)】

　　該方法添加一個單次 listener 函數到名為 eventName 的事件。 下次觸發 eventName 事件時，監聽器會被移除，然後調用

eventName <any> 事件名
listener <Function> 回調函數      

var EventEmitter = require('events');var emitter = new EventEmitter();
emitter.on('test',function(){
    console.log(1);
}).once('test',function(){
    console.log(2);
});
emitter.emit('test');//1 2emitter.emit('test');//1      

【emitter.prependOnceListener() 】

　　該方法用于将事件監聽器添加到監聽器數組開頭。下次觸發eventName事件時，監聽器會被移除，然後調用

var EventEmitter = require('events');var emitter = new EventEmitter();
emitter.on('test',function(){
    console.log(1);
}).prependOnceListener('test',function(){
    console.log(2);
});
emitter.emit('test');//2 1emitter.emit('test');//1      

【emitter.removeAllListeners([eventName])】

eventName <any>      

　　移除全部或指定 eventName 的監聽器，傳回一個 EventEmitter 引用，可以鍊式調用

　　[注意]在代碼中移除其他地方添加的監聽器是一個不好的做法，尤其是當 EventEmitter 執行個體是其他元件或子產品（如 socket 或檔案流）建立的

var EventEmitter = require('events');var emitter = new EventEmitter();
emitter.on('test',function(){
    console.log(1);
}).removeAllListeners('test');
emitter.emit('test');//''      

【emitter.removeListener(eventName, listener)】

eventName <any>listener <Function>      

　　從名為 eventName 的事件的監聽器數組中移除指定的 listener

var EventEmitter = require('events');var emitter = new EventEmitter();function show(){
    console.log(1);
}
emitter.on('test',show).removeListener('test',show);
emitter.emit('test');//''      

　　[注意]removeListener最多隻會從監聽器數組裡移除一個監聽器執行個體。如果任何單一的監聽器被多次添加到指定eventName的監聽器數組中，則必須多次調用removeListener才能移除每個執行個體

var EventEmitter = require('events');var emitter = new EventEmitter();function show(){
    console.log(1);
}
emitter.on('test',show).on('test',show).removeListener('test',show);
emitter.emit('test');//'1'      

　　[注意]一旦一個事件被觸發，所有綁定到它的監聽器都會按順序依次觸發。這意味着，在事件觸發後、最後一個監聽器完成執行前，任何 removeListener() 或 removeAllListeners() 調用都不會從 emit() 中移除它們。 随後的事件會像預期的那樣發生

　　因為監聽器是使用内部數組進行管理的，是以調用它會改變在監聽器被移除後注冊的任何監聽器的位置索引。 雖然這不會影響監聽器的調用順序，但意味着由 emitter.listeners() 方法傳回的監聽器數組副本需要被重新建立

var EventEmitter = require('events');var emitter = new EventEmitter();function show1(){
    console.log(1);
    emitter.removeListener('test',show2);
}function show2(){
    console.log(2);
}
emitter.on('test',show1).on('test',show2);
emitter.emit('test');//1 2emitter.emit('test');//1      

設定

【emitter.eventNames()】

　　傳回一個列出觸發器已注冊監聽器的事件的數組。 數組中的值為字元串或符号

var EventEmitter = require('events');var emitter = new EventEmitter();
emitter.addListener('test1',function(){console.log(1);});
emitter.addListener('test2',function(){console.log(2);});
console.log(emitter.eventNames());//[ 'test1', 'test2' ]      

【emitter.listenerCount(eventName)】

eventName <any> 正在被監聽的事件名      

　　傳回正在監聽名為 eventName 的事件的監聽器的數量

var EventEmitter = require('events');var emitter = new EventEmitter();
emitter.addListener('test',function(){console.log(1);});
emitter.addListener('test',function(){console.log(1);});
console.log(emitter.listenerCount('test'));//2      

【emitter.listeners(eventName)】

eventName <any>      

　　傳回名為 eventName 的事件的監聽器數組的副本

var EventEmitter = require('events');var emitter = new EventEmitter();
emitter.addListener('test',function(){console.log(1);});
emitter.addListener('test',function(){console.log(2);});
console.log(emitter.listeners('test'));//[ [Function], [Function] ]emitter.listeners('test')[0]();//1      

【emitter.getMaxListeners()】

　　傳回 EventEmitter 目前的最大監聽器限制值

var EventEmitter = require('events');var emitter = new EventEmitter();
console.log(emitter.getMaxListeners());//10      

【emitter.setMaxListeners(n)】

　　預設情況下，如果為特定事件添加了超過 10 個監聽器，則 EventEmitter 會列印一個警告。 此限制有助于尋找記憶體洩露。 但是，并不是所有的事件都要被限為 10 個。 emitter.setMaxListeners() 方法允許修改指定的 EventEmitter 執行個體的限制。 值設為 Infinity（或 0）表明不限制監聽器的數量。傳回一個 EventEmitter 引用，可以鍊式調用

var EventEmitter = require('events');var emitter = new EventEmitter();
emitter.on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){});/*Warning: Possible EventEmitter memory leak detected. 11 a listeners added. Use emitter.setMaxListeners() to increase limit */      

var EventEmitter = require('events');var emitter = new EventEmitter();
emitter.setMaxListeners(11);
emitter.on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){});      

【EventEmitter.defaultMaxListeners】

　　每個事件預設可以注冊最多10個監聽器。單個EventEmitter執行個體的限制可以使用emitter.setMaxListeners(n)方法改變。所有EventEmitter執行個體的預設值可以使用EventEmitter.defaultMaxListeners屬性改變

　　[注意]設定 EventEmitter.defaultMaxListeners 要謹慎，因為會影響所有EventEmitter 執行個體，包括之前建立的。因而，調用 emitter.setMaxListeners(n) 優先于 EventEmitter.defaultMaxListeners

var EventEmitter = require('events');var emitter = new EventEmitter();
EventEmitter.defaultMaxListeners = 11;
emitter.on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){}).on('a',function(){});      

事件

【'newListener' 事件】

eventName <any> 要監聽的事件的名稱
listener <Function> 事件的句柄函數      

　　EventEmitter 執行個體會在一個監聽器被添加到其内部監聽器數組之前觸發自身的 'newListener' 事件

　　注冊了 'newListener' 事件的監聽器會傳入事件名與被添加的監聽器的引用。事實上，在添加監聽器之前觸發事件有一個微妙但重要的副作用： 'newListener' 回調中任何額外的被注冊到相同名稱的監聽器會在監聽器被添加之前被插入 

var EventEmitter = require('events');var emitter = new EventEmitter();
emitter.on('newListener',function(){
    console.log(2);
})
emitter.on('test',function(){
    console.log(1);
})

emitter.emit('test');//2 1      

var EventEmitter = require('events');var emitter = new EventEmitter();
emitter.on('test',function(){
    console.log(1);
})
emitter.on('newListener',function(){
    console.log(2);
})
emitter.emit('test');//1      

【'removeListener' 事件】

eventName <any> 事件名
listener <Function> 事件句柄函數      

　　'removeListener' 事件在 listener 被移除後觸發

var EventEmitter = require('events');var emitter = new EventEmitter();function show(){
    console.log(1);
}
emitter.on('removeListener',function(){
    console.log(2);//2})
emitter.on('test',show).removeListener('test',show);      

var EventEmitter = require('events');var emitter = new EventEmitter();function show(){
    console.log(1);
}
emitter.on('test',show).removeListener('test',show);
emitter.on('removeListener',function(){
    console.log(2);//''})      

var EventEmitter = require('events');var emitter = new EventEmitter();function show(){
    console.log(1);
}
emitter.removeListener('test',show);
emitter.on('removeListener',function(){
    console.log(2);//''})