Node.js EventEmitter
Node.js 所有的異步 I/O 操作在完成時都會發(fā)送一個事件到事件隊列饺汹。
Node.js里面的許多對象都會分發(fā)事件:一個net.Server對象會在每次有新連接時分發(fā)一個事件蛔添, 一個fs.readStream對象會在文件被打開的時候發(fā)出一個事件。 所有這些產(chǎn)生事件的對象都是 events.EventEmitter 的實(shí)例兜辞。
EventEmitter類
events 模塊只提供了一個對象: events.EventEmitter
迎瞧。EventEmitter 的核心就是事件觸發(fā)與事件監(jiān)聽器功能的封裝。
可以通過require("events");來引入該模塊逸吵。
// 引入 events 模塊
var events = require('events');
// 創(chuàng)建 eventEmitter 對象
var eventEmitter = new events.EventEmitter();
EventEmitter 對象如果在實(shí)例化時發(fā)生錯誤凶硅,會觸發(fā) error 事件。當(dāng)添加新的監(jiān)聽器時扫皱,newListener 事件會觸發(fā)足绅,當(dāng)監(jiān)聽器被移除時,removeListener 事件被觸發(fā)韩脑。
EventEmitter 的用法舉例:
//event.js 文件
var EventEmitter = require('events').EventEmitter;
var event_emitter = new EventEmitter();
// 注冊氢妈,監(jiān)聽 `some_event` 事件
event_emitter.on('some_event', function() {
console.log('some_event 事件觸發(fā)');
});
setTimeout(function() {
// 觸發(fā) `some_event` 事件
event_emitter.emit('some_event');
}, 1000);
EventEmitter 的每個事件由:
一個事件名和若干個參數(shù)組成。
事件名是一個字符串段多,通常表達(dá)一定的語義首量。對于每個事件,EventEmitter 支持 若干個事件監(jiān)聽器进苍。
當(dāng)事件觸發(fā)時加缘,注冊到這個事件的事件監(jiān)聽器被依次調(diào)用,事件參數(shù)作為回調(diào)函數(shù)參數(shù)傳遞琅捏。
eg:
//event.js 文件
var events = require('events');
var emitter = new events.EventEmitter();
emitter.on('someEvent', function(arg1, arg2) {
console.log('listener1', arg1, arg2);
});
emitter.on('someEvent', function(arg1, arg2) {
console.log('listener2', arg1, arg2);
}); // 多個事件監(jiān)聽器
emitter.emit('someEvent', 'arg1 參數(shù)', 'arg2 參數(shù)'); // 觸發(fā)事件生百,傳遞參數(shù)
運(yùn)行的結(jié)果:
$ node event.js
listener1 arg1 參數(shù) arg2 參數(shù)
listener2 arg1 參數(shù) arg2 參數(shù)
以上例子中,emitter 為事件 someEvent 注冊了兩個事件監(jiān)聽器柄延,然后觸發(fā)了 someEvent 事件蚀浆。
運(yùn)行結(jié)果中可以看到兩個事件監(jiān)聽器回調(diào)函數(shù)被先后調(diào)用缀程。 這就是EventEmitter最簡單的用法。
EventEmitter 提供了多個方法市俊,比如 on()
, emit()
杨凑。on()
函數(shù)用于綁定事件函數(shù),emit()
用于觸發(fā)一個事件摆昧。
所有的 EventEmitter
的方法介紹:
- 方法:
1)addListener(event, listener)
為指定事件添加一個監(jiān)聽器到監(jiān)聽器數(shù)組的尾部撩满。
2)on(event, listener)
為指定事件注冊一個監(jiān)聽器,接受一個字符串 event 和一個回調(diào)函數(shù)绅你。
server.on('connection', function (stream) {
console.log('someone connected!');
});
on 和 addListener 是完全相同的伺帘,
"Experimental: 'on' as alias to 'addListener'".
3)once(event, listener)
為指定事件注冊一個單次監(jiān)聽器,即 監(jiān)聽器最多只會觸發(fā)一次忌锯,觸發(fā)后立刻解除該監(jiān)聽器伪嫁。
server.once('connection', function (stream) {
console.log('Ah, we have our first user!');
});
4)removeListener(event, listener)
移除指定事件的某個監(jiān)聽器,監(jiān)聽器必須是該事件已經(jīng)注冊過的監(jiān)聽器偶垮。
它接受兩個參數(shù):
第一個是事件名稱张咳,第二個是回調(diào)函數(shù)名稱。
var callback = function(stream) {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);
5)removeAllListeners([event])
移除所有事件的所有監(jiān)聽器似舵, 如果指定事件脚猾,則移除指定事件的所有監(jiān)聽器。
6)setMaxListeners(n)
默認(rèn)情況下砚哗, EventEmitters 如果你添加的監(jiān)聽器超過 10 個就會輸出警告信息龙助。 setMaxListeners 函數(shù)用于提高監(jiān)聽器的默認(rèn)限制的數(shù)量。
7)listeners(event)
返回指定事件的監(jiān)聽器數(shù)組频祝。
8)emit(event, [arg1], [arg2], [...])
按參數(shù)的順序執(zhí)行每個監(jiān)聽器泌参,如果事件有注冊監(jiān)聽返回 true,否則返回 false常空。
2.類方法
1)listenerCount(emitter, event)
返回指定事件的監(jiān)聽器數(shù)量沽一。
eg:
events.EventEmitter.listenerCount(emitter, 'my_event')
3.事件
1)newListener
event - 字符串,事件名稱
listener - 處理事件函數(shù)
該事件在添加新監(jiān)聽器時被觸發(fā)漓糙。
2)removeListener
event - 字符串铣缠,事件名稱
listener - 處理事件函數(shù)
從指定監(jiān)聽器數(shù)組中刪除一個監(jiān)聽器。需要注意的是昆禽,此操作將會改變處于被刪監(jiān)聽器之后的那些監(jiān)聽器的索引蝗蛙。