Node.js EventEmitter: on, emit, once와 커스텀 이벤트

EventEmitter는 Node.js events 모듈에 있는 클래스로, 객체가 이름 붙은 이벤트를 알릴 수 있게 해 줍니다. emitter.on('name', fn)으로 리스너를 등록하고 emitter.emit('name', ...args)로 발생시킵니다. 그 이름의 리스너가 모두, 추가된 순서대로, 넘긴 인자와 함께 실행됩니다. HTTP 서버, 스트림, process가 모두 EventEmitter라서 같은 몇 가지 메서드가 Node.js 어디서나 통합니다.

const EventEmitter = require('events');

const shop = new EventEmitter();

shop.on('order', (item, qty) => {
    console.log('order received:', qty, 'x', item);
});
shop.on('order', (item) => {
    console.log('update stock for', item);
});

console.log('before emit');
shop.emit('order', 'coffee', 2);
console.log('after emit');

두 리스너 모두 before emit과 after emit 사이에서 실행됩니다. emit은 리스너를 동기적으로 호출하고, 그것이 끝나야 반환합니다. 두 shop.on 호출을 바꾸면 가운데 두 줄도 바뀝니다.

on, once, off

on은 제거할 때까지 리스너를 유지하고, once는 첫 호출 뒤에 제거하며, off(removeListener와 같음)는 하나를 제거합니다. 리스너를 제거하려면 추가했던 바로 그 함수가 필요하므로, 화살표 함수를 즉석에서 넘기지 말고 이름을 붙이세요.

const EventEmitter = require('events');
const door = new EventEmitter();

function logOpen(who) {
    console.log('opened by', who);
}

door.on('open', logOpen);
door.once('open', () => console.log('first open ever'));

door.emit('open', 'Ada');
door.emit('open', 'Linus');

door.off('open', logOpen);
console.log('listeners left:', door.listenerCount('open'));
console.log('emit returned', door.emit('open', 'Grace'));

first open ever는 Ada 다음에 한 번만 출력됩니다. logOpen을 제거하자 아무도 듣지 않으므로 마지막 emit은 false를 반환합니다. door.removeAllListeners('open')을 썼다면 두 리스너를 한 번에 지웠을 것입니다.

error 이벤트

'error'는 특별합니다. 아무도 듣지 않는데 내보내면 emit이 그 에러를 던지고, 실제 프로그램에서 잡히지 않은 에러는 프로세스를 죽입니다. 스트림이나 서버처럼 실패할 수 있는 emitter에는 항상 'error' 리스너를 추가하세요.

const EventEmitter = require('events');
const job = new EventEmitter();

try {
    job.emit('error', new Error('disk full'));
} catch (err) {
    console.log('emit threw:', err.message);
}

job.on('error', (err) => {
    console.log('handled:', err.message);
});
job.emit('error', new Error('disk full'));
console.log('still running');

리스너가 없으면 emit이 에러를 던지고 catch가 받습니다. 리스너를 추가하면 같은 emit이 그 리스너를 호출할 뿐이고 프로그램은 계속됩니다. 다른 이벤트 이름은 리스너가 없으면 조용히 무시됩니다.

내 클래스에서 EventEmitter 상속하기

가장 흔한 사용법은 내 클래스가 EventEmitter를 상속하고, 생성자에서 super()를 호출한 뒤, 무슨 일이 생기면 this.emit을 호출하는 것입니다. 그러면 호출하는 쪽은 다른 Node.js 객체처럼 내 객체를 구독할 수 있습니다.

const EventEmitter = require('events');

class Upload extends EventEmitter {
    constructor(name, chunks) {
        super();
        this.name = name;
        this.chunks = chunks;
    }

    start() {
        for (let i = 1; i <= this.chunks; i++) {
            this.emit('progress', Math.round((i / this.chunks) * 100));
        }
        this.emit('done', this.name);
    }
}

const up = new Upload('photo.png', 4);
up.on('progress', (pct) => console.log(pct + '%'));
up.once('done', (name) => console.log(name, 'uploaded'));
up.start();

25%, 50%, 75%, 100%, 그리고 photo.png uploaded가 출력됩니다. up.start()를 두 up.on 줄 위로 옮기면 아무것도 출력되지 않습니다. 누가 듣기 전에 이벤트가 발생하기 때문입니다.

생성자 안에서 이벤트를 내보낼 때도 같은 함정이 있습니다. 즉시 내보내야 하는 라이브러리는 그 호출을 process.nextTick으로 감싸는데, 이것은 호출하는 쪽의 on 줄보다 뒤에 실행됩니다(이벤트 루프 페이지 참고).

events.once로 이벤트 기다리기

events.once(emitter, name)은 다음에 이벤트가 발생하면 그 인자를 배열로 담아 resolve되는 Promise를 반환합니다. 한 번뿐인 이벤트를 await할 수 있는 것으로 바꿔 주고, emitter가 먼저 'error'를 내보내면 reject됩니다.

import { EventEmitter, once } from 'events';

const db = new EventEmitter();

setTimeout(() => db.emit('ready', 'v1.4', 3), 100);

console.log('waiting for ready');
const [version, tables] = await once(db, 'ready');
console.log('ready:', version, 'with', tables, 'tables');

await는 타이머가 ready를 내보낼 때까지 멈췄다가, 배열을 두 인자로 구조 분해합니다. 여러 번 발생하는 이벤트라면 events.on(emitter, name)이 for await로 돌 수 있는 비동기 이터레이터를 줍니다.

흔한 실수

자주 실행되는 함수 안에서 리스너를 추가하는 것. 요청 핸들러마다 on을 호출하면 리스너와 메모리가 쌓입니다. 한 번만 추가하거나 once를 쓰세요.

즉석 함수를 제거하려는 것. off('data', () => ...)는 아무것도 제거하지 않습니다. 그 화살표 함수는 새로 만든 함수이기 때문입니다. 추가한 함수의 참조를 보관하세요.

리스너가 나중에 실행될 거라고 기대하는 것. emit은 동기적이라서 느린 리스너는 이벤트를 내보낸 코드를 붙잡습니다. 리스너를 async로 표시해도 소용없습니다. 첫 await까지는 그 코드가 여전히 같은 스레드에서 실행되기 때문입니다. 무거운 작업은 사이사이에 setImmediate를 넣어 여러 조각으로 나누거나 워커 스레드로 옮기세요.