스프링 MVC - API 예외 처리

스프링 부트 기본 오류 처리 

 BasicErrorControlelr 코드

@RequestMapping(produces = MediaType.TEXT_HTML_VALUE)
public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) {}

@RequestMapping
public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {}

 

/error 동일한 경로를 처리하는 errorHtml(), error() 두 메서드를 확인할 수 있다.  

•  errorHtml() : produces = MediaType.TEXT_HTML_VALUE : 클라이언트 요청의 Accept 헤더 값이 text/html인 경우에는 errorHtml()을 호출해서 view를 제공한다.
• error() : 그외 경우에 호출되고 ResponseEntity로 HTTP Body에 JSON 데이터를 반환한다.

 

---

HandlerExceptionResolver 

스프링 MVC는 컨트롤러(핸들러) 밖으로 예외가 던져진 경우 예외를 해결하고, 동작을 새로 정의할 수 있는 방법을 제공한다. 컨트롤러 밖으로 던져진 예외를 해결하고, 동작 방식을 변경하고 싶으면 HandlerExceptionResolver를 사용하면된다. 줄여서 ExceptionResolver라 한다.  

 

 

참고 : ExceptionResolver로 예외를 해결해도 postHandle()은 호출되지 않는다. 

 

 

 

HandlerExceptionResolver 인터페이스

public interface HandlerExceptionResolver {
	ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, 
			Object handler, Exception ex);
}

• handler : 핸들러(컨트롤러) 정보
• Exception ex : 핸들러(컨트롤러)에서 발생한 예외

HandlerExceptionResolver 인터페이스 구현

@Slf4j
public class MyHandlerExceptionResolver implements HandlerExceptionResolver {
	@Override
	public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
		try {
        	    if (ex instanceof IllegalArgumentException) {
			  log.info("IllegalArgumentException resolver to 400");
			  response.sendError(HttpServletResponse.SC_BAD_REQUEST, ex.getMessage());
			  return new ModelAndView();
		   }
       		} catch (IOException e) {
			   log.error("resolver ex", e);
       		}
	 		
		return null;
	}
}

• ExceptionResolver가 ModelAndView를 반환하는 이유는 마치 try, catch를 하듯이, Exception을 처리해서 정상 흐름처서 변경하는 것이 목적이다.  

 

반환 값에 따른 동작 방식 

HandlerExceptionResolver의 반환 값에 따른 DispatcherServlet의 동작 방식은 다음과 같다.

• 빈 ModelAndView : new ModelAndView()처럼 빈 ModelAndView를 반환하면 뷰를 렌더링하지 않고, 정상 흐름으로 서블릿이 리턴된다.
• ModelAndView 지정 : ModelAndView에 View, Model 등의 정보를 지정해서 반환하면 뷰를 렌더링한다.
• null : null을 반환하면, 다음 ExceptionResolver를 찾아서 실행한다. 만약 처리할 수 잇는 ExceptionResolver가 없으면예외 처리가 안되고, 기존에 발생한 예외를 서블릿 밖으로 던진다.

 

ExceptionResolver 활용

• 예외 상태 코드 변환
  • 예외를 response.sendError(xxx) 호출로 변경해서 서블릿에서 상태 코드에 따른 오류를 처리하도록 위임
  • 이후 WAS는 서블릿 오류 페이지를 찾아서 내부 호출, 예를 들어서 스프링 부트가 기본으로 설정한 /error가 호출됨
• 뷰 템플릿 처리
  •  ModelAndView에 값을 채워서 예외에 따른 새로운 오류 화면 뷰 렌더링해서 고객에게 제공  
• API 응답 처리
  • response.getWriter().println("hello"); 처럼 HTTP 응답 바디에 직접 데이터를 넣어주는 것도 가능하다. 여기에 JSON으로 응답하면 API 응답 처리를 할 수 있다.

 

WebConfig

@Override
public void extendHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
	resolvers.add(new MyHandlerExceptionResolver());
}

• configureHandlerExceptionResolvers(...)를 사용하면 스프링이 기본으로 등록하는 ExceptionResolver가 제거되기 때문에 주의
• extendHandlerExceptionResolvers를 사용  

 

---

 스프링이 제공하는 ExceptionResolver

handlerExceptionResolverComposite에 다음 순서로 등록

1. ExceptionHandlerExceptionResolver
2. ResponseStatusExceptionResolver
3. DefaultHandlerExceptionResolver → 우선 순위가 가장 낮다.

 

ExceptionHandlerExceptionResolver

• @ExceptionHandler을 처리한다. API 예외 처리는 대부분 이 기능으로 해결한다.

 

ResponseStatusExceptionResolver

• HTTP 상태 코드를 지정해준다.
  예) @ResponseStatus(value = HttpStatus.NOT_FOUND)

 

DefaultHandlerExceptionResolver

스프링 내부 기본 예외를 처리한다.

 

---

@ExceptionHandler

API 예외 처리의 어려운 점

• HandlerExceptionResolver를 떠올려 보면 ModelAndView를 반환해야 했다. 이것은 API 응답에는 필요하지 않다.
• API 응답을 위해서 HttpServletResponse에 직접 응답 데이터를 넣어주었다. 이것은 매우 불편하다. 
• 특정 컨트롤러에서만 발생하는 예외를 별도로 처리하기 어렵다.    

 

@ExceptionHandler

스프링은 API 예외 처리 문제를 해결하기 위해 @ExceptionHandler라는 애노테이션을 사용하는 매우 편리한 예외 처리 기능을 제공하는데, 이것이 바로 ExceptionHandlerExceptionResolver이다.

스프링은 ExceptionHandlerExceptionResolver를 기본으로 제공하고, 기본으로 제공하는 ExceptionResolver 중에 우선 순위도 가장 높다. 실무에서 API 예외 처리는 대부분 이 기능을 사용한다.

 

 

@ExceptionHandler 예외 처리 방법

@ExceptionHandler 애노테이션을 선언하고, 해당 컨트롤러에서 처리하고 싶은 예외를 지정해주면 된다.
해당 컨트롤러에서 예외가 발생하면 이 메서드가 호출된다. 참고로 지정한 예외 또는 그 예외의 자식 클래스는 모두 잡을 수 있다.

 

예시 코드

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

IllegalArgumentException 또는그 하위 자식 클래스를 모두 처리할 수 있다.   

 

우선 순위

스프링의 우선 순위는 항상 자세한 것이 우선권을 가진다.

@ExceptionHandler(부모예외.class)
public String 부모예외처리()(부모예외 e) {}

@ExceptionHandler(자식예외.class)
public String 자식예외처리()(자식예외 e) {}

 @ExceptionHandler에 지정한 부모 클래스는 자식 클래스까지 처리할 수 있다. 따라서 자식 예외가 발생하면 부모 예외처리(), 자식 예외처리() 둘 다 호출 대상이 된다. 그런데 둘 중 더 자세한 것이 우선권을 가지므로 자식 예외처리()가 호출된다. 물론 부모 예외가 호출되면 부모 예외 처리()만 호출 대상이 되므로 부모 예외 처리()가 호출된다. 

 

다양한 예외

다양한 예외를 한 번에 처리할 수 있다. 

@ExceptionHandler({AException.class, BException.class})
public String ex(Exception e) {
	log.info("exception e", e);
}

 

예외 생략

@ExceptionHandler에 예외를 생략할 수 있다. 생략하면 메서드 파라미터의 예외가 지정된다.

@ExceptionHandler
public ResponseEntity<ErrorResult> userExHandle(UserException e) {}

 

파라미터와 응답

@ExceptionHandler에는 마치 스프링의 컨트롤러의 파라미터 응답처럼 다양한 파라미터와 응답을 지정할 수 있다. 
하단 참

https://docs.spring.io/spring-framework/reference/web/webmvc/mvc-controller/ann-exceptionhandler.html#mvc-ann-exceptionhandler-args

---

ResponseStatusExceptionResolver

ResponseStatusExceptionResolver는 예외에 따라서 HTTP 상태 코드를 지정해주는 역할을 한다.

 

다음 2가지 경우를 처리한다.

• @ResponseStatus가 달려있는 예외
• ResponseStatusException 예외

예시 코드

import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ResponseStatus;

@ResponseStatus(code = HttpStatus.BAD_REQUEST, reason = "잘못된 요청 오류")
public class BadRequestException extends RuntimeException {
}

 

BadRequestException 예외가 컨트롤러 밖으로 넘어가면 ResponseStatusExceptionResolver 예외가 해당 애노테이션을확인해서 오류 코드를 HttpStatus.BAD_REQUEST(400)으로 변경하고, 메시지도 담는다.

 

ResponseStatusExceptionResolver 코드를 확인해보면 결국 response.sendError(statusCode, resolvedReason)를 호출하는 것을 확인할 수 있다. sendError(400)를 호출했기 때문에 WAS에서 다시 오류 페이지(/error)를 내부 요청한다.    

 

 

메시지 기능

reason을 MessageSource에서 찾는 기능도 제공한다. reason = "error.bad"

@ResponseStatus(code = HttpStatus.BAD_REQUEST, reason = "error.bad")
public class BadRequestException extends RuntimeException { }

 

messages.properties

error.bad=잘못된 요청 오류입니다. 메시지 사용

 

ResponseStatusException

@ResponseStauts는 개발자가 직접 변경할 수 없는 예외에는 적용할 수 없다. (애노테이션을 직접 넣어야 하는데, 코드를 수정할 수 없는 라이브러리의 예외 코드 같은 곳에는 적용할 수 없다.)

애노테이션을 사용하기 때문에 동적으로 변경하는 것도 어렵다. 이때는 , ResponseStatusException 예외를 사용하라.

 

  

---

DefaultHandlerExceptionResolver

DefaultHandlerExceptionResolver는 스프링 내부에서 발생하는 스프링 예외를 해결한다. 

 

대표적으로 파라미터 바인딩 시점에 맞지 않으면 내부에 TypeMismatchException이 발생하는데, 이 경우 예외가 발생했기 때문에 그냥 두면 서블릿 컨테이너까지 올라가고, 결과적으로 500 오류가 발생한다.

그런데 파라미터 바인딩을 대부분 클라이언트가 HTTP 요청 정보를 잘못 호출해서 발생하는 문제이다. HTTP에서는 이런 경우 HTTP 상태 코드 400을 사용하도록 되어 있다.

DefaultHandlerExceptionResolver는 이것을 500 오류가 아니라 HTTP 상태 코드 400 오류로 변경한다. 스프링 내부 오류를 어떻게 처리할지 수많은 내용이 정의되어 있다.

 

코드 확인

DefaultHandlerExceptionResolver.handleTypeMismatch를 보면 다음과 같은 코드를 확인할 수 있다. response.sendError(HttpServletResponse.SC_BAD_REQUEST) (400)

결국 response.sendError()를 통해서 문제를 해결한다. sendError(400)를 호출했기 때문에 WAS에서 다시 오류 페이지(/error)를 내부 요청한다. 

---

@ControllerAdvice

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

 

예시 코드

@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가 추가되어 있다.  

 

대상 컨트롤러 지정 방법

// 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 {}

 

https://docs.spring.io/spring-framework/reference/web/webmvc/mvc-controller/ann-advice.html