스프링 MVC 2 - @ControllerAdvice

API 예외 처리 - @ControllerAdvice

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

먼저 ApiExceptionV2Controller코드에 있는 @ExceptionHandler모두 제거

ExControllerAdvice

@Slf4j
@RestControllerAdvice
public class ExControllerAdvice {
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(IllegalArgumentException.class)
    public ErrorResult illegalExHandle(IllegalArgumentException e) {
        log.error("[exceptionHandle] ex", e);
        return new ErrorResult("BAD", e.getMessage());
    }

    @ExceptionHandler
    public ResponseEntity<ErrorResult> userExHandle(UserException e) {
        log.error("[exceptionHandle] 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 exHandle(Exception e) {
        log.error("[exceptionHandle] ex", e);
        return new ErrorResult("EX", "내부 오류");
    }
}

@ControllerAdvice

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

대상 컨트롤러 지정 방법

// Target all Controllers annotated with @RestController
// @RestController가 있는 컨트롤러에만 적용된다.
// @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 {

}

• 참고 : https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-ann-controller-advice

• 특정 애노테이션이 있는 컨트롤러를 지정할 수 있다.

• 특정 패키지를 직접 지정할 수도 있다.

  • 패키지 지정의 경우 해당 패키지와 그 하위에 있는 컨트롤러가 대상이 된다.

• 특정 클래스를 지정할 수도 있다.

• 대상 컨트롤러 지정을 생략하면 모든 컨트롤러에 적용된다.

일반적으로 패키지 지정을 사용한다.

출처 : 인프런 김영한 지식공유자님 강의 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술