[Nest.js] Controller(1)

📖 공식문서를 참고하여 Controller 정리하기(1)

---

Controller

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

컨트롤러의 목적은 애플리케이션에 대한 특정 요청을 수신하는 것이며 라이팅 메커니즘은 어떤 컨트롤러가 어떤 요청을 수신할지 제어한다. 각 컨트롤러에는 둘 이상의 경로가 있는 경우가 많으며, 경로마다 다른 작업을 수행할 수 있다.

기본 컨트롤러를 생성하기 위해 클래스와 데코레이터를 사용한다. 데코레이터는 클래스를 필수 메타데이터와 연결하고 Nest가 라우팅 맵을 생성할 수 있도록 한다. (요청을 해당 컨트롤러에 연결)

---

Routing

• controller() 데코레이터에 'cats'를 사용하면 prefix로 붙일 수 있으며 'cats'를 쉽게 그룹화하고 반복되는 코드를 최소화할 수 있다.
• @Get() HTTP 요청 메서드 데코레이터를 사용하면 Nest가 HTTP 요청에 대한 특정 엔드포인트에 대한 핸들러를 생성하도록 지시할 수 있다.

import { Controller, Get } from '@nestjs/common';

@Controller('cats')
export class CatsController {
  @Get()
  findAll(): string {
    return 'This action returns all cats';
  }
}

CLI를 사용하여 컨트롤러를 생성하려면 아래 명령어를 실행하면 된다.

yarn g controller cats

---

Request object

• nest는 기본 플랫폼(Express)의 요청 객체에 대한 액세스를 제공하며 @Req() 데코레이터를 추가하여 nest 요청 객체에 액세스할 수 있다.

import { Controller, Get, Req } from '@nestjs/common';
import { Request } from 'express';

@Controller('cats')
export class CatsController {
  @Get()
  findAll(@Req() request: Request): string {
    return 'This action returns all cats';
  }
}

일반적으로는 NestJS에서 제공하는 @Body(), @Query() 데코레이터를 사용하면 되지만 아래와 같은 Decorator들을 자유롭게 사용할 수 있습니다.

데코레이터	사용
@Request(), @Req()	req
@Response(), @Res()*	res
@Next()	next
@Session()	req.session
@Param(key?: string)	req.params / req.params[key]
@Body(key?: string)	req.body / req.body[key]
@Query(key?: string)	req.query / req.query[key]
@Headers(name?: string)	req.headers / req.headers[name]
@Ip()	req.ip
@HostParam()	req.hosts

여기를 참고하면 커스텀 데코레이터를 만들 수 있다.

---

Status code

• 응답 상태 코드는 201인 POST 요청을 제외하고는 기본 값은 200이며 @HttpCode(...) 데코레이터를 선언하여 변경할 수 있다.

@Post()
@HttpCode(204)
create() {
  return 'This action adds a new cat';
}

---

Header

• 사용자 지정 응답 헤더를 지정하려면 @Header() 데코레이터 또는 라이브러리별 응답 객체를 사용하거나 res.header()를 호출하면 된다.

@Post()
@Header('Cache-Control', 'none')
create() {
  return 'This action adds a new cat';
}

---

참고 자료

• https://docs.nestjs.com/controllers#controllers
• https://tew_books.gitlab.io/nestjs_tutorial/2-controller.html