Nodejs EventEmitter 뜯어보기

Node.js 소스 코드를 살펴보면서 EventEmitter가 어떻게 돌아가는지 확인합니다

by Husky

Feb 5, 2020 | 7 min read

javascript

들어가며

Udemy의 Learn and Understand NodeJS 강의를 정리하는 포스팅이다.

동기와 비동기

순수 자바스크립트는 동기적으로 작동한다. 한 번에 하나의 프로세스만 실행시킬 수 있다. 자바스크립트를 비동기적으로 작동시키는 것은 자바스크립트 엔진 바깥을 감싸고 있는 호스팅 환경이다. 전통적으로는 브라우저가 유일한 호스팅 환경이었지만 자바스크립트 세계관이 확장되면서 이제는 Node.js 또한 호스팅 환경 중의 하나가 되었다.

Node.js가 비동기적으로 작동하는 것은 그 내부에 비동기 이벤트를 소화하기 위한 라이브러리(libuv)를 지니고 있기 때문이다. Node.js의 이벤트 루프는 libuv를 이용해 구현되었으며, 크게 여섯 단계의 페이즈를 순환하고 있다. 각 페이즈는 libuv를 통해 커널 혹은 쓰레드 풀에 인계했던 콜백 작업을 실행한다.

setTimeout, setInterval 등 타이머 작업 혹은 DB 연결, 파일 읽기/쓰기, HTTP 요청 등 모든 비동기 작업들은 libuv를 통해 스케줄링 되었다가 이벤트 루프의 순환 주기에 따라 호출된다.

이벤트 컨셉

이벤트란 ‘어플리케이션 내에서 발생한 응답 가능한 사건’ 이라고 표현할 수 있다. 이벤트는 Node.js에서만 사용되는 개념은 아니지만 Node에서는 특히 아키텍쳐의 근간을 이루는 개념이기에 중요하게 다뤄야 한다.

Node.js에서 발생하는 이벤트는 두 종류로 나눌 수 있다. 먼저 시스템 이벤트가 있는데, 이것은 libuv 라이브러리가 적용된 C++ 코어에서 처리하게 된다. 파일을 열고 닫거나 인터넷이 연결되거나 하는 영역이다. 자바스크립트 코어에서 처리되는 보다 상위 단계의 이벤트는 Node.js의 Event Emitter에서 관리된다.

자바스크립트 자체는 이벤트와 관련된 객체가 없다. Node.js가 그와 관련된 컨셉을 구현한 것이다.

간단 구현

EventEmitter가 실제로 어떻게 작동하는지 간단한 형태로 구현해보자.

1function Emitter() {
2  this.events = {};
3}
4
5Emitter.prototype.on = function(type, listener) {
6  this.events[type] = this.events[type] || [];
7  this.events[type].push(listener);
8}

Emitter 함수 생성자는 this.events라는 객체를 초기화한다. 그리고 프로토타입에 on이라는 함수를 추가하는데 이 함수는 이벤트의 타입과 리스너를 인자로 받아 Emitter 객체에 추가하는 역할을 한다. 함수가 실행되면 객체 안에는 타입을 키로 받고 리스너의 배열을 값으로 받는 페어가 저장될 것이다.

 1const emitter = new Emitter();
 2
 3emitter.on('greeting', function() {
 4  console.log('Hello, Node!');
 5});
 6
 7/*
 8* this.events = {
 9*   greeting: [
10      function() { console.log('Hello, Node!') }
11    ];
12* }
13*/

이렇듯 on 함수는 특정 상황에 실행시킬 리스너 함수를 Emitter 안에 등록한다는 의미를 갖고 있다. 그러면 이제 등록한 리스너를 호출할 emit 함수를 작성해보자.

1Emitter.prototype.emit = function(type) {
2  if (this.events[type]) {
3    this.events[type],forEach(function(listener) {
4      listener();
5    })
6  }
7}

Emitter 객체 안에 담겨 있는 타입-리스너 배열을 순회하며 리스너를 실행힌다. 위에서 작성한 실행 예제를 다시 가져오자.

1const emitter = new Emitter();
2
3emitter.on('greeting', function() {
4  console.log('Hello, Node!');
5}); // 이벤트 등록
6
7emitter.emit('greeting'); // 이벤트 실행: 'Hello, Node!'

실제 코드

최신 LTS 버전 기준 (v12.14.1) 저장소 주소를 링크해두겠다.

node/events.js at v12.14.1

핵심 원리는 거의 같지만 에러 핸들링, 메모리 릭 방지를 위한 장치들이 좀더 담겨있는 것을 볼 수 있다. 기본적인 최대 리스너 갯수를 10개로 제한하고 있으며, 리스너 갯수가 이를 초과하면 경고를 출력하는 것을 볼 수 있다.

on 함수는 _addListener 함수를 둘러싸고 있다.

 1EventEmitter.prototype.addListener = function addListener(type, listener) {
 2  return _addListener(this, type, listener, false);
 3};
 4
 5EventEmitter.prototype.on = EventEmitter.prototype.addListener;
 6
 7...
 8
 9function _addListener(target, type, listener, prepend) {
10  let m;
11  let events;
12  let existing;
13
14  checkListener(listener);
15
16  // 리스너를 등록하는 코드
17  events = target._events;
18  // 첫 번째 등록이라 events 변수가 undefined라면
19  // 빈 객체를 생성해 할당한다
20  if (events === undefined) {
21    events = target._events = ObjectCreate(null);
22    target._eventsCount = 0;
23  } else {
24    // To avoid recursion in the case that type === "newListener"! Before
25    // adding it to the listeners, first emit "newListener".
26    if (events.newListener !== undefined) {
27      target.emit('newListener', type,
28                  listener.listener ? listener.listener : listener);
29
30      // Re-assign `events` because a newListener handler could have caused the
31      // this._events to be assigned to a new object
32      events = target._events;
33    }
34    existing = events[type];
35  }
36
37  // 최적화를 위해 리스너가 단 한 개일 때는 배열 구조를 사용하지 않고, 리스너가 한 개 이상이 되어야 배열 구조를 사용한다
38  if (existing === undefined) {
39    // Optimize the case of one listener. Don't need the extra array object.
40    events[type] = listener;
41    ++target._eventsCount;
42  } else {
43    if (typeof existing === 'function') {
44      // Adding the second element, need to change to array.
45      existing = events[type] =
46        prepend ? [listener, existing] : [existing, listener];
47      // If we've already got an array, just append.
48    } else if (prepend) {
49      existing.unshift(listener);
50    } else {
51      existing.push(listener);
52    }
53    
54    // 메모리 릭 방지를 위해 기본 설정된 최대 리스너 갯수를 초과하게 되면 경고를 출력한다
55    // Check for listener leak
56    m = _getMaxListeners(target);
57    if (m > 0 && existing.length > m && !existing.warned) {
58      existing.warned = true;
59      // No error code for this since it is a Warning
60      // eslint-disable-next-line no-restricted-syntax
61      const w = new Error('Possible EventEmitter memory leak detected. ' +
62                          `${existing.length} ${String(type)} listeners ` +
63                          `added to ${inspect(target, { depth: -1 })}. Use ` +
64                          'emitter.setMaxListeners() to increase limit');
65      w.name = 'MaxListenersExceededWarning';
66      w.emitter = target;
67      w.type = type;
68      w.count = existing.length;
69      process.emitWarning(w);
70    }
71  }
72
73  return target;
74}

emit 함수도 살펴보자.

 1EventEmitter.prototype.emit = function emit(type, ...args) {
 2 const handler = events[type];
 3
 4 // 상단에는 'error' 이벤트가 실행되었을 경우 stackTrace를 출력하는 코드 등이 담겨 있다
 5 ...
 6
 7  // handler가 전혀 없는 경우 false 리턴
 8  if (handler === undefined)
 9    return false;
10
11  // handler가 단 한 개인 경우, 배열 형태가 아니므로 즉시 출력
12  if (typeof handler === 'function') {
13    ReflectApply(handler, this, args);
14  } else {
15    // handler가 배열 형태인 경우, 전체를 순회하며 리스너들을 출력
16    const len = handler.length;
17    const listeners = arrayClone(handler, len);
18    for (let i = 0; i < len; ++i)
19      ReflectApply(listeners[i], this, args);
20  }
21
22  return true; // 정상 출력 후 true 리턴
23}

실행해보기

코드를 실행해보고 어떤 결과를 보여주는지 확인해보자.

 1const EventEmitter = require('events');
 2
 3const emitter = new EventEmitter();
 4
 5emitter.on('greet', function() {
 6  console.log('Node와의 첫 만남, 반갑습니다!')
 7})
 8
 9console.log(emitter);
10console.log(emitter.emit('greet'));
11
12/*
13* EventEmitter {
14*  _events: [Object: null prototype] { greet: [Function] },
15*  _eventsCount: 1,
16*  _maxListeners: undefined
17* }
18* Node와의 첫 만남, 반갑습니다!
19* true
20*/

단 하나의 리스너가 등록된 경우, _events 객체는 하나의 greet 함수를 담고 있는 객체의 형태로 저장된다. 정상적으로 emit 함수가 실행되자 리스너 함수가 작동하고, true를 리턴한다.

 1const EventEmitter = require('events');
 2
 3const emitter = new EventEmitter();
 4
 5// 동일한 리스너 함수를 12개 등록한다
 6emitter.on('greet', function() {
 7  console.log('Node와의 첫 만남, 반갑습니다!')
 8})
 9
10emitter.on('greet', function() {
11  console.log('Node와의 첫 만남, 반갑습니다!')
12})
13
14...
15
16console.log(emitter);
17console.log(emitter.emit('greet'));
18
19/*
20* EventEmitter {
21*   _events: [Object: null prototype] {
22*     greet: [
23*       [Function],   [Function],
24*       [Function],   [Function],
25*       [Function],   [Function],
26*       [Function],   [Function],
27*       [Function],   [Function],
28*       [Function],   [Function],
29*       warned: true
30*     ]
31*   },
32*   _eventsCount: 1,
33*   _maxListeners: undefined
34* }
35* Node와의 첫 만남, 반갑습니다!
36* Node와의 첫 만남, 반갑습니다!
37* Node와의 첫 만남, 반갑습니다!
38* Node와의 첫 만남, 반갑습니다!
39* Node와의 첫 만남, 반갑습니다!
40* Node와의 첫 만남, 반갑습니다!
41* Node와의 첫 만남, 반갑습니다!
42* Node와의 첫 만남, 반갑습니다!
43* Node와의 첫 만남, 반갑습니다!
44* Node와의 첫 만남, 반갑습니다!
45* Node와의 첫 만남, 반갑습니다!
46* Node와의 첫 만남, 반갑습니다!
47* true
48* (node:43779) MaxListenersExceededWarning: Possible EventEmitter memory leak detected. 11 greet listeners added to [EventEmitter]. Use emitter.setMaxListeners() to increase limit
49*/

너무 많은 리스너를 등록하면 경고 메시지를 출력하고, _events 객체에도 warned라는 플래그가 등록된 걸 볼 수 있다. greet 항목은 배열로 형태가 변경된 걸 볼 수 있다. 두 개 이상의 리스너가 등록되었기 때문이다.

이벤트 상속

과거에는 util.inherits 함수로 상속을 수행했다. 자바스크립트에는 클래스 개념이 없으므로 부모 함수의 prototype 속성을 자식 함수의 prototype에 복사하는 식으로 상속을 구현했다.

 1const EventEmitter = require('events');
 2const util = require('util');
 3
 4// 인사를 출력하는 함수 선언
 5function Greetr() {
 6  this.greeting = 'Hello World';
 7}
 8
 9// Greetr 함수는 EventEmitter를 상속받는다
10// 곧 EventEmitter의 prototype 속성을 Greetr의 prototype에 복사한다
11util.inherits(Greetr, EventEmitter);
12
13// Greetr 함수의 prototype에 event emit 일으키는 함수 할당
14Greetr.prototype.greet = function() {
15  console.log(this.greeting);
16  this.emit('greet');
17}
18
19// 함수 객체 선언
20const greeter1 = new Greetr();
21
22// greet 이벤트 등록
23greeter1.on('greet', function() {
24  console.log('Someone greeted!');
25})
26
27// greet 함수 호출
28greeter1.greet();
29
30// Hello World
31// Someone greeted!

이렇게 하면 Greetr 함수 객체의 prototype이 EventEmitter가 되어 이벤트 메서드 호출이 가능해진다.

Greetr 함수 객체를 완전히 eventEmitter 객체와 동일하게 만들려면 this까지 복사하면 된다.

1function Greetr() {
2  EventEmitter.call(this);
3  this.greeting = 'Hello World';
4}

저 코드를 삽입하면 EventEmitter 함수를 Greetr의 this 환경에서 실행하는 셈이 되어 prototype뿐만 아니라 객체 상태 복사까지 이루어진다.

ES6 클래스

ES6 문법이 발표되면서 자바스크립트에서도 클래스 문법을 사용할 수 있게 되었다. 그래서 위에서 함수 형태의 상속 패턴을 클래스형 패턴으로 구현할 수 있다.

1class Greetr extends EventEmitter {
2  constructor {
3    super();
4    this.greeting = 'Hello World';
5  }
6}

extends 키워드가 prototype 복사를 수행하고 constructor(생성자 함수)의 super 함수가 인스턴스 복사를 수행한다.

정리하며

Node.js가 어떻게 구성되어 있는지, 자바스크립트를 어떻게 실행시키고 있는 것인지 공부하고 있는 중이다. 더 나아가서는 비동기 프로그래밍, 에러를 올바로 처리하는 방법을 배우고 싶다. React, Vue 등 특정 라이브러리나 프레임워크가 지원해주는 방식만 사용해서는 비즈니스 로직이 UI와 단단히 커플링되는 결과만 낳게 되는 것 같다. 궁극적으로는 데이터 영역과 뷰 영역을 느슨하게만 결합시켜 하나의 웹 어플리케이션을 유지한 채로 다른 UI 라이브러리를 교체할 수 있는 수준에 이르고 싶다.