[JS] Node.js 와 MongoDB II

NPM 과 모듈

-NPM 이란?

-NPM 온라인 저장소

• 수많은 오픈 소스 라이브러리와 도구들이 업로드되는 장소
• 필요한 라이브러리나 도구를 손쉽게 검색 가능
• Node.js 의 인기로, 거대한 생태계를 보유

-커맨드라인 도구

• 저장소에서 라이브러리 도구 설치
• 프로젝트 관리를 위한 다양한 명령어를 제공
• 프로젝트 설정/관리
• 프로젝트 의존성 관리

NPM 사용해 보기

-NPM을 사용한다는 것은?

: NPM 커맨드라인 도구의 사용법을 익히는 것. 프로젝트의 생성부터 다양한 기능을 사용하는 법까지 학습

 

-프로젝트 생성하기

$npm init

프로젝트 디렉토리를 생성하고,

해당 디렉토리 안에서 npm init 명령어를 사용하면 몇 번의 질문을 통해 package.json 이라는 파일을 만들어 주고 이 디렉터리는 Node.js 프로젝트가 됨.

-package.json

: 프로젝트 관련 정보들이 저장되는 파일

-> 이 파일을 직접 수정하거나 npm 명령어를 사용하여 프로젝트 정보를 수정할 수 있음

-의존성 관리하기

: 프로젝트 내에서 사용하는 라이브러리를 관리하는 방법

->프로젝트가 실행되기 위해 라이브러리에 의존하기 때문에 이러한 라이브러리들을 dependency(의존성) 라고 이야기 함

 

-라이브러리란?

: 특정 기능을 수행하는 코드의 묶음

->복잡한 기능을 직접 작성하지 않고 다른 사람이 구현한 것을 사용하는 방법

(Node.js 에서는 패키지 라고도 부름)

 

-npm install 명령어

: npm install 명령어를 통해 프로젝트 의존성을 관리할 수 있음.

-> npm install 명령어는 사용 방법에 따라 여러 용도로 사용 가능

(npm i 를 축약형으로 사용 가능)

 

• 의존성 추가
• 의존성 내려 받기
• 개발용 의존성 추가
• 전역 패키지 추가

-프로젝트에 의존성 추가하기

$npm install [package-name]

필요한 패키지를 프로젝트에 추가할 수 있음.

추가된 패키지는 package.json의 dependencies 안에 추가되며, node_modules 디렉터리에 저장됨.

 

-dependencies 와 devDependencies

$npm install [package-name] --save-dev

npm은 개발용 의존성을 분리하여 관리할 수 있음.

개발용 의존성이란 배포 전까지만 사용하는 의존성 (ex. 유닛 테스트 라이브러리)

--save-dev 옵션을 이용하면 개발용 의존성을 추가할 수 있음.

개발용 의존성은 package.json 의 devDependencies 에 추가됨.

 

-package-lock.json

프로젝트에 의존성을 추가하면 package-lock.json 이라는 파일이 생성됨.

프로젝트에 의존성을 추가하면 자동으로 '^최신 버전' 으로 추가가 되는데,

의존성 버전이 갑자기 변경되지 않도록, 설치된 버전을 고정하는 역할을 함.

 

-의존성 버전 표기법

npm install [package-name]@[version] 으로 패키지 버전을 지정할 수 있음.

 

ex)

^1.13.0 - 1.13.x 버전 설치

^1.13.0 - 1.x.x 버전 설치, 가장 왼쪽의 0이 아닌 버전을 고정.

0.13.0 - 0.13.0 버전만 설치

 

-프로젝트에 의존성 내려받기

$npm install

기본적으로 node_modules 디렉터리는 코드 관리나 배포 시에 업로드 하지 않음.

의존성이 많아지면 용량이 너무 커지는 것과,

운영체제별로 실행되는 코드가 다른 경우가 존재하기 때문.

 

npm install 명령어를 아무 옵션 없이 사용하면 package.json에 정의된 dependencies 와 devDependencies 의 의존성을 node_modules 디렉터리에 내려받음.

 

-개발용 의존성을 제외하고 내려받기

$npm install --production

프로젝트를 배포할 때에는 개발용 의존성을 같이 포함할 필요가 없음.

package.json 의 dependencies 만 node_modules 에 내려받음.

 

-전역 패키지 추가

$npm install [package-name] --global

패키지를 전역 패키지 디렉터리에 내려 받음.

주로 프로젝트에 종속되지 않는 커맨드라인 도구들을 전역 패키지로 추가해서 사용

ex) express-generator, pm2

 

-로컬 패키지와 전역 패키지

로컬 패키지: package.json 에 선언되어 있고, node_modules 에 저장된 패키지

전역 패키지: npm install -g 를 통해 내려받아, 전역 패키지 저장소에 저장된 패키지

-> 전역 패키지도 프로젝트에서 사용할 수 있으나, 프로젝트의 의존성이 package.json 내에 명시적으로 선언되어 있는 것이 프로젝트 관리의 좋은 방향

 

-의존성 삭제하기

$npm remove [package-name]

의존성 패키지를 삭제할 수 있음.

package.json 의 dependencies 와 devDependencies 에서 삭제하고 node_modules에서도 삭제

 

-스크립트 실행하기

스크립트란 간단한 동작을 수행하는 코드.

-> package.json 의 scripts에 선언된 스크립트를 npm run [script-name] 명령어로 실행할 수 있음.

-npm script를 사용하는 이유

: npm script 내에선 의존성 패키지를 사용할 수 있음.

-자주 사용되는 스크립트

npm 스크립트엔 run을 제외하고 사용할 수 있는 주요 스크립트들이 있음

 

test-코드 유닛 테스트 등에 사용

start-프로젝트 실행

stop-프로젝트 종료

 

run을 제외하고 사용할 수 있을 뿐, npm 내부적으로 코드를 제공해 주는 것은 아님

 

-NPM 요약

NPX

-NPX란?

: npm 패키지를 설치하지 않고 사용할 수 있게 해주는 도구

-> 프로젝트에 추가하거나 전역 패키지로 추가하지 않고, npx를 이용하여 바로 실행할 수 있음

 

-NPX - Node.js 특정 버전으로 실행

-> npx 를 사용하면 Node.js 의 특정 버전을 사용하여 js 파일을 실행할 수 있음. (프로젝트의 Node.js 버전 별 실행환경을 확인할 때 유용)

 

-NPX - github gist 코드 실행

• gist는 github에 등록된 간단한 코드.
• npx를 이용하면 gist 코드를 다운받지 않고 바로 실행 가능.
• git이 설치되어 있어야 함.
• 온라인 상의 코드는 어떤 위험이 있을지 모르므로 코드를 잘 확인하고 실행해야 함.

Node.js 의 모듈

-모듈이란?

: 간단한 프로그램이라면 파일 하나로도 가능. 프로젝트가 커지면 기능에 맞게 코드를 분리 하는 것이 중요. 모듈은 코드를 분리하기 위한 방법

-> 반복되는 B라는 코드를 모듈로 분리하여 사용

 

-모듈과 패키지

패키지: 모듈의 모음

npm 패키지: 많은 모듈을 포함하고 있는 코드 모음

 

-Node.js 의 기본 제공 모듈

: Node.js는 다양한 모듈을 기본적으로 제공함. 기본 제공 모듈은 작성하기 매우 어렵거나 복잡한 로직을 포함한 모듈이 있으므로 자주 사용되는 기본 제공 모듈을 학습해야 함.

 

-Node.js의 기본 제공 모듈 (console)

• 브라우저에서 제공되는 console과 유사한 디버깅 도구
• log, warn, error 함수로 로그 레벨 표시
• time, timeLog, timeEnd 함수로 시간 추적

-Node.js 의 기본 제공 모듈 (process)

• 현재 실행 프로세스 관련 기능 제공
• arch, argv, env 등 실행 환경 및 변수 관련 값 제공
• abort, kill, exit 등 프로세스 동작 관련 함수 제공

-Node.js의 기본 제공 모듈 (fs)

• 파일 입출력을 하기 위해 사용
• readFile, writeFile 함수로 파일 읽기, 쓰기
• Sync 함수 제공. 동기 동작
• watch 로 파일/디렉터리 변경 이벤트 감지

-Node.js 의 기본 제공 모듈 (http)

• http 서버, 클라이언트를 위해 사용
• createServer 함수로 서버 생성
• Request 함수로 http 요청 생성

-기타 기본제공 모듈

모듈의 작성과 사용

-모듈의 기본적인 작성법

-> 모듈이 load 될 때 사용될 값을 module.exports로 내보냄.

 

-변수명으로 export 하는 모듈 작성법

-> 모듈을 object로 만들고, 각 key-value를 지정해서 내보냄

 

-함수를 export 하는 모듈 작성법

-> 모듈을 함수로 만들어서 모듈 사용 시에 값을 정할 수 있게 내보냄

 

-모듈의 사용 방법

• require 함수를 통해 모듈을 load 할 수 있음
• C에서 include, Java에서 import와 유사
• 의존성 패키지, 직접 작성한 모듈 사용 가능

-모듈의 사용 방법 (require 동작의 이해)

• require 할 때 모듈 코드가 실행됨
• Node.js 의 모듈은 첫 require 시에 cache, 두 번 실행하지 않음.
• 모듈 코드를 여러 번 실행하기 위해선 함수 모듈로 작성

-모듈의 사용 방법 (npm 패키지)

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

-모듈의 사용 방법 (직접 작성한 모듈)

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

-모듈의 사용 방법 (함수형 모듈)

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

-모듈의 사용방법 (json 파일)

• require로 json 파일도 load 가능
• object로 자동피싱

-모듈의 작성과 사용 요약

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

심화-ES Module

-ES Module

• ES6에서 등장한 JavaScript의 공식적인 표준 모듈
• JavaScript는 기본적으로 '모듈'을 제공하고 있지 않았음
• Node.js는 독자적인 방식을 통해 모듈을 지원하고 있었음 (commonjs)
• ES Module의 등장으로 Node.js에선 두 가지 모듈을 지원할 필요가 생김

-ES Module과 commonjs

• ES Module과 commonjs는 문법과 기본적인 동작 방식이 다름
• commonjs는 module.exports와 require로 모듈을 만들고 사용
• ES Module은 export 와 import로 모듈을 만들고 사용

-ES Module 을 사용할 수 있을까

• ES Module은 Node.js 의 등장 이후로 탄생한 표준
• Node.js는 14버전부터 ES Module을 안정적으로 지원하지만 commonjs가 일반적으로 많이 사용되고 있었고, 두 모듈의 동작 방식이 크게 달라서 require를 import로 대체할 수 없음
• Node.js는 ES Module과 commonjs를 같이 사용하기에 부적절함

-어떤 모듈을 사용해야 할까

• 현재 ES Module은 Node.js에서 기본적으로 사용하기에 제약이 많음 (프로젝트 타입을 module로 변경, commonjs 모듈 import 시에 문제 발생 등)