스프링 @ExceptionHandler 어노테이션

스프링 프레임워크(Spring Framework)는 웹 애플리케이션 개발을 위한 다양한 기능과 기능을 제공합니다. 이 중에서도 예외 처리는 모든 웹 애플리케이션에서 중요한 요소입니다. 스프링은 예외 처리를 효율적으로 관리하기 위해 @ExceptionHandler 어노테이션을 제공합니다. @ExceptionHandler 어노테이션에 대해 자세히 알아보고, 그 사용법과 장점에 대해 살펴보겠습니다.

 

 

@ExceptionHandler 어노테이션 소개

@ExceptionHandler 어노테이션은 스프링 컨트롤러에서 특정 예외를 처리하기 위해 사용됩니다. 이 어노테이션은 특정 예외가 발생했을 때 해당 예외를 처리하는 메서드를 정의하는 데 사용됩니다. 이를 통해 개발자는 예외에 대한 세부적인 처리 로직을 구현할 수 있습니다.

 

 

@ExceptionHandler 어노테이션의 사용법

@ExceptionHandler 어노테이션은 다음과 같이 사용됩니다.

 

@Controller
public class MyController {
    
    @ExceptionHandler(MyException.class)
    public ResponseEntity<String> handleMyException(MyException ex) {
        // 예외 처리 로직
        return new ResponseEntity<>("Custom Error Message", HttpStatus.INTERNAL_SERVER_ERROR);
    }
    
    // ...
}

 

위의 예제에서 handleMyException 메서드는 @ExceptionHandler 어노테이션으로 표시되어 있습니다. 이 메서드는 MyException 예외가 발생했을 때 호출되어 예외 처리를 수행하고, ResponseEntity 객체를 반환합니다. 이를 통해 클라이언트에게 적절한 응답을 전송할 수 있습니다.

 

 

@ExceptionHandler 어노테이션의 장점

@ExceptionHandler 어노테이션을 사용하는 것의 장점은 다음과 같습니다.

 

특정 예외에 대한 처리: @ExceptionHandler 어노테이션을 사용하면 특정 예외에 대한 개별적인 처리 로직을 구현할 수 있습니다. 이는 예외에 대한 세부적인 응답을 제공하거나, 로깅을 수행하거나, 다른 작업을 수행할 수 있게 합니다.

 

코드 중복 최소화: @ExceptionHandler 어노테이션을 사용하면 예외 처리 로직을 컨트롤러 외부에 분리할 수 있습니다. 이는 코드의 중복을 줄이고 유지보수성을 향상시킵니다.

 

커스텀 응답 처리: @ExceptionHandler 어노테이션을 사용하면 예외 발생 시 클라이언트에게 커스텀 응답을 전송할 수 있습니다. 이는 클라이언트에게 더욱 명확하고 유용한 에러 메시지를 제공할 수 있게 합니다.

 

 

예제를 통한 설명

다음은 @ExceptionHandler 어노테이션을 사용하여 예외 처리를 구현하는 예제입니다.

 

@Controller
public class MyController {
    
    @ExceptionHandler(UserNotFoundException.class)
    public ResponseEntity<String> handleUserNotFoundException(UserNotFoundException ex) {
        // 사용자를 찾을 수 없는 예외 처리 로직
        return new ResponseEntity<>("User Not Found", HttpStatus.NOT_FOUND);
    }
    
    @ExceptionHandler(InvalidRequestException.class)
    public ResponseEntity<String> handleInvalidRequestException(InvalidRequestException ex) {
        // 잘못된 요청 예외 처리 로직
        return new ResponseEntity<>("Invalid Request", HttpStatus.BAD_REQUEST);
    }
    
    // ...
}

 

위의 예제에서 handleUserNotFoundException 메서드와 handleInvalidRequestException 메서드는 각각 UserNotFoundException과 InvalidRequestException에 대한 처리를 정의합니다. 이처럼 @ExceptionHandler 어노테이션을 사용하면 각 예외에 대한 개별적인 처리 로직을 구현할 수 있습니다.

 

 

결론

@ExceptionHandler 어노테이션은 스프링 애플리케이션에서 예외 처리를 효율적으로 구현하기 위한 강력한 기능을 제공합니다. 이를 통해 개발자는 특정 예외에 대한 세부적인 처리 로직을 구현하고, 코드의 중복을 최소화하며, 클라이언트에게 커스텀 응답을 전송할 수 있습니다. 예제를 통해 @ExceptionHandler 어노테이션의 사용법과 장점을 살펴보았습니다. 이를 통해 스프링 애플리케이션에서 예외 처리를 효율적으로 구현할 수 있습니다.

 

스프링 @ControllerAdvice 어노테이션