API 예외 처리 - @ControllerAdvice

 

 

 

지난글

https://mong-dev.tistory.com/44

API 예외 처리 - HandlerExceptionResolver(2) : ResponseStatusExceptionResolver, DefaultHandlerExceptionResolver, ExceptionHan

 

 

@ControllerAdvice

---

이전 글에서 드디어 @ExceptionHandler 를 사용해서 예외를 깔끔하게 처리할 수 있게 되었지만, 정상 코드와 예외 처리 코드가 하나의 컨트롤러에 섞여 있었다. @ControllerAdvice 또는 @RestControllerAdvice 를 사용하면 둘을 분리할 수 있다.

참고로 @RestControllerAdvice 는 @ControllerAdvice + @Responsebody 라고 생각하면 된다.

 

이전 글에 작성했던 예외처리부분들을 ExControllerAdvice 클래스로 따로 분리를 시켜보자.

Slf4j
@RestControllerAdvice(basePackages = "hello.exception.api")
public class ExControllerAdvice {

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(IllegalArgumentException.class)
    public ErrorResult illegalExHandler(IllegalArgumentException e) {
        log.error("[exceptionHandler] ex", e);
        return new ErrorResult("BAD", e.getMessage());
    }

    @ExceptionHandler
    public ResponseEntity<ErrorResult> userExHandler(UserException e) {
        log.error("[exceptionHandler] ex", e);
        ErrorResult errorResult = new ErrorResult("USER-EX", e.getMessage());
        return new ResponseEntity(errorResult, HttpStatus.BAD_REQUEST);
    }

    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ExceptionHandler
    public ErrorResult exHandler(Exception e) {
        log.error("[exceptionHandler] ex", e);
        return new ErrorResult("EX", "내부 오류");
    }

}

 

이렇게 옮겨서 다시 실행을 해보면, 결과값은 이전과 동일하게 뜨는 것을 알 수 있다.

결국 이 클래스 하나에 예외처리를 모아서 처리할 수 있게 되었다. 사용방법은 상당히 간단했다. 

 

 

정리

- @ControllerAdvice는 대상으로 지정한 여러 컨트롤러에 @ExceptionHandler, @InitBinder기능을 부여해주는 역할을 한다.
- @ControllerAdvice 에 대상을 지정하지 않으면 모든 컨트롤러에 적용된다. (글로벌 적용)
- @RestControllerAdvice 는  @ControllerAdvice 와 같고, @ResponseBody 가 추가되어 있다. 
  (@Controller ,@RestController 의 차이와 같다.)

 

마지막으로 대상 컨트롤러를 지정하고 싶은 경우에 방법을 알아보자.

(스프링 공식문서 참고 : https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-ann- controller-advice)

// Target all Controllers annotated with @RestController
@ControllerAdvice(annotations = RestController.class)
public class ExampleAdvice1 {}
      
// Target all Controllers within specific packages
@ControllerAdvice("org.example.controllers")
public class ExampleAdvice2 {}
    
// Target all Controllers assignable to specific classes
@ControllerAdvice(assignableTypes={ControllerInterface.class, AbstractController.class})
public class ExampleAdvice3 {}

스프링 공식 문서 예제에서 보는 것 처럼 특정 애노테이션이 있는 컨트롤러를 지정할 수 있고, 특정 패키지를 직접 지정할 수도 있다. 패키지 지정의 경우 해당 패키지와 그 하위에 있는 컨트롤러가 대상이 된다. 그리고 특정 클래스를 지정할 수도 있다. 대상 컨트롤러 지정을 생략하면 모든 컨트롤러에 적용된다.

 

이제 @ExceptionHandler 와 @ControllerAdvice 를 조합하면 예외를 깔끔하게 해결할 수 있다.

그럼 이제 얼른 프로젝트 코드 리팩토링하러 가야겠다.... :)