웹 프로그래밍

exports 객체와 모듈의 기본

토픽 웹 프로그래밍 > node.js

exports : 사용자 모듈 만들기(여러 속성과 메소드), require()

http://www.nodejs.org/api/globals.html#globals_exports

http://www.nodejs.org/api/modules.html#modules_modules

만들고자 하는 모듈을 파일로 만들고 exports 객체의 속성이나 메소드를 정의해주면 모듈을 만들어 낼 수 있습니다. 그리고 만들어진 모듈을 전역 함수 require()를 이용하여 추출합니다. 

두 번째 링크에 나오는 예제를 그대로 따라해 보겠습니다. circle.js가 모듈이 되는 파일이고 foo.js가 실행될 파일입니다.

예제

// cicle.js
var PI = Math.PI;

exports.area = function (r) {
    return PI * r * r;
};

exports.circumference = function (r) {
    return 2 * PI * r;
};
// foo.js
var circle = require('./circle.js');
console.log( 'The area of a circle of radius 4 is '
    + circle.area(4));

실행 결과

$ node foo.js
The area of a circle of radius 4 is 50.26548245743669

어려운 코드가 아니므로 이해할 수 있을 것입니다. 다만 node의 문법적인 부분을 살펴봅시다.

circle.js에서 area와 circumference를 exports 객체의 메소드로 정의했습니다. 그리고 foo.js에서 require() 함수를 통해 circle.js 파일을 불러와 결과 값을 변수 circle에 대입했습니다. 그럼 이제 foo.js에서 변수 circle을 통해 circle.js의 exports 객체에 추가한 속성이나 메소드를 사용할 수 있게 됩니다.

 

module.exports : 사용자 모듈 만들기(하나의 속성이나 메소드)

http://www.nodejs.org/api/globals.html#globals_module

위 예제에서는 전역 객체 exports를 이용했지만 이번에는 module.exports를 사용해 보겠습니다.

결론부터 말하면 exports는 속성이나 메소드를 여러 개 정의할 수 있지만 module.exports는 하나만 정의할 수 있습니다. 파일 자체를 속성이나 메소드로 사용하는 방식입니다.

예제는 링크 http://www.nodejs.org/api/modules.html#modules_modules 의 두 번째 예제입니다. square.js가 모듈이 되는 파일, bar.js가 실행될 파일입니다.

예제

// square.js
module.exports = function(width) {
    return {
        area: function() {
            return width * width;
        }
    };
}
// bar.js
var square = require('./square.js');
var mySquare = square(2);
console.log('The area of my square is ' + mySquare.area());

실행 결과

$ node bar.js
The area of my square is 4

square.js에서 module.exports를 함수로 정의했습니다. 그러면 bar.js에서 square.js 파일을 require()를 통해 변수로 불러와 모듈로 사용할 수 있는데 그 변수가 바로 함수로 사용됩니다.

 

함수 뿐 아니라 마찬가지로 속성도 지정할 수 있습니다.

예제

// mymodule.js
module.exports = "사용자 모듈입니다.";
// mymain.js
var mymodule = require('./mymodule.js');
console.log(mymodule);

실행 결과

$ node mymain.js 
사용자 모듈입니다.

 

index.js 파일

var module = require('./mymodule');

만약 위처럼 확장자를 입력하지 않으면 어떻게 될까요?

  1. 먼저 mymodule.js 파일을 찾습니다. 있다면 그 파일을 추출합니다.
  2. mymodule.js 파일이 없다면 mymodule 이라는 폴더를 찾습니다. 그리고 그 폴더의 index.js 파일을 찾아 추출합니다.

댓글

댓글 본문
  1. KKambi
    지나가는이님의 댓글이 맞습니다.
    본문에는 오류가 있네요.
    module.exports는 모듈을 하나의 객체로 사용하여, 객체 안의 여러 개의 속성:메소드를 정의할 수 있죠.
    반면에 exports는 여러 개의 객체를 내보내는 것이구요.
    대화보기
    • JeBe
      감사합니다. 글 잘 읽고 갑니다.
    • 지나가는이
      module.exports 에서도 속성이나 메소드를 여러개 정의 할 수 있습니다.

      module.exports = {

      execute: function (query, parms, callback) {
      },
      select: function (query, parms, callback) {
      },
      };
    • 우와... 정말 감사합니다. 이렇게 깔끔하고 일목요연한 설명은 처음 본 것 같습니다.
    • 책필요한사람
      책..쓰십시요.
    • 나그네
      진짜 설명 잘하십니다.. 20년 경력자이지만. 이런글은 처음봅니다.
    • nasangw
      와 설명 정말 깔끔하네요
      이해하기 쉽고 머리속에 쏙쏙 들어옵니다.

      시중에 관련책보다 훨씬 좋았어요

      감사합니다~
    • 달려라추군
      구글링 중 최고로 쉽고 잘 설명된 글이었습니다. 돈주고 산 책들보다 더 도움이 되었어요 진심으로 감사드립니다.^^
    • 손님2
      설명이 간결하고, 깔끔합니다. 좋은 정보 감사합니다!!
    • 손님
      대화보기
      • 나무마루
        친절한 설명 감사드립니다. 정말 쉽게 이해가 되었습니다.
        대화보기
        • miki
          './mymodule' 이라는 부분에서 모호성이 생기는데요 mymodule에 확장자를 표시하지 않았기 때문에 mymodule.js를 가리킬 수도 있고 mymodule이라는 디렉토리를 가리킬 수도 있습니다. 여기서 mymodule.js 파일을 우선적으로 찾는다는 내용이 1번이구요. 이 파일이 없을 경우 mymodule 이라는 디렉토리를 찾는다는 내용이 2번입니다. 그런데 디렉토리 자체로 모듈을 가져올 수 없으므로 그 디렉토리에 index.js 라는 파일이 있어야 합니다. 그리고 그 파일을 모듈로 추출하는 것이죠..
          대화보기
          • 나무마루
            마지막에 왜 index를 찾죠? 찾는건 mymodule 인데 말이죠. 그리고 같은 이름 자체가 없다면 어떻게 되죠?