NestJS의 구조

Controller (Router), Service, Repository, Middleware, Interceptor, Pipe, Filter, Entity, Dto 등 NestJS의 구조를 이루는 각종 Layer에 대해서 학습하세요. 미리 학습해두면 추후 코드를 작성할 때 이해도가 높아져 있을 겁니다. 읽어도 이해가 가지 않는 부분은 추후 질문해주세요.

_Originally posted by @kakasoo in https://github.com/rimo030/Repo-Server/pull/1#discussion_r1377334130_

🔧Controller

사용자의 요청(request)을 처리하고, 응답(response)을 반환하는 역할

@Controller() 
export class ... {
 }

controller가 없어도 서버를 구축할 수 있지만, 유지보수의 편의를 위해 제어자를 둔다
MVC 패턴에서 자주 사용되는 개념

Routing

역할을 수행하기 위해 경로를 지정하는 것

@Controller(경로명) 
export class ... {
}

HTTP 요청 메소드 데코레이터를 사용해 HTTP 요청에 대한 특정 엔트 포인트도 설정 가능

🔧Providers

어플리케이션이 제공하는 서비스 기능을 구현하고 수행하는 역할을 맡는 것 service, repository, factory, helper 등 여러가지 형태로 구현

Providers 없이 Controller에서 로직을 구현할 수는 있지만 유지보수의 편의를 위해 분리
MVC 패턴의 Model의는 개념
Providers는 의존성 주입(DI: Dependency Injection)을 할 수 있다

의존성 주입

@Injectable()  # 싱글턴(Singleton) 객체로 메모리에 존재
export class ... {
}

@Controller('...')  # 생성자 기반 의존성 주입
export class ...{
    constructor(private readonly service: Service) {}

🔧Modules

서로 유사한 서비스 혹은 기능들끼리 모듈들로 묶인 코드 덩어리

@Module({
    imports: [module, ...],
    controllers: [controller, ...],
    providers: [provider, ...],
    exports: [provider, ...]
})
export class AppModule {}

app.module.ts에서 각 기능 모듈을 import 함으로 관리
모든 모듈은 공유 모듈(Shared modules)이기 exports에 명시해 다른 모듈과 인스턴스 공유 가능
모듈 클래스는 providers 주입 가능 ( @Injectable() + providers에 명시)

전역모듈

@Global() # imports 설정 필요 X

🔧Pipe

data transformation과 data validation를 위해서 사용

data transformation : 입력 데이터를 원하는 형식으로 변환하는 것.
data validation : 입력 데이터를 평가. 유효한 경우 전달, 그렇지 않으면 예외를 발생

Built-in pipes

ParseIntPipe
ParseFloatPipe
ParseBoolPipe
ParseArrayPipe
ParseUUIDPipe
ParseEnumPipe
DefaultValuePipe
ParseFilePipe

Custom pipes

import { PipeTransform, Injectable, ArgumentMetadata } from '@nestjs/common';

@Injectable()
export class ... implements PipeTransform {
  transform(value: any, metadata: ArgumentMetadata) {
    return value;
  }
}

🕹️Entity

애플리케이션에서 비즈니스 객체 또는 모델을 나타내는 클래스

@Entity()

데이터베이스 테이블에 매핑되는 클래스

🕹️DTO(Data Transfer Object)

프로세스 간에 데이터를 전달하는 객체

주로 클라이언트와 서버가 데이터를 주고받을 때 사용
데이터 교환을 단순화하고 네트워크 오버헤드를 줄이는데 자주 사용

🕹️Repository Pattern

Service Layer- Repository Layer-Data Source Layer

Repository Layer에서만 DB source에 접근이 가능
각 서비스가 비즈니스 로직에 집중할 수 있도록 함

Middleware

기본적으로 Express 미들웨어와 동일

Interceptor

Filter

아래 블로그 시리즈가 이해에 도움이 되어 남깁니다! https://tristy.tistory.com/38?category=993422

rimo030 / nestjs-e-commerce-frame

NestJS 구조정리 #6