[Spring] @ControllerAdvice와 @ExceptionHandler

 

🤔 0. 기존의 Exception을 핸들링 하는 방법

 

 Java Application을 개발하면서, 많은 Exception을 마주하게 됩니다. 이러한 Exception을 다루는 방법으로는 대부분 아시다시피 try-catch 문이 있습니다. try 구문 내부에서 Exception이 발생할 가능성이 있는 문장을 실행하고, 해당 try문에서 발생할 수 있는 여러 Exception에 대해 여러개의 catch 문을 붙여 핸들링 할 수 있었습니다.

 

물론, Exception을 핸들링하기 좋은 방법이지만, SpringBoot에서 개발하면서 몇 가지 불편한 점을 발견할 수 있었습니다.

예외 처리 로직을 따로 분리할 수 없고, 항상 try-catch 블록으로 묶어서 개발해야 합니다. 정확한 비즈니스 로직을 파악하려면, 이러한 예외 상황에 대한 로직은 따로 분리되어 있어야 좀 더 개선될 것으로 보입니다. 또한 try-catch 블록을 자주 사용하면 가독성의 문제도 발생할 수 있겠죠. 또 예외 처리의 로직이 변경되는 상황에도, 해당 예외 처리 로직이 따로 분리되어 있지 않아, 모든 메서드의 try-catch문의 예외 처리 부분을 수정해야 할 가능성이 생길 수 있습니다.

 

이러한 문제를 해결하기 위해서, Spring에서는 @ExceptionHandler와 @ControllerAdvice를 제공합니다.

 

 

🤔 1. @ExceptionHandler

 

@ExceptionHandler 어노테이션은 이름에서도 알 수 있듯이 어노테이션이 달려있는 부분에 대해 Exception이 발생하게 되면, 핸들링을 할 수 있습니다.

이러한 @ExceptionHandler가 작동하는 범위는 @Controller와 @RestController가 달려있는 빈 객체에 한해서 작동합니다. 즉, @Service나 @Repository가 적용된 빈 위에서는 작동할 수 없습니다.

 

컨트롤러에 특정 Exception에 대해 핸들링할 수 있는 메서드를 만들고, 이 위에 @ExceptionHandler를 설정하는 것으로 사용할 수 있습니다.

 

@Controller
public class Controller {

    // ...

    @ExceptionHandler(value = RuntimeException.class)
    public ResponseEntity<String> handle(IOException ex) {
        // ...
    }
}

 

이런 식으로 사용하게 되면, Controller 레벨에서 발생한 RuntimeException에 대해 해당 ExceptionHandler 어노테이션이 붙어있는 메소드가 해당 Exception을 처리하게 됩니다.

 

물론, 단일 예외 처리가 아니라, 여러가지 Exception을 한 메서드가 다루도록 지시할 수도 있습니다.

@Controller
public class Controller {

    // ...

    @ExceptionHandler(value = {IOException.class, NullPointerException.class})
    public ResponseEntity<String> handle(Exception ex) {
        // ...
    }
}

 

위와 같은 코드로 작성을 하게 되면, Controller 클래스에서 발생한 IOException과 NullPointerException에 대해 해당 handle 함수가 catch해서 값을 처리하게 됩니다.

 

공통적으로 발생하는 Exception에 대해서 Exception 핸들러를 통해서 처리를 하게 되면, 코드의 가독성을 높일 뿐만 아니라, 각 예외 처리를 여러번 작성하지 않아도 한 핸들링 메서드에서 다룰 수 있으므로 생산성이 더욱 늘어나게 됩니다.

 

 

🤔 2. @ControllerAdvice

 

좀 더 확장해보겠습니다. 하나의 컨트롤러가 아닌, 전역적으로 여러 컨트롤러에 대해서 Exception을 다루고 싶다면 @ControllerAdvice를 사용하면 됩니다.

 

모든 Controller에 대해서 특정 Exception을 한 번에 제어하려면, 새로운 관리 컨트롤러를 생성하고 @ControllerAdvice 어노테이션을 붙여줍니다.

 

@ControllerAdvice
public class ControllerAdvice{
	// ..
}

 

이런식으로 새로운 ControllerAdvice 클래스를 생성하고 어노테이션을 붙혀준다면, 모든 Controller에서 발생하는 Exception에 대해 전역적으로 관리할 수 있게 됩니다.

 

이 ControllerAdvice까지 Exception이 전달되었다면, 이 전달된 Exception에 대해 핸들링 할 메소드가 필요합니다.

그러한 메소드는, 위에서 설명한 @ExceptionHandler를 통해 관리하면 됩니다.

 

@RestContollerAdvice
public class ControllerAdvice{
	
    @ExceptionHandler(value = NullPointerException.class)
    public ResponseEntity<String> handle(Exception ex){
		// ...
	}
}

 

위와 같은 형식으로 작성하면 모든 컨트롤러에 대해서 NullPointerException이 발생하게 된다면, 해당 클래스의 handle 함수로 전달되고, 해당 handle 메소드의 로직에 따라서 처리될 수 있습니다.

 

@ContollerAdvice외에도 @RestControllerAdvice가 있는데, 이것은 @Controller와 @RestController의 차이와 유사합니다.

@RestControllerAdvice에는 @ResponseBody 어노테이션이 포함되어 자바객체를 HTTP 요청의 바디내용으로 매핑하여 클라이언트로 전송하게 됩니다.

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@ControllerAdvice
@ResponseBody
public @interface RestControllerAdvice {
	// ...
}

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface ControllerAdvice {
	// ...
}