Node.js - 事件 - events.EventEmitter

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. 方法:
    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)聽器的索引蝗蛙。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市醉鳖,隨后出現(xiàn)的幾起案子捡硅,更是在濱河造成了極大的恐慌,老刑警劉巖盗棵,帶你破解...
    沈念sama閱讀 217,185評論 6 503
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件壮韭,死亡現(xiàn)場離奇詭異北发,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)喷屋,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,652評論 3 393
  • 文/潘曉璐 我一進(jìn)店門琳拨,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人屯曹,你說我怎么就攤上這事狱庇。” “怎么了恶耽?”我有些...
    開封第一講書人閱讀 163,524評論 0 353
  • 文/不壞的土叔 我叫張陵密任,是天一觀的道長。 經(jīng)常有香客問我驳棱,道長批什,這世上最難降的妖魔是什么农曲? 我笑而不...
    開封第一講書人閱讀 58,339評論 1 293
  • 正文 為了忘掉前任社搅,我火速辦了婚禮,結(jié)果婚禮上乳规,老公的妹妹穿的比我還像新娘形葬。我一直安慰自己,他們只是感情好暮的,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,387評論 6 391
  • 文/花漫 我一把揭開白布笙以。 她就那樣靜靜地躺著,像睡著了一般冻辩。 火紅的嫁衣襯著肌膚如雪猖腕。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,287評論 1 301
  • 那天恨闪,我揣著相機(jī)與錄音倘感,去河邊找鬼。 笑死咙咽,一個胖子當(dāng)著我的面吹牛老玛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播钧敞,決...
    沈念sama閱讀 40,130評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼蜡豹,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了溉苛?” 一聲冷哼從身側(cè)響起镜廉,我...
    開封第一講書人閱讀 38,985評論 0 275
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎愚战,沒想到半個月后娇唯,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體威根,經(jīng)...
    沈念sama閱讀 45,420評論 1 313
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,617評論 3 334
  • 正文 我和宋清朗相戀三年视乐,在試婚紗的時候發(fā)現(xiàn)自己被綠了洛搀。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,779評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡佑淀,死狀恐怖留美,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情伸刃,我是刑警寧澤谎砾,帶...
    沈念sama閱讀 35,477評論 5 345
  • 正文 年R本政府宣布,位于F島的核電站捧颅,受9級特大地震影響景图,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜碉哑,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,088評論 3 328
  • 文/蒙蒙 一挚币、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧扣典,春花似錦妆毕、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,716評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至湿硝,卻和暖如春薪前,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背关斜。 一陣腳步聲響...
    開封第一講書人閱讀 32,857評論 1 269
  • 我被黑心中介騙來泰國打工示括, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人蚤吹。 一個月前我還...
    沈念sama閱讀 47,876評論 2 370
  • 正文 我出身青樓例诀,卻偏偏與公主長得像,于是被迫代替她去往敵國和親裁着。 傳聞我的和親對象是個殘疾皇子繁涂,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,700評論 2 354

推薦閱讀更多精彩內(nèi)容