Node.js Design Pattern - 관찰자 패턴(The observer pattern)

관찰자 패턴은 상태 변화가 일어날 때 관찰자에게 알릴 수 있는 객체를 정의하는 것.

EventEmitter 클래스

관찰자 패턴은 이미 Node.js 코어에 내장되어 있으며 EventEmitter클래스를 통해 사용할 수 있다. EventEmitter클래스를 사용하여 특정 유형의 이벤트가 발생되면 호출될 하나 이상의 함수를 Listener로 등록할 수 있다.

const EventEmitter = require('events').EventEmitter;
const eeInstance = new EventEmitter();

EventEmitter의 필수 메소드

EventEmitter 생성 및 사용

새로운 인스턴스를 만들어 바로 사용하는 방법.

오류 전파

EventEmitter는 이벤트가 비동기적으로 발생할 경우, 이벤트 루프에서 손실될 수 있기 때문에 callback과 같이 예외가 발생해도 바로 throw할 수 없다. 대신 error라는 특수한 이벤트를 발생 시키고 Error 객체를 인자로 전달한다.

Node.js는 특별한 방식으로 에러 이벤트를 처리하고 예외를 자동으로 throw하며, 이에 연결된 리스너가 없는 경우 프로그램을 종료하므로 항상 에러 이벤트에 대한 리스너를 등록하는 것이 좋다.

관찰 가능한 객체 만들기

findPattern 객체가 EventEmitter의 기능을 상속받아 사용하는 방법. Node.js에서 일반적인 패턴이다. EventEmitter를 확장하는 객체는 stream등이 있다.

동기 및 비동기 이벤트

이벤트는 callback과 마찬가지로 동기식 또는 비동기식으로 생성될 수 있다. 그러나 동일한 EventEmitter에서 두 방식을 혼용해서는 안된다. 동기/비동기 이벤트의 차이점은 리스너를 등록하는 방법이다.

const EventEmitter = require('events').EventEmitter;
 
class SyncEmit extends EventEmitter {
  constructor() {
    super();
    this.emit('ready');
  }
}
 
const syncEmit = new SyncEmit();
syncEmit.on('ready', () => console.log('Object is ready to be used'));

위의 코드는 ready 이벤트가 비동기적을 발생했다면 동작하겠지만, 동기적으로 생성되면 이벤트가 이미 전송된 후 리스너가 등록되어 리스너가 호출되지 않는다.

EventEmitter vs callback

결과가 비동기 방식으로 반환되어야 하는 경우에는 callback 사용. 일어난 무엇인가를 전달 할 때 Event 사용.

// event
function helloEvents() {
  const eventEmitter = new EventEmitter();
  setTimeout(() => eventEmitter.emit('hello', 'hello world'), 100);
  return eventEmitter;
}
 
// callback
function helloCallback(callback) {
  setTimeout(() => callback('hello world'), 100);
}

EventEmitter는 동일한 이벤트가 여러 번 발생할 수도, 전혀 발생하지 않을 수도, 한번만 발생할 수도 있지만 callback은 작업의 성공 여부와 상관없이 정확히 한번 호출 되어야한다. event 발생에 초점을 맞춘다면 결과를 callback으로 전달 받기 보다 EventEmitter로 받는 편이 더 명확하다.

callback과 EventEmitter의 결합

패턴 예) glob 스타일 파일 검색 라이브러리

// main method
glob(pattern, [options], callback)
 
// 사용 에
const glob = require('glob');
glob('data/*.txt', (error, file) => console.log(`All files found: ${JSON.stringify(files)}`))
.on('match', match => console.log(`Match found: ${match}`));