對象EventEmitter

EventEmitter 是事件觸發對象，它可以用來建立觀察者模式，而支援事件觸發的物件皆繼承於此

當一個事件被觸發時，所有與該事件相關聯的監聽器都會以非同步方式被呼叫。它還允許我們創建具有高度可自訂性和靈活性的程式碼。

常用函數包括：addListener/on、once、removeListener/off、removeAllListeners 和emit。

下面是一個範例程式碼：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
var fs = require('fs');
var EventEmitter = require('events');
var event = new EventEmitter();

event.on('read_file', function(filename) {
    fs.readFile(filename, 'utf8', function(err, data) {
        if (err) {
            event.emit('error', err);
            return;
        }
        event.emit('show_content', data);
    });
});

event.on('error', function(err) {
    console.log(`Error ${err}`);
});

event.on('show_content', function(content) {
    console.log(content);
});

event.emit('read_file', 'test.txt');

上述範例程式碼，當執行時，事件emitter實例event首先監聽'read_file'事件，然後在事件觸發時( event.emit('read_file', 'test.txt'))觸發讀取檔案的操作。當讀取成功後，會觸發'show_content'事件，此時監聽了'show_content'事件的函數就會被執行並顯示檔案內容。如果在讀取檔案過程中發生錯誤，則會觸發'error'事件，此時操作失敗的情況就得到了應對。

這種模式在應對非同步操作的業務場景中具有很好的優越性。

繼承關係

建構函數

EventEmitter

建構函數

1
new EventEmitter();

物件

事件觸發對象

1
EventEmitter new EventEmitter;

靜態屬性

defaultMaxListeners

Integer, 預設全域最大監聽器數

1
static Integer EventEmitter.defaultMaxListeners;

成員函數

on

綁定一個事件處理函數到對象

1
2
Object EventEmitter.on(String ev,
    Function func);

呼叫參數:

ev: String, 指定事件的名稱
func: Function, 指定事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

綁定一個事件處理函數到對象

1
Object EventEmitter.on(Object map);

呼叫參數:

map: Object, 指定事件映射關係，物件屬性名稱將作為事件名稱，屬性的值將作為事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

addListener

綁定一個事件處理函數到對象

1
2
Object EventEmitter.addListener(String ev,
    Function func);

呼叫參數:

ev: String, 指定事件的名稱
func: Function, 指定事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

綁定一個事件處理函數到對象

1
Object EventEmitter.addListener(Object map);

呼叫參數:

map: Object, 指定事件映射關係，物件屬性名稱將作為事件名稱，屬性的值將作為事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

prependListener

綁定一個事件處理函數到物件起始

1
2
Object EventEmitter.prependListener(String ev,
    Function func);

呼叫參數:

ev: String, 指定事件的名稱
func: Function, 指定事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

綁定一個事件處理函數到物件起始

1
Object EventEmitter.prependListener(Object map);

呼叫參數:

map: Object, 指定事件映射關係，物件屬性名稱將作為事件名稱，屬性的值將作為事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

once

綁定一個一次性事件處理函數到對象，一次性處理函數只會觸發一次

1
2
Object EventEmitter.once(String ev,
    Function func);

呼叫參數:

ev: String, 指定事件的名稱
func: Function, 指定事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

綁定一個一次性事件處理函數到對象，一次性處理函數只會觸發一次

1
Object EventEmitter.once(Object map);

呼叫參數:

map: Object, 指定事件映射關係，物件屬性名稱將作為事件名稱，屬性的值將作為事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

prependOnceListener

綁定一個事件處理函數到物件起始

1
2
Object EventEmitter.prependOnceListener(String ev,
    Function func);

呼叫參數:

ev: String, 指定事件的名稱
func: Function, 指定事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

綁定一個事件處理函數到物件起始

1
Object EventEmitter.prependOnceListener(Object map);

呼叫參數:

map: Object, 指定事件映射關係，物件屬性名稱將作為事件名稱，屬性的值將作為事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

off

從物件處理佇列中取消指定函數

1
2
Object EventEmitter.off(String ev,
    Function func);

呼叫參數:

ev: String, 指定事件的名稱
func: Function, 指定事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

取消物件處理佇列中的全部函數

1
Object EventEmitter.off(String ev);

呼叫參數:

ev: String, 指定事件的名稱

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

從物件處理佇列中取消指定函數

1
Object EventEmitter.off(Object map);

呼叫參數:

map: Object, 指定事件映射關係，物件屬性名稱作為事件名稱，屬性的值作為事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

removeListener

從物件處理佇列中取消指定函數

1
2
Object EventEmitter.removeListener(String ev,
    Function func);

呼叫參數:

ev: String, 指定事件的名稱
func: Function, 指定事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

取消物件處理佇列中的全部函數

1
Object EventEmitter.removeListener(String ev);

呼叫參數:

ev: String, 指定事件的名稱

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

從物件處理佇列中取消指定函數

1
Object EventEmitter.removeListener(Object map);

呼叫參數:

map: Object, 指定事件映射關係，物件屬性名稱作為事件名稱，屬性的值作為事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

removeAllListeners

從物件處理佇列中取消所有事件的所有監聽器，如果指定事件，則移除指定事件的所有監聽器。

1
Object EventEmitter.removeAllListeners(String ev);

呼叫參數:

ev: String, 指定事件的名稱

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

從物件處理佇列中取消所有事件的所有監聽器，如果指定事件，則移除指定事件的所有監聽器。

1
Object EventEmitter.removeAllListeners(Array evs = []);

呼叫參數:

evs: Array, 指定事件的名稱

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

setMaxListeners

監聽器的預設限制的數量，僅用於相容

1EventEmitter.setMaxListeners(Integer n);

呼叫參數:

n: Integer, 指定事件的數量

getMaxListeners

取得監聽器的預設限制的數量，僅用於相容

1Integer EventEmitter.getMaxListeners();

回傳結果:

Integer, 回傳預設限制數量

listeners

查詢物件指定事件的監聽器陣列

1
Array EventEmitter.listeners(String ev);

呼叫參數:

ev: String, 指定事件的名稱

回傳結果:

Array, 傳回指定事件的監聽器數組

listenerCount

查詢物件指定事件的監聽器數量

1
Integer EventEmitter.listenerCount(String ev);

呼叫參數:

ev: String, 指定事件的名稱

回傳結果:

Integer, 傳回指定事件的監聽器數量

查詢物件指定事件的監聽器數量

1
2Integer EventEmitter.listenerCount(Value o,
    String ev);

呼叫參數:

o: Value, 指定查詢的對象
ev: String, 指定事件的名稱

回傳結果:

Integer, 傳回指定事件的監聽器數量

eventNames

查詢監聽器事件名稱

1
Array EventEmitter.eventNames();

回傳結果:

Array, 傳回事件名稱數組

emit

主動觸發一個事件

1
2
Boolean EventEmitter.emit(String ev,
    ...args);

呼叫參數:

ev: String, 事件名稱
args: ..., 事件參數，將會傳遞給事件處理函數

回傳結果:

Boolean, 回傳事件觸發狀態，有回應事件回傳true，否則回傳false

toString

傳回物件的字串表示，一般回傳"[Native Object]"，物件可以根據自己的特性重新實現

1
String EventEmitter.toString();

回傳結果:

String, 傳回物件的字串表示

toJSON

傳回物件的JSON 格式表示，一般傳回物件定義的可讀屬性集合

1
Value EventEmitter.toJSON(String key = "");

呼叫參數:

key: String, 未使用

回傳結果:

Value, 傳回包含可JSON 序列化的值

開發指南

基礎模組

內建對象

社群模組

對象EventEmitter

繼承關係

建構函數

EventEmitter

物件

靜態屬性

defaultMaxListeners

成員函數

on

addListener

prependListener

once

prependOnceListener

off

removeListener

removeAllListeners

setMaxListeners

getMaxListeners

listeners

listenerCount

eventNames

emit

toString

toJSON