1. 이전 내용 정리
이전까지
(1) 모듈 안의 것들을 '하나씩' 밖으로 공개할 때는, exports를 사용하고,
(2) 모듈 안에서 공개할 것들을 하나의 객체로 만들어서 공개할 때는 module.exports를 쓰면 된다
고 배웠습니다.
그런데 사실 그 이유를 완벽하게 이해하려면 Node.js에서 모듈이 로드되는 과정에 대해 상세하게 알아야 합니다. 아래 내용을 이해하면, exports와 module.exports에 대해 확실히 이해할 수 있으니까 집중해서 읽어보세요!
2. Module wrapper function
이때까지 자바스크립트 파일 하나가, 하나의 모듈이라고 했죠?
그런데 Node.js가 모듈을 로드할 때는, 한 가지 해주는 작업이 있습니다. 바로 'Module wrapper function'이라는 것으로 모듈 내의 전체 코드를 감싸주는 작업입니다. 'Module wrapper function'이란, 말 그대로 '모듈을 감싸주는 코드'를 의미하는데, 아래처럼 생겼습니다.
(function (exports, require, module, __filename, __dirname) {
// 모듈 코드
});인자가 5개나 있는 함수가 보이죠? 그러니까 Node.js가 모듈을 로드할 때 이런 함수로 모듈 전체 코드를 감싸준다는 건데요. 예를 들면, 아래와 같은 math-tools.js 모듈을 로드할 때
function add(a, b) {
return a + b;
}
exports.add = add;이렇게 감싸준다는 뜻입니다.
(function (exports, require, module, __filename, __dirname) {
function add(a, b) {
return a + b;
}
exports.add = add;
});그리고 Module wrapper function의 다섯 가지 인자
(1) exports
(2) require
(3) module
(4) _ _filename
(5) _ _dirname
에는 Node.js가 각각 알맞은 것들을 전달하는데요. 이 때문에 이 다섯 가지 인자는, 우리가 직접 정의해준 적이 없더라도, 모듈 안에서 항상 자유롭게 접근할 수 있습니다. math-tools.js 모듈의 코드를 좀 바꿔서 예를 들자면,
function add(a, b) {
return a + b;
}
exports.add = add;
console.dir(exports);
console.dir(require);
console.dir(module);
console.dir(__filename);
console.dir(__dirname);이렇게 5가지 인자에 자유롭게 접근할 수 있는 겁니다. 참고로, console.dir는 특정 객체의 내부 속성들을 모두 출력해주는 함수입니다. 좀더 읽기 쉬운 결과를 볼 수 있도록 코드를 아래처럼 살짝 바꾸고,
function add(a, b) {
return a + b;
}
console.log('exports ------------------------->');
console.dir(exports);
console.log('require ------------------------->');
console.dir(require);
console.log('module ------------------------->');
console.dir(module);
console.log('__filename ------------------------->');
console.dir(__filename);
console.log('__dirname ------------------------->');
console.dir(__dirname);실행해볼게요.
뭔가 복잡한 결과가 출력되는데요. 이 중에서 exports 객체와 module 객체 이 2가지의 출력 결과만 가져와서 볼게요.
(1) exports 객체
(2) module 객체
exports 객체는 안에 아무 프로퍼티(속성)도 없는 텅 비어있는 객체이고, module 객체는 다양한 프로퍼티를 갖고 있는 객체입니다.
module 객체 안을 자세히 보면, exports라는 프로퍼티가 있고, 그 프로퍼티가 빈 객체 하나를 가리키고 있는데요.
자, 여기서 바로 핵심을 말씀드리겠습니다.
exports 객체와 module 객체의 exports 프로퍼티가 가리키는 객체는 '동일한' 객체입니다. 그리고 우리가 모듈 내부의 것들을 외부로 공개하기 위해 exports나 module.exports를 썼던 것은 바로 이 객체에 접근하기 위해서였습니다.정말 그런지 한번 실험해볼까요?
math-tools.js 모듈에서 add 함수를 plus라는 이름으로 공개해볼게요.
function add(a, b) {
return a + b;
}
exports.plus = add; // add 함수를 plus라는 이름으로 공개
console.log('exports ------------------------->');
console.dir(exports);
console.log('require ------------------------->');
console.dir(require);
console.log('module ------------------------->');
console.dir(module);
console.log('__filename ------------------------->');
console.dir(__filename);
console.log('__dirname ------------------------->');
console.dir(__dirname);
math-tools.js 모듈을 다시 실행해보면,
(1) exports 객체
(2) module 객체
exports 객체에 plus라는 프로퍼티가 추가되었고, 프로퍼티의 값이 add 함수인 것을 확인할 수 있습니다. 그리고 module 객체의 exports 프로퍼티가 가리키는 객체도 동일한 객체라고 했으니까 당연히 똑같이 변했습니다.
자, 이번엔 또 새로운 핵심 내용입니다.
바로 이 객체가 다른 모듈에서 require 함수로 이 모듈을 로드할 때 리턴되는 객체입니다.그러니까 다른 모듈에서 이 math-tools.js 모듈을
const m = require('./math-tools');이런 식으로 로드하면, require 함수는 'exports 객체(=module 객체의 exports 프로퍼티가 가리키는 객체)'를 리턴합니다.
3. 정리 및 주의할 점
자, 이제 정리해보겠습니다. 우리가 모듈 내부에서 require 함수로 다른 모듈을 로드했을 때 리턴되는 것은 하나의 객체입니다. 그리고 그 객체는 로드되는 모듈의 코드에서 exports 또는 module.exports라고 써서 접근할 수 있죠.
그래서 이전 영상에서 제가
exports.속성 = 값
또는
module.exports = 객체이런 식으로 공개하고 싶은 것들을 공개하라고 했던 겁니다. 그런데 여기서 "그럼 그냥 exports로도 exports = 객체, 이런 식으로 객체 하나를 통째로 공개하면 되지 않나요?"라는 질문을 할 수도 있습니다.
아주 좋은 질문입니다. 하지만 아쉽게도 Node.js는 내부적으로 require 함수가 실행될 때 위에서 본 module 객체의 exports 프로퍼티가 가리키는 객체를 리턴하도록 되어 있습니다.
그러니까 모듈을 로드할 때, Node.js가 Module wrapper function의 'exports이라는 인자로 넣어주는 객체'와 'module이라는 인자로 넣어주는 객체의 exports 프로퍼티가 가리키는 객체'는 아래 이미지처럼 분명 동일한 객체이지만,
require 함수는 'module 객체의 exports 프로퍼티가 가리키는 객체'를 리턴하기 때문에, exports 객체를 아예 새로 설정해버리면 안 되는 겁니다. 새로 설정해버리면 아래 이미지처럼 더이상 exports 키워드로는 원래의 객체에 접근할 수 없게 되는 거죠.
그래서 어쩔 수 없이 exports 키워드로는 'exports.속성 = ~' 이런 식으로 해당 객체에 프로퍼티를 추가하는 식으로만 사용할 수 있는 겁니다. 그 대신, module.exports를 사용하면 'module.exports = 객체' 형식 뿐만 아니라 'module.exports.속성 = ~' 이런 식으로도 사용할 수 있는 거구요.
자, 이때까지의 내용, 잘 이해하셨나요? 간단하게 정리해보면 다음과 같습니다.
(1) Node.js는 모듈을 로드하기 전에 그 전체 코드를 Module wrapper function이라는 것으로 감싸줍니다.
(2) Module wrapper function은 그 5개의 인자에 각각 적절한 값이나 객체를 설정해주는데
(3) 우리가 모듈 내의 코드에서 exports 인자로 넘어와서 그 프로퍼티를 하나씩 채워나가는 객체(또는 module 인자의 exports 프로퍼티로 설정되는 객체)가
(4) 다른 모듈에서 이 모듈을 require 함수로 로드했을 때 리턴되는 객체입니다.
방금 설명한 내용들은 Node.js가 내부적으로 처리하는 작업이라서 당장 개발할 때는 몰라도 되는 내용일 수도 있습니다. 하지만 이 내용을 알게되면 exports 또는 module.exports라는 키워드로 모듈 내부의 것들을, 외부에 공개할 수 있는 원리를 확실하게 이해할 수 있게 됩니다. 잘 기억해두세요!
