[NestJS] | NestJS 란 무엇인가, 프로젝트 생성 방법, 폴더 구조 이해 , NestJS CLI 사용법

Hayeon LEE·2024년 3월 9일
NestJS
0

NestJS

목록 보기
1/4
post-thumbnail

Reference

해당 강의와 참고 자료를 바탕으로 정리한 내용입니다.

Nest.js란 무엇인가

Node.js는 많은 사람들이 사용하는 서버 프레임워크이다. 지금도 가장 높은 정유율을 보유하고 있다. 하지만 Node.js는 정해진 아키텍처가 없기 때문에 개발자마다 다른 구조로 작성하는 문제가 있어, 협업이나 유지 보수에 어려움 있었다. 이러한 부분을 보완하기 위해 나온 것이 NestJS이다.
NestJS 는 Node.js의 Express 위에서 구축된 프레임워크로, Express의 기능을 확장하여 보다 체계적이고 모듈화된 구조를 제공한다.또한 TypeScript를 지원하며, 순수 JavaScript로도 사용 가능하다. 정의된 아키텍처에 따라 개발해야 하며, 이렇게 개발된 프로젝트는 여러 개발자 간 협업하기 좋다. 이로 인해 대규모 프로젝트에서 많이 사용된다. 또한, 라이브러리 및 기능들이 기본적으로 포함되어 있다. (RESTful API 구축을 위한 HTTP 연결, DB 연동, 미들웨어 구축, 인증 및 보안)
이 때문에 간단한 작은 규모의 서버일 땐 성능 오버헤드가 발생할 수 있기 때문에 프로젝트 특성을 파악해 가면서 적용하는 게 중요하다.


설치/실행

Nest CLI 설치

Nest CLI란?
Nest 애플리케이션의 초기화, 개발 및 유지 관리를 도와주는 인터페이스 도구이다.

npm i -g @nestjs/cli

프로젝트 생성

nest new project-name

실행

  • 개발 환경에서 실행
 npm run start

또는

  • 파일 변경을 감지, 파일을 감시하여 자동으로 서버를 다시 컴파일하고 다시 로드한다. (nodemon 제공)
npm run start:dev
npm i --save-dev @swc/cli @swc/core nest start -b swc

기본 폴더구조


스크린샷 2024-03-08 오후 3 51 09 
src/
├── app.controller.spec.ts
├── app.controller.ts
├── app.module.ts
├── app.service.ts
└── main.ts

먼저 젤 상단에 있는 파일부터 살펴보자.

app.controller.spec.ts

  • 특정 컨트롤러의 테스트를 위한 파일이다. Jest 또는 다른 테스트 프레임워크를 사용하여 컨트롤러의 동작을 확인할 수 있다.

main.ts

  • 진입점
import { AppModule } from './app.module';
import { NestFactory } from '@nestjs/core';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  await app.listen(3000);
}
bootstrap();

위 코드를 보면 app.module 파일에서 불러온 AppModule을 생성하고, 3000번 포트에서 서버를 실행하는 bootstrap() 함수를 호출하고 있다.
AppModule은 한 가지 역할을 담당하는 루트 모듈로써, 어플리케이션과 같은 역할을 한다고 볼 수 있다.

app.modules.ts

  • controller, service 포함, 앱의 루트 모듈
import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';

// 데코레이터는 클래스에 함수기능을 추가할 수 있다.
@Module({
  imports: [],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

위 코드에서는 AppModule 클래스가 정의되어 있고, @Module 데코레이터를 사용해 모듈을 정의하고 있다.
이 @Module 데코레이터는 controllers와 providers 속성이 포함하고 있다. controllers 속성은 컨트롤러 클래스들을 배열로 포함시키고, providers 속성은 서비스 클래스 배열을 포함한다.

그럼 이 데코레이터 안에 있는 속성들을 하나씩 살펴보자.

app.controller.ts

  • url을 받아 함수를 리턴

app.controller.ts로 이동하면 다음과 같은 코드를 볼 수 있다.

import { Controller, Get } from '@nestjs/common';
import { AppService } from './app.service';

@Controller()
export class AppController {
  constructor(private readonly appService: AppService) {}

  @Get() // express의 get라우터
  getHello(): string {
    return this.appService.getHello();
  }

  @Get('/hello') // 데코레이터는 꾸며주는 함. getHello()와 클래스가 붙어있어야 한다.
  sayHi(): string {
    return this.appService.getHi();
  }
}

컨트롤러는 express의 라우터와 같은 존재이다. 실제로 HTTP 요청을 처리하는 컨트롤러 클래스를 정의하고, 라우팅을 처리해 요청에 따라 적절한 응답을 반환하는 역할을 한다.기본적으로 url 엔드포인터를 가져오고 url에 매핑된 함수를 실행한다.(엔드포인터 처리 역할)
위 코드를 보면 @Controller 안에 @Get 데코레이터가 사용되어 있는데 이건 express의 app.get 메서드와 같은 역할이라고 볼 수 있다.
즉 @Get 데코레이터는 특정 url 경로로 들어오는 GET요청을 처리하고,이에 해당하는 함수를 실행하는 것이다. 예를 들어, /hello url을 요청받으면 sayHi 함수가 호출되고, 이 sayHi 함수는 appService.getHi()를 실행한다. 근데 여기서 함수를 실행하는 게 아니라 appService에 있는 함수를 실행하고 있다.

정리해보면 NestJS 에서는 컨트롤러는 url라우팅 및 요청을 받아 해당 로직을 수행하도록 서비스에 요청하고, 이 서비스는 실제 비지니스 로직을 실행해 그 결과를 다시 컨트롤러에게 반환한다. 이렇게 실행과 비지니스 로직을 분리하기 위해 서비스와 컨트롤러를 구분하여 사용한다.

비지니스 로직을 예를 들면 사용자가 회원가입을 요청하면, 사용자가 입력한 정보를 검증하고 데이터베이스에 저장하는 과정이 비지니스 로직에 해당한다.

주의할 점


  @Get()
  // 이렇게 데코레이터와 함수 사이에 빈칸을 추가하면 동작하지 않는다.
  getHello(): string {
    return this.appService.getHello();
  }

app.service.ts

  • 실제 비지니스 로직 실행
import { Injectable } from '@nestjs/common';

@Injectable()
export class AppService {
  getHello(): string { /
    return 'Hello World!';// 실제 함수 로직 -> 함수를 실행하는 컨트롤러에게 전달
  }
  getHi(): string {
    return 'Hi!';
  }
}

위의 코드에서 @Injectable 데코레이터 함수는 AppService 클래스가 NestJS 에서 의존성 주입이 가능한 서비스임을 나타낸다. getHello()는 실제로 실행되는 함수로, 리턴 값인 Hello World!는 클라이언트에게 반환되어 브라우저에 출력된다.
즉, 비즈니스 로직이나 데이터 처리를 담당하는 서비스 클래스를 정의하고, 컨트롤러와 서비스를 분리함으로써 코드를 재사용할 수 있게된다.

NestJS CLI 사용법

다음과 같이 터미널에서 nest를 실행하면 주요 명령어와 옵션을 확인할 수 있다.

nest
스크린샷 2024-03-09 오후 10 33 37
  • 새로운 Nest 요소를 생성할 때 사용하는 명령어
nest generate|g [options] <schematic> [name] [path]
  • schematic : 생성할 요소의 유형을 나타낸다. (module, controller, service 등)
  • name : 생성할 요소의 이름을 나타낸다.
  • path : 생성된 요소의 경로를 나타낸다. (기본적으로 현재 디렉토리에 생성)

예시

  1. controller 생성
nest generate controller movies
  • 아래와 같이 간단하게 줄여서 사용할 수도 있다.
nest g co movies
  • What name would you like to use for the controller?
    컨트롤러를 생성할 때 이름을 지정하지 않으면 다시 이름을 입력하라는 메시지가 표시된다.
    이때 이름을 입력하지 않고 엔터를 누르면 컨트롤러가 폴더 없이 생성된다.

예를 들어, movies라는 이름의 컨트롤러를 생성하면 다음과 같이 movies 폴더 안에 컨트롤러 파일이 생성되고, app.module.ts 파일에 자동으로 MoviesController가 추가된다.

스크린샷 2024-03-09 오후 10 52 16
profile
Hayeon LEE
미래의 나를 위한 기록
다음 포스트

[NestJS] | 데코레이터 개념과 예시

0개의 댓글