서론

Java 와 Spring 을 사용한 Javascript 개발자라면 한 번쯤 관심있게 봤을 법한 서버 프레임 워크일 것 같다. Express 도 굉장히 좋은 서버 프레임워크이지만 너무 자유로워서 망망대해에 떠있는 기분이었다. 따라서 다른 프레임워크를 찾다가 알게 되었고 요즘에 기업들에서도 많이 사용하고 관심있게 보고 있는 프레임워크인 것 같다.

그래서 nest.js 공부를 시작했는데 혼자서 정리가 잘 안되는 것 같아서 공부한 내용들을 적어보려고 한다. 오류가 있을 수도 있고 뇌피셜이 있을 수도 있지만 최대한 공식문서에 의거해서 팩트만 적을 수 있도록 하겠습니다.

오늘은 공식문서의 순서대로 프로젝트 생성을 하고 실행시켜 볼 수 있도록 한다.

본론

📍 nest.js 특징

우선 nest.js 의 특징은 다음과 같다.

• Angular 프레임워크 아키텍처에 대해서 영감을 받아서 제작되었다고 한다.
• 테스팅이 편리하고 유지관리가 쉬운 애플리케이션 아키텍처를 제공한다고 한다.
• API 들이 노출되어 있기 때문에 개발자가 사용성에 맞춰서 커스텀을 할 수 있다고 한다.
• 자세한 내용은 해당 링크를 통해서 읽어보면 될 것 같다.

📍 nest.js 생성하기

그럼 nest.js 프로젝트를 생성하고 실행시켜볼 수 있도록 하자.
nest.js 를 사용하기 위해서는 사전에 다운로드 해줘야 할 것들이 있다.

• node.js (LTS로 다운로드 권장)
• 사용하고자 하는 IDE (VSCode or Webstorm or 그 외 편한 툴)

환경이 세팅이 되었으면 터미널을 켜고 nest 프로젝트를 생성할 적당한 디렉토리로 위치를 옮긴다.
그리고 다음의 명령어를 입력한다.

$ npm i -g @nestjs/cli	// nestcli를 사용하기 위해 모듈 다운
$ nest new project-name // nest 프로젝트 생성

project-name 은 자신이 원하는 프로젝트 명을 입력할 수 있도록 한다.

따라서 프로젝트를 생성하고 자신이 사용하는 IDE에 임포트해서 실행하게 되면 다음과 같은 디렉토리 구조를 가지게 된다. (nest.js 는 기본적으로 Typescript 로 세팅되어 있지만 순수 Javascript 로도 코딩이 가능하다.)

node_modules
src
   - app.controller.spec.ts
   - app.controller.ts
   - app.modules.ts
   - app.service.ts
   - main.ts
test
nest-cli.json
package-lock.json
package.json
tsconfig.build.json
tsconfig.json
.eslintrc.js
.gitignore
.prettierrc
README.md

여기서 controller, modules, service 라는 이름이 붙여진 파일명이 보이는데 설명하자면 다음과 같다.

• Controller : Express 의 라우트와 같은 기능으로 사용자로부터 들어온 요청을 분기시켜서 서비스에서 처리할 수 있도록 도와준다.
• Modules : 응용프로그램 구조를 구성하는 데 사용하는 메타데이터를 제공해줍니다.
• Service : Controller 에서 분기 처리 된 후 비즈니스 로직을 수행할 수 있도록 도와준다.
• spec : spec 이름이 들어가는 코드는 테스트 코드를 작성하는 파일이라고 알면 된다.

글로써는 이해가 안 될 수 있지만 코드를 작성해가면서 사용하다보면 이해가 좀 더 쉽게 될 수 있다.

📍 nest.js 실행하기

먼저, 코딩을 들어가기전에 서버를 실행시켜서 잘 작동하는지 확인해볼 수 있도록 한다.
서버를 실행 시킬 수 있는 스크립트는 4가지가 있다.

"start": "nest start",
"start:dev": "nest start --watch",
"start:debug": "nest start --debug --watch",
"start:prod": "node dist/main",

여기서 나는 start:dev 를 이용해서 실행해 볼 예정이다. 따라서 터미널을 켜서 프로젝트 루트 디렉토리로 들어가고 다음 명령어를 입력할 수 있도록 한다.

npm run start:dev

실행하면 다음과 같이 로그가 뜬다.

[2:41:27 PM] File change detected. Starting incremental compilation...

[2:41:27 PM] Found 0 errors. Watching for file changes.

[Nest] 1335  - 12/13/2021, 2:41:27 PM     LOG [NestFactory] Starting Nest application...
[Nest] 1335  - 12/13/2021, 2:41:27 PM     LOG [InstanceLoader] ConfigHostModule dependencies initialized +17ms
[Nest] 1335  - 12/13/2021, 2:41:27 PM     LOG [InstanceLoader] AppModule dependencies initialized +0ms
[Nest] 1335  - 12/13/2021, 2:41:27 PM     LOG [InstanceLoader] ConfigModule dependencies initialized +0ms
[Nest] 1335  - 12/13/2021, 2:41:27 PM     LOG [RoutesResolver] AppController {/}: +2ms
[Nest] 1335  - 12/13/2021, 2:41:27 PM     LOG [RouterExplorer] Mapped {/, GET} route +2ms
[Nest] 1335  - 12/13/2021, 2:41:27 PM     LOG [NestApplication] Nest application successfully started +1ms

그리고 디폴트 포트는 3000번인데 따로 수정하지 않았으면 http://localhost:3000 으로 접속해보면 "Hello World!" 메시지가 뜰 것이다. (저는 포트를 8080으로 수정했습니다!)

여기까지 완료했으면 아무 문제 없이 nest 프로젝트가 생성이 됐다.

결론

오늘은 nest 프로젝트 생성과 실행까지 작성을 해보았는데, 다음 포스팅에서는 라우터를 작성해보고 로그와 에러 처리를 할 수 있는 코드를 작성해보면서 코드와 익숙해 질 수 있는 시간을 가지도록 해보겠다.

그럼 이만.. 총총..🏃🏻‍♀️