Nest.js에서 유효성 검사 및 오류 처리: 예외 필터의 중요성

애플리케이션 개발에서 유효성 검사와 오류 처리는 필수적인 요소입니다. 특히, 사용자 경험을 개선하고 시스템의 전반적인 품질을 높이기 위해서는 이러한 기능이 반드시 필요합니다. Nest.js는 이러한 요구를 충족시키기 위해 다양한 도구와 개념을 제공하며, 이 블로그 포스트에서는 유효성 검사 파이프와 예외 필터에 대해 깊이 있게 다뤄보겠습니다.

유효성 검사 파이프

유효성 검사 파이프는 클라이언트로부터 수신한 데이터가 예상된 형식과 규칙에 부합하는지를 확인하는 데 사용됩니다. 이를 통해 잘못된 데이터가 서버로 전달되는 것을 방지하고, 사용자에게 적절한 피드백을 제공할 수 있습니다. 이러한 과정은 애플리케이션의 신뢰성을 높이는 데 기여합니다.

기본 개념

• 유효성 검사란?
  • 유효성 검사는 입력 데이터를 검증하여 올바른 형식인지 확인하는 과정입니다. 이 과정은 데이터의 무결성을 보장하고, 잘못된 데이터로 인한 오류를 사전에 차단하는 데 중요한 역할을 합니다.
• Nest.js의 유효성 검사 도구
  • Nest.js에서는 class-validator 라이브러리를 활용하여 DTO(Data Transfer Object)를 정의하고, 해당 DTO를 기반으로 유효성을 검사합니다. 이를 통해 코드의 가독성과 유지보수성을 높일 수 있습니다.

실용 예시

import { IsString, IsInt } from 'class-validator';

export class CreateUserDto {
  @IsString()
  name: string;

  @IsInt()
  age: number;
}

// 컨트롤러에서 사용하는 방법
import { Body, Controller, Post } from '@nestjs/common';

@Controller('users')
export class UsersController {
  @Post()
  create(@Body() createUserDto: CreateUserDto) {
    return '사용자 생성 완료!';
  }
}

위의 예시에서 CreateUserDto 클래스는 사용자 이름과 나이에 대한 유효성을 정의하고 있습니다. 만약 클라이언트가 잘못된 형식의 데이터를 보낸다면, Nest.js는 자동으로 오류를 발생시키고 적절한 메시지를 반환하여 사용자에게 알림을 제공합니다. 이러한 유효성 검사는 애플리케이션의 신뢰성을 높이는 데 기여하며, 개발자는 보다 안전한 코드를 작성할 수 있습니다.

예외 필터

예외 필터는 애플리케이션 내에서 발생하는 모든 종류의 예외를 처리하기 위한 메커니즘입니다. 이는 개발자가 정의한 특정 로직에 따라 예외 상황에 대한 응답을 조정할 수 있게 해줍니다. 예외 필터를 통해 개발자는 애플리케이션의 오류 처리 방식을 세밀하게 제어할 수 있습니다.

기본 개념

• 예외 필터의 역할
  • 기본적으로 Nest.js에는 전역적으로 사용할 수 있는 기본적인 예외 필터가 포함되어 있지만, 필요에 따라 커스터마이즈 할 수도 있습니다. 이를 통해 특정 요구사항에 맞는 예외 처리 로직을 구현할 수 있습니다.

실용 예시

import { ExceptionFilter, Catch, ArgumentsHost, HttpException } from '@nestjs/common';
import { 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 status = exception.getStatus();

    response.status(status).json({
      statusCode: status,
      timestamp: new Date().toISOString(),
      path: ctx.getRequest().url,
      message: exception.message,
    });
  }
}

// main.ts 파일에서 등록하는 방법
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { HttpExceptionFilter } from './http-exception.filter';

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

위의 코드에서는 HttpExceptionFilter라는 커스텀 필터를 만들어 HTTP 관련 예외를 처리하도록 설정하였습니다. 이렇게 하면 모든 HTTP 요청에서 발생하는 에러에 대해 일관된 방식으로 응답할 수 있게 되며, 사용자에게 보다 명확한 정보를 제공할 수 있습니다. 이러한 예외 필터는 애플리케이션의 안정성을 높이고, 사용자 경험을 개선하는 데 중요한 역할을 합니다.

결론

Nest.js에서 유효성 검사 및 오류 처리는 애플리케이션의 품질 향상과 사용자 경험 개선에 매우 중요합니다. 위에서 설명한 유효성 검사 파이프와 예외 필터를 활용하면 보다 안전하고 견고한 웹 애플리케이션을 구축할 수 있습니다. 이러한 기능들은 개발자가 보다 효율적으로 애플리케이션을 관리하고, 사용자에게 신뢰할 수 있는 서비스를 제공하는 데 기여합니다.