[Node.js] Node.js와 MongoDB 1

01. NPM이해하기

✔️NPM이란?

Node Package Manager

Node.js 프로젝트를 관리하는 필수적인 도구

온라인 저장소 + 커맨드라인 도구(툴)

✔️NPM온라인 저장소

수많은 오픈소스 라이브러리와 도구들이 업로드되는 저장소.

필요한 라이브러리나 도구를 손쉽게 검색 가능.

Node.js의 인기로 거대한 생태계를 보유

✔️NPM커맨드라인 도구

프로젝트 관리를 위한 다양한 명령어를 제공

• 저장소에서 라이브러리, 도구 설치
• 프로젝트 설정 / 관리
• 프로젝트 의존성 관리

02. NPM으로 프로젝트 생성하기

✔️NPM을 사용한다는 것은?

NPM커맨드라인 도구의 사용법을 익히는 것..!!

✔️프로젝트 생성하기

$npm init

 

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

해당 디렉토리 안에서 npm init 명령어를 사용하면

몇 번의 질문을 통해 package.json이라는 파일을 만들어 주고

이 디렉토리는 Node.js 프로젝트가 됨.

 

npm init 시 다음 이미지와 같이 여러 질문을 함

✔️package.json

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

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

package.json의 구성요소

✔️의존성 관리하기

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

프로젝트가 실행되기 위해 라이브러링 의존하기 때문에

이러한 라이브러리들을 dependency(의존성)이라고 이야기함

✔️라이브러리란?

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

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

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

✔️npm install 명령어

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

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

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

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

✔️프로젝트에 의존성 추가하기(dependencies vs devDependencies)

$npm install [package-name]

 

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

추가된 패키지는 package.json의 dependencies안에 추가되며,

node_modules 디렉토리에 저장됨

 

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

 

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

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

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

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

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

$npm install

 

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

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

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

 

npm install 명령어를 아무 옵션 없이 사용하면

package.json에 정의된 dependencies와 devDependencies의 의존성을 node_modules디렉토리에 내려받음.

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

$npm install --production

 

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

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

✔️의존성 버전 표기법

$npm install [package-name]@[version]

 

패키지 버전을 지정해서 설치 가능

ex)

~1.13.0 : 1.13.x 버전 설치

^1.13.0 : 1.x.x버전 설치, 가장 왼쪽의 숫자의 버전을 고정.

0.13.0 : 0.13.0버전만 설치

✔️package-lock.json

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

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

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

✔️전역 패키지 추가

$npm install [package-name] --global

 

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

커맨드라인 도구들을 주로 전역 패키지로 추가해서 사용

ex) express-generator(웹서버를 만들어줌),pm2(node.js프로세스를 관리해주는 라이브러리)

✔️로컬 패키지와 전역 패키지

로컬 패키지

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

 

전역 패키지

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

 

전역 패키지도 프로젝트에서 사용할 수 있으나

프로젝트의 의존성이 package.json내에 명시적으로 선언되어 있는 것이 프로젝트 관리의 좋은 방향..

✔️의존성 삭제하기

$npm remove [package-name]

 

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

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

node_modules에서도 삭제됨

✔️스크립트 실행하기

$npm run [script-name]

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

package.json의 script에 선언된 스크립트를 위 명령어로 실행할 수 있음

스크립트 예시

✔️npm script를 사용하는 이유

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

✔️자주 사용되는 스크립트

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

 

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

start - 프로젝트 실행

stop - 프로젝트 종료

 

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

 

✔️NPM 요약

03. NPX

✔️NPX란?

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

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

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

npx를 사용하면 Node.js의 특정 버전을 사용하여 js파일을 실행할 수 있음

프로젝트의 Node.js버전 별 실행환경을 확인할 때 유용

✔️NPX - github gist코드 실행

gist는 github에 등록된 간단한 코드

npx를 이용하면 gist코드를 다운받지 않고 바로 실행 가능

 

git이 설치되어있어야함

온라인상의 코드는 어떤 위험이 있을지 모르므로 코드를 잘 확인하고 실행해야 함

04. Node.js의 모듈

✔️모듈이란?

간단한 프로그램이라면 파일 하나로도 가능

프로젝트가 커지면 기능에 맞게 코드를 분리하는 것이 중요

모듈은 코드를 분리하기 위한 방법

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

✔️모듈과 패키지

패키지는 모듈의 모음

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

✔️Node.js의 기본 제공 모듈

Node.js는 다양한 모듈을 기본적으로 제공함

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

✔️Node.js의 기본 제공 모듈 - console

브라우저에서 제공하는 console과 유사한 디버깅 도구

log, warn,L 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요청 생성

✔️Node.js의 기본 제공 모듈 - 기타 기본제공 모듈

https://nodejs.org/idst/latest-v14.x/docs/api/

05. 모듈의 작성과 사용

모듈의 기본적인 작성법

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

 

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

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

✔️함수를 export하는 모듈 작성법

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

✔️모듈의 사용 방법

require함수를 통해 모듈을 load할 수 있음

C에서 include, Java에서 import와 유사

의존성 패키지, 직접 작성한 모듈 사용 가능

✔️require동작의 이해

require할 때 모듈 코드가 실행됨

Node.js의 모듈은 첫 require시에 cache, 두 번 실행하지 않음

(다른 파일에서 또 require한다고 해서 다시 실행하지는 않음)

모듈 코드를 여러번 실행하기 위해선 함수 모듈로 작성해야함

✔️모듈의 사용 방법 -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로 자동 파싱

06. ES-Module

ES6에서 등장한 JavaScrit의 공식적인 표준 모듈

JavaScript는 기본적으로 "모듈"을 제공하고 있지 않았음

Node.js는 독자적인 방식을 통해 모듈을 지원하고 있었음(commonjs)

ES Module의 등장으로 Node.js에선 두 가지 모듈을 지원할 필요가 생김

✔️ES Module과 commonjs

ES Module과 commonjs는 문법과 기본적인 동작 방식이 다름

commonjs는 module.exports와 require로 모듈을 만들고 사용

ES Module은 export와 import로 모듈을 만들고 사용

✔️어떤 모듈을 사용해야 할까?

현재 ES Module은 Node.js에서 기본적으로 사용하기에 제약이 많음

(프로젝트타입을 module로 변경, commonjs모듈 import시에 문제 발생 등)

 

프로젝트 사용 방향에 따라 선택하면 될 듯..!

 

 

참고

https://swtrack.elice.io/