@ControllerAdvice 는 어떻게 동작하는 것일까?

📌 예외 처리 방식

 

프로젝트를 진행하면서, 내가 주로 했던 예외처리 방법은 다음과 같다.

 

Enum 타입의 ErrorCode 정의

@AllArgsConstructor
@Getter
public enum ErrorCode {

    DUPLICATE_USERNAME(HttpStatus.CONFLICT, "이미 존재하는 사용자명 입니다.");

    private HttpStatus httpStatus;
    private String message;
}

Http 상태 코드와 에러 발생 시 전달할 메세지 정보가 담긴 Enum 타입의 ErrorCode 를 정의한다.

 

RuntimeException 을 상속하는 AppException을 정의

@Getter
public class AppException extends RuntimeException{
    private ErrorCode errorCode;

    public AppException(ErrorCode errorCode) {
        this.errorCode = errorCode;
    }

}

ErrorCode를 통해 예외 원인 정보를 담고 있다.

 

AppException을 처리하는 Handler 정의

@RestControllerAdvice
public class ExceptionManager {

    @ExceptionHandler(AppException.class)
    public ResponseEntity<?> appExceptionHandler(AppException e) {

        return ResponseEntity.status(e.getErrorCode().getHttpStatus())
                .body(e.getErrorCode().getMessage());

    }

}

 

위와 같이 정의하면, 런타임 시 AppException이 발생하면 appExceptionHandler 메서드가 동작한다.

 

❓ 이렇게 예외 처리를 진행했었는데, 어떤 원리로 이루어지는지 정확히 모르고 사용한 것 같아 찾아보기로 결정하였다.

 

---

📌 어노테이션 설명

 

@RestControllerAdvice

@RestControllerAdvice는 @ControllerAdvice와 @ResponseBody로 구성되어있다.

 

@ControllerAdvice는 전역적으로 컨트롤러에 영향을 미치는 역할을 한다.

 

경로를 따로 지정하지 않으면, 프로젝트의 모든 패키지에 있으면서 @Controller 어노테이션이 있는 클래스에서 발생하는 예외상황을 잡을 수 있다.

 

그리고 @ControllerAdvice가 적용된 클래스에는 @ExceptionHandler를 적용한 메서드를 정의하고 처리할 예외를 명시해주면, 발생된 예외와 일치하는 메서드가 실행된다.

 

💡 보통 컨트롤러 단에서 서비스 단을 호출하고, 서비스 단에서 문제가 있는 경우 RuntimeException 예외를 던진다.

결국은 서비스 단은 호출한 컨트롤러에 예외를 전달하고, 결국에 컨트롤러에서 예외가 발생하므로 @ControllerAdvice에 의해 감지되는 것이다.

 

---

 

@ExceptionHandler

 

정의한 ExceptionManager 클래스에서 @ExceptionHandler(AppException.class) 와 같이 사용했다.

 

위에서 설명했듯, AppException이 컨트롤러에서 감지되면, @ExceptionHandler(AppException.class)가 적용된 메서드 로직이 실행되는 것이다.

 

 

---

흐름

출처 : https://velog.io/@hanblueblue/Spring-ExceptionHandler

잘 정리되어 있는 그림을 발견했다.

 

위와 같은 방식으로, 해당 프로젝트 내에 있는 컨트롤러에서 발생한 예외를 어노테이션을 통해서 특정 메서드를 실행시키도록 함으로서 하나의 클래스로 관리할 수 있게 되는 것이다.

 

 

---

📌 DispatcherServlet 을 파해쳐보자

 

Dispatcher Servlet은 어떻게 동작할까?

 

DispatcherServlet | doDispatch()

 

클라이언트의 요청을 받아 컨트롤러의 메서드를 실행하는 역할은 DispatcherServlet이 담당한다.

 

protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
    ...
    try {
		...
        try {
			...
            mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
			...
        }
        catch (Exception ex) {
            dispatchException = ex;
        }
        catch (Throwable err) {
            dispatchException = new ServletException("Handler dispatch failed: " + err, err);
        }
        processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
    }
    ...
}

doDispatch() 메서드를 실행하면

 

클라이언트의 요청을 처리할 수 있는 컨트롤러를 찾고, 핸들러를 실행할 어뎁터를 찾아 컨트롤러의 메서드를 실행한 뒤 

 

ModelAndView 라는 객체에 결과를 보관하고

 

processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException) 메서드를 실행한다.

 

그렇다면, 컨트롤러의 메서드를 실행하는 부분인 

 

mv = ha.handle(processedRequest, response, mappedHandler.getHandler()) 부분에서 예외가 발생하면

 

try-catch 문에 의해 dispatchException = ex 가 할당되어 processDispatchResult() 문이 실행될 것으로 예측된다.

 

 

DispatcherServlet | processDispatchResult()

private void processDispatchResult(HttpServletRequest request, HttpServletResponse response,
			@Nullable HandlerExecutionChain mappedHandler, @Nullable ModelAndView mv,
			@Nullable Exception exception) throws Exception {

		boolean errorView = false;

		if (exception != null) {
			if (exception instanceof ModelAndViewDefiningException mavDefiningException) {
				logger.debug("ModelAndViewDefiningException encountered", exception);
				mv = mavDefiningException.getModelAndView();
			}
			else {
				Object handler = (mappedHandler != null ? mappedHandler.getHandler() : null);
				mv = processHandlerException(request, response, handler, exception);
				errorView = (mv != null);
			}
		}
		...
	}

 

메서드를 확인해보니, 예외 상황이 발생하면 exception != null 이므로 조건문 안의 로직이 실행될 것이다.

 

여기서 발생한 exception이 ModelAndViewDefiningException 에 속하는 경우와 아닌 경우로 나누어지는데

 

ModelAndViewDefiningException 는 Exception 클래스의 하위 클래스로, 예외 상황을 클라이언트에게 화면 템플릿으로서 보여주는 역할을 한다.

 

우리가 정의한 커스텀 예외는 RuntimeException 을 상속하여 정의했으므로 이 조건문에 해당하지 않을 것이다.

 

따라서 mv = processHandlerException(request, response, handler, exception) 메서드가 실행될 것이다.

 

DispatcherServlet | processHandlerException()

@Nullable
protected ModelAndView processHandlerException(HttpServletRequest request, HttpServletResponse response,
                                               @Nullable Object handler, Exception ex) throws Exception {

	...
    if (this.handlerExceptionResolvers != null) {
        for (HandlerExceptionResolver resolver : this.handlerExceptionResolvers) {
            exMv = resolver.resolveException(request, response, handler, ex);
            if (exMv != null) {
                break;
            }
        }
    }
	...
}

 

여기서 HandlerExceptionResolver 인터페이스의 resolveException 메서드로 에러가 처리됨을 알 수 있다.

 

AbstractHandlerExceptionResolver | resolveException()

@Override
@Nullable
public ModelAndView resolveException(
        HttpServletRequest request, HttpServletResponse response, @Nullable Object handler, Exception ex) {

    if (shouldApplyTo(request, handler)) {
        prepareResponse(ex, response);
        ModelAndView result = doResolveException(request, response, handler, ex);
        
     	...
        
        return result;
    }
    else {
        return null;
    }
}

 

결과적으로 HandlerExceptionResolver의 구현체 중 하나인 AbstractHandlerExceptionResolver의 resolveException() 을 호출하고

 

해당 클래스에서는 추상메서드로 정의되어있는, 템플릿 메서드 패턴으로 적용된 doResolveException()을 호출한다.

 

그러면 AbstractHandlerExceptionResolver 클래스를 상속받는 AbstractHandlerMethodExceptionResolver 클래스의

 

doResolveException()을 호출한다.

 

AbstractHandlerMethodExceptionResolver | doResolveException()

 

@Override
@Nullable
protected final ModelAndView doResolveException(
        HttpServletRequest request, HttpServletResponse response, @Nullable Object handler, Exception ex) {

    HandlerMethod handlerMethod = (handler instanceof HandlerMethod hm ? hm : null);
    return doResolveHandlerMethodException(request, response, handlerMethod, ex);
}

AbstractHandlerMethodExceptionResolver 클래스 역시, 템플릿 메서드 패턴 형식으로 하위 클래스인

 

ExceptionHandlerExceptionResolver 의 doResolveHandlerMethodException() 메서드를 호출한다.

 

 

ExceptionHandlerExceptionResolver | doResolveHandlerMethodException()

@Override
@Nullable
protected ModelAndView doResolveHandlerMethodException(HttpServletRequest request,
                                                       HttpServletResponse response, @Nullable HandlerMethod handlerMethod, Exception exception) {

    ServletInvocableHandlerMethod exceptionHandlerMethod = getExceptionHandlerMethod(handlerMethod, exception);
   ...
    try {
       ...
        exceptionHandlerMethod.invokeAndHandle(webRequest, mavContainer, arguments);
    }
    catch (Throwable invocationEx) {
      ...
    }
    ...
}

그러면 이 메서드에서 getExceptionHandlerMethod() 메서드를 호출한다.

 

getExceptionHandlerMethod() 메서드가 정말 핵심 부분이다.

 

ExceptionHandlerExceptionResolver | getExceptionHandlerMethod()

@Nullable
protected ServletInvocableHandlerMethod getExceptionHandlerMethod(
        @Nullable HandlerMethod handlerMethod, Exception exception) {

	...
    
    for (Map.Entry<ControllerAdviceBean, ExceptionHandlerMethodResolver> entry : this.exceptionHandlerAdviceCache.entrySet()) {
        ControllerAdviceBean advice = entry.getKey();
        if (advice.isApplicableToBeanType(handlerType)) {
            ExceptionHandlerMethodResolver resolver = entry.getValue();
            Method method = resolver.resolveMethod(exception);
            if (method != null) {
                return new ServletInvocableHandlerMethod(advice.resolveBean(), method, this.applicationContext);
            }
        }
    }

    return null;
}

 

등록된 모든 ControllerAdvice 빈을 검사하고 우리가 doDispatch() 에서부터 전달했던 exception을 바탕으로 처리할 수 있는 @ExceptionHandler 어노테이션과 옵션으로 정의한 예외를 처리할 수 있는 메서드를 찾아온다.

 

그렇게 찾아온 ExceptionHandler로 exceptionHandlerMethod.invokeAndHandle(webRequest, mavContainer, arguments) 메서드를 통해 Reflection API 를 통해 구현 메서드를 호출하여 예외처리를 하게 된다.

 

 

---

참고한 블로그 : https://mangkyu.tistory.com/24