[NestJS] 6. Exception filters

기본적인 필터 선언 방법

import { ExceptionFilter, Catch, ArgumentsHost, HttpException } from '@nestjs/common';
import { Request, Response } from 'express';

@Catch(HttpException)
export class HttpExceptionFilter implements ExceptionFilter {
  catch(exception: HttpException, host: ArgumentsHost) {
    const ctx = host.switchToHttp();
    const response = ctx.getResponse<Response>();
    const request = ctx.getRequest<Request>();
    const status = exception.getStatus();

    response
      .status(status)
      .json({
        statusCode: status,
        timestamp: new Date().toISOString(),
        path: request.url,
      });
  }
}

Catch 데코레이터에 아무것도 안넣으면 전체 Exception을 잡는다
error
- 만약에 response를 사용하는 코드 쪽에서 IDE가 에러를 뱉어낸다면 Response와 Request를 임포트 했는지 확인해보세요. 그리고 ‘express’에서 임포트를 안했으면 에러가 납니다.

바인딩 방법

controller에 붙이는 방법

@Post()
@UseFilters(new HttpExceptionFilter())
// @UseFilters(HttpExceptionFilter)
async create(@Body() createCatDto: CreateCatDto) {
  throw new ForbiddenException();
}

💡힌트

가능한 경우 인스턴스 대신 클래스를 사용하여 필터를 적용하는 것이 좋습니다. Nest는 전체 모듈에서 동일한 클래스의 인스턴스를 쉽게 재사용할 수 있으므로 메모리 사용량이 줄어듭니다.

전역 설정

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

💡useGlobalFilters()방법은 게이트웨이 또는 하이브리드 애플리케이션에 대한 필터를 설정하지 않습니다.

모듈 설정

import { Module } from '@nestjs/common';
import { APP_FILTER } from '@nestjs/core';

@Module({
  providers: [
    {
      provide: APP_FILTER,
      useClass: HttpExceptionFilter,
    },
  ],
})
export class AppModule {}

참고 사이트

https://docs.nestjs.com/exception-filters

목차

태그

기본적인 필터 선언 방법

바인딩 방법