NestJS 프로젝트 시작과 구조의 이해

📒 NestJS 프로젝트 시작과 구조의 이해

지금은 프론트엔드 개발자이지만 항상 백엔드 개발도 함께 해야겠다는 생각을 지니고 살았습니다.

나중에 좋은 아이디어가 있으면 혼자서 오롯이 설계하고 구현할 수 있어야 오래 살아남을 수 있겠다고 느꼈기 때문입니다.

 

아무래도 자바와 스프링이 여러모로 유리한 면이 많지만, 거의 업계 표준이 된 리액트와 함께 JS, TS를 사용하는 NestJS 라면 시너지 효과로 인해 개발 속도를 정말 빠르게 향상시킬 수 있음을 느꼈습니다.

또한 NestJS가 스프링의 구조와 거의 유사한데, 이는 전에 스프링 학습을 해 둔 덕에 빠른 적응을 할 수 있어서 NestJS를 배워봐야겠다는 주요한 계기가 되었습니다.

 

그럼 앞으로 NestJS 학습을 시작하며 그 시작인 프로젝트 생성부터 기록하도록 하겠습니다.

 

📌 NestJS 설치

$ npm i -g @nestjs/cli
$ nest new project-name
$ nest --version

npm을 이용해 글로벌로 @nestjs/cli 모듈을 설치 한 뒤 nest new 명령어로 프로젝트를 생성합니다.

버전 확인을 통해 제대로 설치되었는지 확인할 수 있습니다.

그 후 본인이 사용하는 패키지 매니저를 선택하면 프로젝트 생성은 마치게 됩니다.

 

📌 초기 생성 핵심 파일

프로젝트를 생성하면 다음 5개의 핵심 파일이 생성됩니다.

그 파일들의 역할은 다음과 같습니다.

app.controller.spec.ts	컨트롤러에 대한 단위 테스트.
app.controller.ts	단일 경로를 갖춘 기본 컨트롤러입니다.
app.module.ts	애플리케이션의 루트 모듈.
app.service.ts	단일 서비스를 제공하는 기본 서비스입니다.
main.ts	NestFactoryNest 애플리케이션 인스턴스를 생성하기 위해 코어 함수를 사용하는 애플리케이션의 입력 파일입니다 .

 

그럼 주요 파일에 대한 역할에 대해 알아볼까요?

 

🔎 main.ts

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';

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

앱에 시동을 걸어주는 역할을 담당하는 main 파일은 부트스트랩 함수가 포함됩니다.

이 파일에서는 HTTP 리스너를 시작하여 애플리케이션이 인바운드 HTTP 요청을 기다리도록 합니다.

 

🔎 app.controller.ts

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

@Controller() // 컨트롤러 데코레이터
export class AppController {
  constructor(private readonly appService: AppService) {}

  @Get() // HTTP GET 요청을 처리
  getHello(): string {
    return this.appService.getHello();
  }
}

app.controller.ts는 NestJS 애플리케이션의 기본 컨트롤러 파일로, 요청을 받아 특정 경로에 대해 적절한 응답을 반환하는 역할을 합니다.

컨트롤러는 클라이언트 요청을 처리하고 서비스 계층으로 전달하여 애플리케이션의 비즈니스 로직을 수행하며, 이 결과를 다시 클라이언트에 반환하는 구조입니다.

 

🔎 app.service.ts

import { Injectable } from '@nestjs/common';

@Injectable() // 서비스 클래스를 주입 가능한 상태로 정의
export class AppService {
  getHello(): string {
    return 'Hello World!';
  }
}

app.service.ts는 NestJS 애플리케이션에서 서비스 계층의 기능을 담당하는 파일로, 컨트롤러에서 요청을 받아 실제 비즈니스 로직을 수행하는 데 사용됩니다.

서비스는 데이터 처리, 외부 API 호출, 데이터베이스 연동 등 다양한 작업을 처리하며, 컨트롤러는 서비스로부터 결과를 받아 클라이언트에게 전달하는 역할을 합니다.

 

🔎 app.module.ts

import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';

@Module({
  imports: [],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

app.module.ts는 NestJS 애플리케이션의 최상위 모듈 파일로, 애플리케이션의 구성 요소를 정의하고 설정하는 역할을 합니다.

NestJS는 모듈 시스템을 기반으로 작동하며, app.module.ts는 애플리케이션을 실행하기 위한 기본 모듈입니다.

다른 모듈과 마찬가지로 app.module.ts는 컨트롤러, 서비스, 그리고 다른 모듈들을 그룹화하여 애플리케이션의 구조를 정의하는 데 사용됩니다.

 

@module 데코레이터 안에 컨트롤러, 서비스 같은 모듈을 정의해주어야 NestJS가 관리할 수 있게 됩니다.

Nest CLI를 이용한다면 모듈들을 직접 생성하고 이 파일에 명시하지 않아도 이러한 보일러플레이트를 자동으로 생성해줍니다.

 

📌 Nest CLI Generator

Nest CLI의 Generator는 NestJS 애플리케이션 개발 시 구조 생성을 자동화하는 도구로, 특정 명령어를 통해 애플리케이션의 모듈, 컨트롤러, 서비스 등을 빠르게 생성해 줍니다.

이 기능을 사용하면 반복적인 파일 생성과 초기 코드를 자동으로 작성할 수 있어 개발 시간을 단축하고 프로젝트 구조를 일관되게 유지할 수 있습니다.

 

예를 들어 users란 이름의 컨트롤러를 생성할 때는 다음과 같은 명령어를 사용할 수 있습니다.

$ nest generate controller users
$ nest g co users

위와 같이 보일러 플레이트와 모듈 등록을 자동화할 수 있습니다.

 

예시로 컨트롤러를 설명드렸는데요.

그 외에도 자동화할 수 있는 명령은 다음과 같이 $ nest 명령어로 확인이 가능합니다.

 

풀네임 보단 alias를 이용한 축약어로 사용하는게 훨씬 편하니 참고해주세요.

 

📌 NestJS의 구조

NestJS는 모듈화와 의존성 주입(DI) 원칙을 기반으로 설계된 구조로, 확장성과 유지보수성을 고려하여 애플리케이션을 구성하는 데 중점을 둡니다.

이러한 구조는 애플리케이션을 여러 계층으로 나누어 각 계층이 특정 역할을 담당하도록 설계되어 있습니다.

🔎 Modules

NestJS는 모듈을 기반으로 애플리케이션을 구성하며, 각 모듈은 애플리케이션의 기능적인 단위로 역할을 나누어 모듈화된 구조를 만듭니다.

• 모듈 파일(*.module.ts)은 @Module() 데코레이터로 정의되며, 해당 모듈의 컨트롤러와 서비스들을 그룹화합니다.
• 모듈은 특정 기능을 담당하도록 분리되며, 다른 모듈과의 의존 관계를 통해 애플리케이션 전반의 기능을 제공합니다.
• AppModule은 최상위 모듈로 애플리케이션의 루트 모듈 역할을 하며, 여기서 다른 모듈들을 imports로 불러와 등록합니다.

 

🔎 Controller

컨트롤러는 HTTP 요청을 받아 이를 처리하고, 적절한 응답을 반환하는 역할을 합니다.

주로 라우팅 및 요청 처리를 담당합니다.

• 컨트롤러 파일(*.controller.ts)은 @Controller() 데코레이터를 통해 지정된 경로로 들어오는 요청을 처리하며, 요청의 종류(GET, POST 등)에 맞게 핸들러 메서드를 정의합니다.
• 컨트롤러는 서비스 계층을 호출하여 비즈니스 로직을 처리하고, 결과를 클라이언트에 반환합니다.

 

🔎 Providers / Service

NestJS의 의존성 주입 시스템을 통해 인스턴스화되어 제공되는 모든 클래스가 프로바이더입니다.

서비스, 리포지토리, 팩토리 등 다양한 역할을 프로바이더가 담당하며, 비즈니스 로직 및 데이터 처리를 수행합니다.

• 프로바이더 파일(*.service.ts 등)은 @Injectable() 데코레이터로 정의되어 다른 클래스에 주입될 수 있습니다.
• 예를 들어, UsersService는 사용자 관련 로직을 처리하는 서비스로 UsersController에 주입됩니다.

 

🔎 Middleware, Guards, Interceptors, Pipes

NestJS에는 추가적인 처리 계층을 제공하는 다양한 기능이 있습니다.

• Middleware
  요청을 컨트롤러가 받기 전에 처리하는 계층입니다.
  로깅, 인증 등의 사전 작업을 수행할 수 있습니다.
• Guards
  요청이 처리되기 전, 접근 권한을 제어하는 로직을 포함합니다.
  @UseGuards() 데코레이터를 통해 특정 요청에 대해 Guard를 설정할 수 있습니다.
• Interceptors
  요청/응답을 가로채어 추가적인 작업을 수행하는 데 사용됩니다.
  예를 들어, 응답 데이터의 변환, 캐싱 로직 등이 가능합니다.
• Pipes
  요청 데이터의 변환 및 유효성 검사를 수행합니다.
  DTO와 함께 사용되어 요청 데이터의 형식과 유효성을 검사합니다.

 

📌 NestJS 다른 글

Docker로 PostgreSQL 설치하고 NestJS + prisma 연동하기

Docker로 PostgreSQL 설치하고 NestJS + prisma 연동하기

 

NestJS와 prisma로 편리하게 CRUD 구현하기

NestJS와 prisma로 편리하게 CRUD 구현하기