[week_06] Node.js 기초 | NPM의 이해, NPX, Node.js의 모듈, ES Module

1. NPM이란

• Node Package Manager
• Node.js 프로젝트를 관리하는 필수적인 도구
• 구성: 온라인 저장소 + 커맨드라인 도구
  • 온라인 저장소: 오픈소스 라이브러리와 도구들이 업로드되는 저장소
  • 커맨드라인 도구: 프로젝트 관리를 위한 다양한 명령어 제공

 

2. NPM 사용해 보기

• NPM의 사용 = NPM 커맨드라인 도구의 사용법을 익히는 것
• 프로젝트 디렉터리를 생성하고, 해당 디렉터리 안에서 $npm init 명령어를 사용하면 몇 번의 질문을 통해 package.json 이라는 파일을 만들어 주고, 이 디렉터리는 Node.js 프로젝트가 된다.

2-1. package.json

• 프로젝트 관련 정보들이 저장되는 파일, 이 파일을 직접 수정하거나 npm 명령어를 사용하여 프로젝트 정보를 수정할 수 있다.
• version, name, description, scripts, dependencies(의존성 패키지들), devDependencies, ...
• NPM을 이용하면 의존성을 쉽게 관리할 수 있다.
•  
• 의존성: 프로젝트 내에서 사용하는 라이브러리를 관리하는 방법
• 라이브러리: 특정 기능을 수행하는 코드의 묶음, Node.js에서는 패키지라고도 부른다.

2-2. npm install 명령어

• $npm install (npm i) 명령어를 통해 프로젝트 의존성을 관리할 수 있다.
• 의존성 추가, 의존성 내려받기, 개발용 의존성 추가, 전역 패키지 추가 등의 기능 수행
• $npm install [package-name]
  • 필요한 패키지를 프로젝트에 추가할 수 있다.
  • 추가된 패키지는 package.json의 dependencies안에 추가되며, node_modules 디렉터리에 저장됨
• $npm install [package-name] --save-dev
  • npm은 개발용 의존성을 분리하여 관리할 수 있다.
  • --save-dev 옵션을 통해 개발용 의존성(배포 전까지만 사용하는 의존성)을 추가할 수 있다.
  • 개발용 의존성은 package.json의 devDependencies에 추가됨
• 기본적으로 node_modules 디렉터리는 코드 관리와 배포 시에 업로드 하지 않는다.
  • 의존성이 많아지면 용량이 너무 커지고, OS별로 실행되는 코드가 다른 경우가 존재
• $npn install 명령어를 아무 옵션 없이 사용하면, package.json에 정의된 dependencies와 devDependencies의 의존성을 node_modules 디렉터리에 내려받음
• $npm install --production
  • 프로젝트를 배포할 때에는 개발용 의존성을 같이 포함할 필요가 없음
  • package.json의 dependencies만 node_modules에 내려받음
• $npm install [package-name]@version
  • 패키지 버전 지정
• package-lock.json
  • 프로젝트에 의존성을 추가하면 자동으로 생성되는 파일
  • 의존성 버전이 갑자기 변경되지 않도록 설치된 버전을 고정하는 역할
• $npm install [package-name] --global
  • 패키지를 전역 패키지 디렉터리에 내려받음
  • 커맨드라인 도구들을 주로 전역 패키지로 추가해서 사용

2-3. 로컬 패키지와 전역 패키지

• 로컬 패키지: package.json에 선언되어 있고, node_modules에 저장된 패키지
• 전역 패키지: npm install -g를 통해 내려받아, 전역 저장소에 저장된 패키지
• 프로젝트 의존성이 package.json 내에 명시적으로 선언되어 있는 것이 프로젝트 관리의 좋은 방향

2-4. $npm remove

• $npm remove [package-name]
  • 의존성 패키지를 삭제할 수 있다.
  • package.json의 dependencies와 devDependencies에서 삭제하고, node_modules에서도 삭제

2-5. 스크립트 실행하기

• 스크립트: 간단한 동작을 수행하는 코드
• package.json의 scripts에 선언된 스크립트를 npm run [script-name] 명령어로 실행
• npm script 내에서는 의존성 패키지를 사용할 수 있다.

2-6. 자주 사용되는 스크립트

• npm test: 코드 유닛 테스트 등에 사용
• npm start: 프로젝트 실행
• npm stop: 프로젝트 종료

2-7. NPM 요약

명령어	npm init	프로젝트 생성
	npm install	의존성 추가, 설치
	npm remove	의존성 삭제
	npm run	스크립트 실행
주요 파일/디렉터리	node_modules	프로젝트 의존성 저장 디렉터리
	package.json	프로젝트 관리 (버전, 의존성, 스크립트, ...)
	package-lock.json	의존성 버전 확인

 

3. NPX

• npm 패키지를 설치하지 않고 사용할 수 있게 해주는 도구
• 프로젝트에 추가하거나 전역 패키지로 추가하지 않고, npx를 이용하여 바로 실행할 수 있음
• Node.js의 특정 버전으로 실행할 수 있으므로, 프로젝트의 Node.js 버전별 실행환경을 확인할 때 유용
• gitbub gist 코드 실행 가능

 

4. Node.js의 모듈

• 모듈(Module) = 코드를 분리하기 위한 방법
• 패키지 = 모듈의 모음
• npm 패키지들은 많은 모듈을 포함하고 있는 코드 모음
• Node.js의 기본 제공 모듈

4-1. Node.js의 기본 제공 모듈

•  console
  • log, warn, error 함수로 로그 레벨 표시
  • time, timeLog, timeEnd 함수로 시간 추적
• process
  • 현재 프로세스 관련 기능 제공
  • 실행 환경 및 변수 관련 값 제공 (arch, argv, env 등)
  • 프로세스 동작 관련 함수 제공 (abort, kill, exit 등)
• fs
  • 파일 입출력을 위해 사용
  • readFile, writeFile 함수로 파일 읽기, 쓰기
  • -Sync 함수로 동기적으로 동작할 수 있게 한다.
  • watch로 파일/디렉터리 변경 이벤트 감지
• http
  • http 서버, 클라이언트를 위해 사용
  • createServer 함수로 서버 생성
  • Request 함수로 http 요청 생성
• 기타: url, os, Path, crypto, ...

 

5. 모듈의 작성과 사용

5-1. 모듈의 작성

module.exports = { 
	name,
    age,
    nationality,
};

• 모듈이 load 될 때 사용될 값을 module.exports로 내보낸다.

exports.name = name;
exports.age = age;
exports.nationality = nationality;

• 모듈을 object로 만들고, 각 key-value를 지정해서 내보낼 수 있다.

module.exports = (name, age, nationality) => {
	return {
    	name,
        age,
        nationality,
    };
}

• 모듈을 함수로 만들어서 모듈 사용 시에 값을 정할 수 있게 내보낼 수 있다.

5-2. 모듈의 사용

• require 함수를 통해 모듈을 load
• 의존성 패키지, 직접 작성한 모듈 사용 가능
• require할 때 모듈 코드가 실행된다. Node.js의 모듈은 첫 require 시에 실행 후, 그 다음부터는 메모리에 cache된 모듈을 사용한다. 다른 파일에서 또 require 한다고 해서 모듈이 두 번 실행하지 않는다. 따라서 모듈 코드를 여러 번 실행하기 위해서는 함수형 모듈로 작성

1) npm 패키지

const dayjs = require('dayjs');
console.log(dayjs());

• 의존성 패키지들은 require('package-name') 로 load 할 수 있다.
• 패키지를 사용하려면 node_modules 에 내려받아져 있어야 한다.

2) 직접 작성한 모듈

const myModule = require('./my-module');
console.log(myModule);

• 직접 작성한 모듈은 현재 작성중인 파일과의 상대 디렉터리로 load
• my-module이 .js 파일인 경우 해당 파일 load
• my-module이 디렉터리인 경우 my-module/index.js 파일이 load

3) 함수형 모듈

const myFunctionModule = require('./my-function-module');
console.log(myFunctionModule(name, age, nationality));

• 함수형 모듈은 load한 경우 모듈이 바로 실행되지 않는다.
• 필요한 시점에 load된 함수를 실행하여 모듈을 사용할 수 있다.

4) json 파일

// my-data.json을 가지고 있음
const myData = require('./my-data');
console.log(myData);

• object로 자동 파싱

✨ 요약
module.exports를 사용하여 모듈을 작성할 수 있다.
require를 사용하여 의존성 패키지, 모듈, json 파일을 사용할 수 있다.
모듈은 첫 require 시에만 실행하고 cache 되므로, 여러 번 실행할 모듈은 함수형으로 작성해야 한다.

 

6. ES Module

• ES6에서 등장한 JavaScript의 공식적인 표준 모듈
• ES Module과 commonjs(Node.js의 모듈)는 문법과 기본적인 동작 방식이 다르다.
• commonjs는 module.exports와 require로 모듈을 만들고 사용
• ES Module은 export와 import로 모듈을 만들고 사용
• 현재 ES Module은 Node.js에서 기본적으로 사용하기에 제약이 많다.