[nestjs] nestjs 기본 개념과 프로젝트 로직 흐름

nestjs 기본 개념

모듈(modules)

출처: nestjs 공식문서

밀접하게 관련된 기능들을 모아 만든 어플리케이션의 구성품. (자동차 어플리케이션의 바퀴, 몸체, 엔진 등등...)

각 어플리케이션에는 무조건 하나 이상의 모듈이 있고, 최상위 모듈을 루트모듈이라고 함.

클래스에 @Module() 데코레이터를 달아 생성함.

모듈은 기본적으로 싱글톤이므로 어려 모듈 간 쉽게 공급자의 동일한 인스턴스를 공유할 수 있다. (ex-공통 모듈을 생성하여, 다른 모듈에서도 사용 가능.)

nest g module module_name
nest g mo mo_name

 

컨트롤러(controllers)

출처: nestjs 공식문서

들어오는 요청을 처리하고 클라이언트에게 응답을 반환하는 역할.

각 요청을 구분하는 라우터 역할을 함.

클래스에 @Controller 데코레이터를 달아 생성하고, 인자로 요청의 '경로' 를 받는다.

• Handler : Http Method 데코레이터가 달린 메소드. 인자로 '경로' 를 받는다. 해당 컨트롤러로 들어온 요청을 handle 함.

nest g controller controller_name
nest g co co_name

 

프로바이더(providers)

출처: nestjs 공식문서

nestjs 에서 사용하는 개념.

컨트롤러에 필요한 많은 것들을 컨트롤러 안에서 구현하기보다, 기능별로 나눠 구현한 뒤 컨트롤러 안에 넣어주는데 이걸 프로바이더라고 함.

컨트롤러 안에 프로바이더를 넣는 걸 '주입한다' 라고 함.

보통 서비스, 레포지토리, 팩토리, 헬퍼 등이 있음.

• 서비스(service)
  • @Injectable 데코레이터로 감싸져서 제공됨. (프로바이더라서 컨트롤러에게 주입되기 때문.)
  • 서비스는 데이터 유효성 체크, DB 아이템 생성 등의 작업을 함.
  • 서비스를 사용하려면 주입시켜야 함.
  • 이 서비스 인스턴스는 애플리케이션 전체에서 사용될 수 있음.

• nest g service service_name
  nest g s s_name

• //주입
  
  @Controller()
  export class Controller {
  	constructor(private service: Service) {}	//private 접근제한자 사용하면 암묵적으로 클래스 프로퍼티로 선언됨
  }

 

미들웨어(middleware)

웹 개발에서 일반적으로 라우트 핸들러가 요청 처리하기 전에 수행하는 컴포넌트를 의미.

쿠키 파싱, 세션 관리, 인증/인가, 본문(http message body) 파싱 등을 보통 수행함.

 

예외 필터(exception filters)

예외 처리를 공통으로 처리하는 부분.

nestjs에서는 자체적으로 예외 레이러를 두고 있는데, 어플리케이션이 제대로 처리하지 못한 예외를 처리함.

즉, 작업하지 않은 예외를 기본으로 처리해주는 역할을 하는 기본 레이어가 있음.

이 외에 예외를 처리하고 싶거나, 처리할 범위를 지정하고 싶다면 예외 필터를 작성하면 됨.

 

파이프(pipes)

클래스에 @Injectable() 데코레이터를 달아 생성

data transformation(형식변환) 과 data validation(형식검사) 을 위해 사용됨. @Param이나 @Body 등의 인자로 전달.

파이프는 컨트롤러의 핸들러로 처리되기 전, 인수들을 형식변환 or 형식검사 함.

• Handler-level Pipes : 핸들러 레벨에서 @UsePipes 데코레이터를 이용해 사용. 핸들러 단위에서만 적용됨
• Parameter-level Pipes : 특정한 파라미터에만 적용
• Global Pipes : 애플리케이션 전체, 클라이언트의 모든 요청에 적용됨. main.ts에 app.useGlobalPipes() 로 적용함.

참고) Built-in Pipes : nestjs에서 기본적으로 만들어둔 파이프. 총 6가지(ValidationPipe, ParseIntPipe, ParseBoolPipe, ParseArrayPipe, ParseUUIDPipe, ParseValuePipe)

 

가드(gaurds)

인증은 요청자가 누구인지 증명, 인가는 인증 통과한 요청자가 이 기능을 사용할 자격이 있는지 확인함.

가드는 인가를 구현하는 가장 좋은 사례임.

인가를 미들웨어로 구현할 수 없는 이유 : 미들웨어는 실행 컨텍스트(ExecutionContext) 에 접근하지 못하기 때문에 자신의 일만 수행함. 반면 가드는 접근 가능하여, 다음에 실행될 작업을 알고 있음.

 

인터셉터(interceptors)

요청과 응답을 가로채서 변형을 가함.

라우트 핸들러가 요청/응답 처리하기 전에 로그를 남기고 싶다거나, 응답/요청단에서 발생한 예외를 잡아 변형을 가한다거나..

(ex-404 에러를 400 에러로 변형...)

 

 

nestjs 로직 흐름

요청 > 컨트롤러 > 서비스 > 응답

1. main.ts 에서 App Module 을 생성하고 실행함. 3000 port 에서 대기. app.module.ts 에는 컨트롤러와 서비스가 등록되어 있음.
2. 클라이언트가 endpoint(localhost:3000/) 로 request
3. endpoint 가 '/' 인 컨트롤러 호출
4. 컨트롤러에서 알맞은 경로로 라우팅하여 해당 핸들러로 가, 연결된 서비스를 호출 
5. 서비스가 response

즉, 컨트롤러가 라우터 역할을 하고, 비즈니스 로직은 서비스가 제공.