[TIL]module,require,exports

Today I learned

module, require(), module.exports


기본적으로 Node.js는 '모듈(module)'로 이루어져있다.


Node.js에서의 모듈 개념

노드에서 모듈이라는 개념은 노드(Node)로 개발한 어플리케이션을 이루는 기본 단위라고 할 수 있다. 쉽게 말하면 어떤 물건을 만들 때 쓰는 하나의 부속품이 모듈이라고 볼 수 있다.

건물을 만든다고 가정했을 때, 창문이 있을 것이고 지붕이 있고 문, 바닥, 천장, 기둥 이런 다양한 부분으로 나누어 볼 수 있다. 문은 재료로 나누면 알루미늄이나 목재로 이루어져 있을 것이고, 창문은 유리와 알루미늄으로 이루어져 있다. 이런 재료들을 이용해서 미리 만들어진 파트들(문, 창문 등)로 건물을 짓는 것처럼 관련된 코드들을 모아서 캡슐화해놓은 것을 모듈이라고 한다. 모듈은 정말 작은 단위이고, 이러한 모듈들을 모아서 다시 패키지(Package)를 만들 수도 있다. 패키지를 load하면 내부의 다양한 모듈들을 사용할 수 있는 것이다.

일반적으로 노드로 개발된 애플리케이션은 객체지향 개념이 잘 녹아 있는 자바스크립트를 기반으로 하여, 파일과 1:1 맵핑이 되는 다양한 모듈로 구성된다. 이는 노드를 개발할 때 개발자가 추가하는 모듈뿐만 아니라 노드의 기능을 확장할 수 있도록 해주는 확장 모듈이나 기본으로 제공하는 기본 모듈이 있다.

Node.js**의 모듈화 개념**


노드는 확장성을 위해 모듈 구조를 통해 애플리케이션을 구성하도록 하고 있다. 모듈은 애플리케이션을 이루는 기본 단위로, 보통 다수의 클래스와 이를 통해 생성한 객체 등으로 구성된다. 이렇게 모듈 단위로 구성된다는 것은 객체 지향 컨셉으로 애플리케이션이 구성된다는 것을 의미한다고 말할 수 있으며, 이는 앞서 설명한 대로 노드가 CommonJS의 스펙을 대부분 준수하기 때문이다.

기본적으로 노드의 모듈(one module)은 자바스크립트 파일 하나(one .js file)와 1:1로 맵핑된다고 생각하면된다. 이러한 모듈 형태는 다음 장에서 설명할 NPM으로 쉽게 할 수 있는 노드 확장 모듈의 개발을 편리하게 해주며, 실제 우리가 애플리케이션을 개발할 때에도 소스 코드를 깔끔하게 구성할 수 있도록 해준다.

모듈은 기본적으로 기능이 추상화된 캡슐이라고 생각하면 편하다.

노드의 모듈은 CommonJS 모듈 스펙으로부터 많은 영향을 받아 구현되었지만 완벽하게 같진 않다. 하지만 많은 유사점이 있으며, CommonJS 기반의 다른 시스템과 공유하고자 한다면 이 스펙에 대해 이해하고 있는 것이 도움될 것이다.

전역 객체의 개념


전역 객체는 어디에서나 사용할 수 있는 객체를 말한다. 클라이언트 자바스크립트에서는 window 나 document와 같은 객체를 전역 객체라고 말할 수 있는데, 우리가 alert()이라는 함수를 사용할 때 단순히 "alert('메시지')"만 입력하더라도, 사실은 window라는 객체에 window.alert() 과 같은 형태로 이미 포함되어 있으며, 전역객체를 생략하여 사용하고 있는 것이다.

마찬가지로 서버 사이드(백엔드)에서 동작하는 노드의 경우에는 "global"이라는 전역 객체가 존재하고 있는데, 여기에는 우리가 앞으로 모듈을 불러올 때 사용할 require()를 비롯하여 setTimeout(), console.log() 등을 포함하고 있다. 아래의 코드를 살펴보자.

1  require(./module’)
2  global.require(./module’)

위의 코드 2줄은 같은 의미다. global 이라는 전역 객체가 require()를 가지고 있기 때문에, 위의 두 표현이 모두 가능한 것이다. 전역 객체 global의 세부적인 내용에 대해서는 다음 강의에서 기본 모듈을 다룰 때 더 자세히 살펴보도록 하겠다.

**모듈의 종류**


노드에서는 모듈의 종류를 크게 노드 설치 시 기본적으로 설치되어 있는지에 대한 유무를 통해 기본 모듈과 확장 모듈로, 단순히 자바스크립트로 작성하였는지, C/C++ 등의 다른 언어로 작성하고 빌드하여 개발하였는지에 따라 일반 모듈과 네이티브 모듈로, 그리고 지금 현재 웹 애플리케이션을 위해서만 사용하기 위해 설치했는지에 따라 글로벌 모듈과 로컬 모듈 정도로 분류할 수 있습니다. 각 모듈의 종류를 알고 있는 것이 개발하는 것에 큰 영향을 미치는 것은 아니지만 모듈을 로딩하고 체계적으로 NPM을 배포하기 위해서는 각 모듈의 특징 정도는 알아두는 것이 좋다.

**기본 모듈과 확장 모듈**


기본 모듈은 노드를 설치하면 기본으로 설치되는 모듈로서 파일 입출력, 이벤트 관리, HTTP 프로토콜 관리 등에 관한 내용으로써 노드의 비동기 입출력 처리를 위한 기본적인 기능들을 제공하는 모듈이다.

이에 비해 확장 모듈은 노드의 기능을 확장하기 위한 것으로써 좀 더 쉬운 HTTP 서버 생성, 기본 파일 입출력에서 제공하지 않는 기능 추가 등 노드를 확장하고 더 편리하게 사용하기 위한 모듈이라고 말할 수 있다.

일반 모듈과 네이티브 모듈


일반 모듈과 네이티브 모듈은 개발 방법에 따라 나눌 수 있는 내용이다. 일반적으로 노드의 기본 모듈은 C/C++로 개발된 경우가 대부분이며 이렇게 네이티브 프로그래밍 언어인 C/C++로 노드의 모듈을 개발한 경우 네이티브 모듈이라고 한다. 확장 모듈 또한 네이티브 모듈로 개발할 수 있으며, .node라는 확장자를 가졌으면 네이티브 모듈로 컴파일된 것이라고 보면 된다. 일반 모듈은 노드의 모듈 인터페이스를 통해 간단히 자바스크립트로 개발된 모듈이다. 만약 같은 기능을 수행하는 네이티브 모듈과 일반 모듈이 있다고 한다면 대체로 네이티브 모듈이 더 나은 성능을 보인다.

글로벌 모듈과 로컬 모듈


기본 모듈을 포함하여 어디서든 사용할 수 있도록 설치한 확장 모듈을 글로벌 모듈이라고 한다면, 해당 애플리케이션에서만 사용하기 위해 설치한 확장 모듈이나 개발자가 개발한 모듈을 로컬 모듈이라고 분류할 수 있다. 확장 모듈을 글로벌 모듈로 사용하려면 설치 시 특별한 옵션(-g)을 이용하면 된다.

ex)
$ npm install -g range 
**이렇게 설치하면, node를 쓰는 어디서나 쓸 수 있다.**

복합 모듈


복합 모듈은 내부 모듈이나 데이터 파일, 템플릿, 테스트 코드 등을 포함하는 모듈을 말한다. 다양한 파일을 포함하기 때문에 모듈을 구성하는 단위가 폴더이며 내부적으로도 폴더를 가질 수 있다. require() 메소드가 이런 폴더 단위의 모듈을 인식하려면 index.js 파일이나 package.json 파일 중 하나가 반드시 있어야 한다.

⇒ 잘 이해가 안간다.

모듈 식별자


노드의 모듈 이름으로는 확장자 없는 전체 경로를 사용한다. 앞서 설명한 것처럼 모듈은 파일과 일대일로 대응하기 때문에 .js나 .node라는 확장자를 가지지만 모듈을 불러들일 때는 파일 이름만 사용하면 되기 때문이다. 모듈의 식별자는 크게 상대적 식별자와 절대적 식별자, 그리고 최상위 레벨 식별자 등 3가지가 있다.

상대적 식별자


상대적 식별자는 현재 위치를 기준으로 상대적인 기준에 있는 모듈을 찾는 식별자다. 유닉스 시스템의 상대 경로와 유사하다고 할 수 있겠으나, ./를 생략하면 현재 위치에서 모듈을 찾지 않으니 주의합시다.

//상대적 식별자 : 상대 경로
require('./sample_module');

절대적 식별자


절대적 식별자도 마찬가지로 절대 위치를 기준으로 그 경로에 맞는 모듈을 찾는 식별자이며, 유닉스 시스템에서 절대 경로와 비슷하다.

//절대적 식별자 : 절대 경로
require('/usr/local/node_modules/sample_module/sample_module');

최상위 레벨 식별자


아무것도 입력하지 않고 모듈 이름만 입력하면 최상위 레벨 식별자로 인식하고 설치된 전체 확장 모듈이나 기본 모듈 중에서 해당 모듈 이름을 검색하여 로드한다.

require('sample_module');

여기에서 중요한 점은 sample_module이라는 모듈 식별자를 찾는 순서다. 만약 sample_module이라는 모듈이 기본모듈에서 찾을 수 없는 모듈이라면, 상위 디렉토리를 차례대로 탐색하게 된다. 예를 들면 다음과 같은 순서로 탐색하게 된다.( 이것은 require 안에 path로 등록된다. )

/home/goorm/example_project/node_modules/**sample_moudle.js**
/home/goorm/node_modules/**sample_module.js**
/home/node_modules/**sample_module.js**
/node_modules/**sample_module.js**

require() 메소드와 module.exports


모듈 개념에서 require() 메소드module.exports가 왜 중요한 것일까?

먼저 클라이언트 측 자바스크립트와 비교를 해보자. 웹 브라우저에서 HTML의

<!DOCTYPE html>
	<html>
    <body>
        <script type="text/javascript" src="goorm1.js"></script>
    </body>
	</html>

html

이렇게 HTML 스크립트를 통해 명시된 자바스크립트 파일들은 웹 브라우저에 의해 로딩되며 서로 참조하거나 호출할 수 있다. 하지만, 노드는 HTML을 사용하지 않으므로 서로 다른 자바스크립트 파일들이 서로 참조하고 호출하는 방법이 필요하다.

require() 메소드는 모듈 식별자인 module.exports를 이용해 모듈이 제공하는 함수나 객체 등을 반환합니다. 만약 불러온 모듈이 다른 모듈이 있어야 한다면 그 모듈도 같이 로드하도록 되어 있다. 이것은 노드 모듈화에서 핵심이다.

노드에서 하나의 자바스크립트 파일은 하나의 모듈이 될 수 있다는 것을 잘 알고 있다. 이때 자바스크립트 파일 내부에서 함수나 변수를 module.exports에 할당하면 외부에서 접근할 수 있다. (외부 환경으로 노출시킨다고 볼 수 있다.) B.js는 자바스크립트로 작성된 모듈이다. 이 모듈은 name이라는 변수와 run(), stop()이라는 메소드를 가지고 있다.

B.js

{ 
  name : 12,
  function run() : { play() },
  function stop() : { stop() },
}

A.js
const moduleA = require('./B');

A.js는 이러한 모듈 B를 사용하고자 하는 자바스크립트 파일이다. 이 파일에서 moduleA라는 객체는 require() 메소드를 통해 생성된 모듈 B의 인스턴스를 할당받는다. B.js에서는 module.exports를 통해 run()과 stop() 메소드를 외부에서 사용할 수 있도록 허용하고 있으므로 A.js에서 moduleB를 통해 run()과 stop() 메소드를 호출하여도 동작하게 된다. 다시 말해, 모듈을 사용하는 파일에서는 require() 메소드로 다른 자바스크립트 파일을 불러와서 module.exports로 허용된 변수나 함수를 사용할 수 있다.

좋은 웹페이지 즐겨찾기