在 Node 裡,很多對象都會發射事件。比如 TCP 服務器每當有客戶端連接就發射 connect 事件,文件系統每讀取一整塊數據就發射 data 事件。這些對象被稱為事件發射器(event emitter)。它們允許程序員訂閱感興趣的事件,把回調函數綁定上去,一旦事件發射,回調便會被調用。發布/訂閱模式與傳統 GUI 模式類似,比如按鈕被點擊時程序會收到通知。Node 專門提供了一個 EventEmitter 偽類,可作為基類來創建自己的事件發射器。
異步編程不使用返回值表明調用結束,而是採用後繼傳遞風格(CPS,Continuation-passing style):CPS 函數會接受一個函數作為額外參數,用來顯式指出程序控制的下個流程,當它算出「返回值」,就調用那個函數並把結果作為參數傳入。
var fs = require('fs');
fs.readFile('/etc/passwd', function(err, fileContent) {
if (err) { throw err; }
console.log('file content', fileContent.toString());
});這裡傳了一個內聯匿名函數作為 readFile 的第二個參數,這就是在用 CPS 編程。注意回調的第一個參數是錯誤對象,這是 Node 裡 CPS 的常見約定。
標準回調模式適合用於「函數完成後通知一次」的場景。但如果一個函數執行過程中會發生多個或重複的事件,回調就不夠用了。比如想在 socket 每次收到可用數據時得到通知,這時事件發射器模式就派上用場——它用一套標準接口清晰地分離了事件發射器與事件監聽器。
var req = http.request(options, function(response) {
response.on("data", function(data) {
console.log("some data from the response", data);
});
response.on("end", function() {
console.log("response ended");
});
});
req.end();這裡 http.request 用 CPS,是因為程序需要在請求完成後才繼續;而返回的 response 對象是事件發射器,可發射 data、end 等多個事件。經驗法則是:需要「請求完成後重新獲得執行權」時用 CPS,事件可能發生多次時用事件發射器模式。
被發射的事件都有一個字符串類型的名稱,約定俗成由不含空字符的小寫單詞組成。由於事件發射器 API 沒有內省機制,無法從代碼推斷它能產生哪些事件,因此應查閱文檔。
事件發生時,發射器會調用相關監聽器並把數據作為參數傳入。比如 data 事件回調接受一個 data 對象,end 事件則不接受任何數據。特別要留意 error 事件:大多數發射器在出錯時會產生 error 事件,如果沒有監聽它,錯誤會作為未捕獲異常向上拋出,導致程序崩潰。
var em = new (require('events').EventEmitter)();
em.emit('event1');
em.emit('error', new Error('My mistake'));.addListener 和 .on —— 為指定類型的事件添加監聽器 .once —— 綁定一個僅執行一次的監聽器 .removeListener —— 刪除綁定到某事件上的某個監聽器 .removeAllListeners —— 刪除綁定到某事件上的所有監聽器
用 .addListener() 或 .on() 綁定回調:
function receiveData(data) {
console.log("got data from file read stream: %j", data);
}
readStream.addListener("data", receiveData);
// .on 只是 .addListener 的簡寫
readStream.on("data", receiveData);
// 也可以用內聯匿名函數
readStream.on("data", function(data) {
console.log("got data from file read stream: %j", data);
});同一事件可以綁定多個監聽器,發射器會按注冊順序依次調用。要注意:如果某個監聽器拋出異常,可能導致後續監聽器永遠不被調用。
readStream.on("data", function(data) {
throw new Error("Something wrong has happened");
});
readStream.on("data", function(data) {
console.log('I have some data here too.'); // 不會被執行
});用 .removeListener() 移除某個監聽器(需要給回調命名):
readStream.on("data", receiveData);
// …
readStream.removeListener("data", receiveData);用 .once() 讓回調最多執行一次:
readStream.once("data", receiveData);它其實只是個便捷方法,本質是收到事件後先移除自己再調用原回調:
EventEmitter.prototype.once = function(type, callback) {
var that = this;
this.on(type, function listener() {
that.removeListener(type, listener);
callback.apply(that, arguments);
});
};用 .removeAllListeners() 移除某事件類型上的所有監聽器:
emitter.removeAllListeners(type);
process.removeAllListeners("SIGTERM");使用它時要謹慎,最好只在確切知道移除了什麼時才用,比如有序關閉發射器或整個進程。
通過繼承 EventEmitter 就能創建偽類:
util = require('util');
var EventEmitter = require('events').EventEmitter;
var MyClass = function() {
}
util.inherits(MyClass, EventEmitter);util.inherits 建立了原型鏈,讓 MyClass 的實例可以使用 EventEmitter 的原型方法。之後就能發射事件:
MyClass.prototype.someMethod = function() {
this.emit("custom event", "argument 1", "argument 2");
};
var myInstance = new MyClass();
myInstance.on('custom event', function(str1, str2) {
console.log('got a custom event with the str1 %s and str2 %s!', str1, str2);
});再比如創建一個每秒發射一次 tick 事件的 Ticker 類:
var util = require('util'),
EventEmitter = require('events').EventEmitter;
var Ticker = function() {
var self = this;
setInterval(function() {
self.emit('tick');
}, 1000);
};
util.inherits(Ticker, EventEmitter);
var ticker = new Ticker();
ticker.on("tick", function() {
console.log("tick");
});事件發射器模式是一種可重入模式,能把事件發射器對象從一組特定事件的代碼中解耦。用 event_emitter.on() 注冊監聽器,用 event_emitter.removeListener() 取消注冊;通過繼承 EventEmitter 並使用 .emit(),就能創建自己的事件發射器。