예외 처리
서블릿 예외 처리
웹 어플리케이션
사용자 요청별로 별도의 쓰레드가 할당되고, 서블릿 컨테이너 안에서 실행됨
애플리케이션에서 에외가 발생했는데, try~catch로 예외를 잡아서 처리하면 아무러 문제가 없다.
만약에 애플리케이션에서 예외를 잡지 못하고 서블릿 밖으로 까지 예외 전달
Was ← 필터 ←서블릿 ← 인터셉터 ← 컨트롤러(예외 발생)
이럴 때, WAS까지 가면 오류 코드에 맞추어 기본 오류 페이지를 보여준다.
response.sendError()로 에러를 WAS까지 전파할 수 있다.
오류 화면 제공하기
예전에는 web.xml이라는 파일에 오류 화면을 등록했음
스프링 부트는 서블릿 컨테이너를 스프링에서 열기 때문에, 스프링 부트가 제공하는 기능을 사용해서 서블릿 오류 페이지를 등록하면 됨
•
WebServerFactoryCustomizer 를 구현하자
•
해당 오류 페이지를 처리할 컨트롤러도 만들어줘야한다
오류 페이지 작동 원리
1.
WAS ← 필터 ← 서블릿 ← 인터셉터 ← 컨트롤러
2.
WAS '/error-page/500' 다시 요청 → 필터 → 서블릿 → 인터셉터 → 컨트롤러 → view
이러한 과정이 일어나는지 클라이언트는 전혀 모른다.
필터와 인터셉터가 다시 호출된다.
이 외에 오류 정보를 request의 attribute에 추가해서 넘겨준다.
javax.servlet.error.exception: 예외
javax.servlet.error.exception_type: 예외 타입
javax.servlet.error.message: 오류 메시지
javax.servlet.error.request_uri: 클라이언트 요청 URI
javax.servlet.error.servlet_name: 오류가 발생한 서블릿 이름
javax.servlet.error.status_code: HTTP 상태 코드
서블릿 예외 처리- 필터
오류 페이지를 호출할 때 WAS 내부에서 필터,서블릿,인터셉터를 한 번 더 거침
클라이언트로부터 발생한 정상 요청인지, 아님 오류 페이지를 출력하기 위한 내부 요청인지 구분해야한다.
이를 위해 DispatcherType이라는 추가 정보를 제공한다.
javax.servlet.DispatcherType을 enum으로 정의해놓음
dispatcherTypes
•
REQUEST: 클라이언트 요청
•
ERROR: 오류 요청
•
FORWARD: 서블릿에서 다른 서블릿이나 JSP를 호출할 때
•
INCLUDE: 서블릿에서 다른 서블릿이나 JSP의 결과를 포함할 때
•
ASYNC: 서블릿 비동기 호출
필터 등록할 때 어떤 dispatcherType에 대해서 동작할지 설정할 수 있다.
기본 값은 REQUEST
서블릿 예외 처리 - 인터셉터
인터셉터는 DispatcherType에 따라서 선택 적용하는 그런거 자체가 없다.
대신 excludePathPatterns를 사용해서 빼줘야함
정상 요청
WAS → 필터 → 서블릿 → 인터셉터 → 컨트롤러 → view
에러 요청
•
필터틑 DispatcherType으로 중복 호출 제거
•
인터셉터는 경로 정보로 중복 호출 제거
1.
WAS → 필터 → 서블릿 → 인터셉터 → 컨트롤러
2.
WAS ← 필터 ← 서블릿 ← 인터셉터 ← 컨트롤러(예외 발생)
3.
WAS 오류 페이지 확인
4.
WAS(/error-page/500, dispatcherType = ERROR) → 필터(x) → 서블릿 → 인터셉터(x) → 컨트롤러(/error-page/500) → View
스프링 부트
WebServerCustomize를 만들고
예외 종류에 따라 ErrorPage를 추가하고
예외 처리용 컨트롤러 ErrorPageController를 만듬
—> 스프링 부트가 기본적으로 다 제공해줌
1.
ErorrPage를 자동으로 등록함
2.
BasicErrorcontroller라는 스프링 컨트롤러를 자동으로 등록한다.
개발자가 할 일
오류 페이지 화면만 BasicErrorController가 제공하는 룰과 우선순위에 따라서 등록하면 됨
1.
뷰 템플릿
•
resources/templates/error/500.html
•
resources/templates/error/5xx.html
2.
정적 리소스
•
resources/static/error/400.html
•
resources/static/error/4xx.html
3.
적용대상이 없을 경우 뷰 이름(error)
•
resources/templates/error.html
BasicErrorController가 전달하는 정보들
timestamp: 언제 발생했는데
status: 400
error: Bad Request
excpetion: 어떤 종류의 exception인지
trace: stack trace
message: 설정한 메시지
errors: 어떤 에러인지
path: 클라이언트 요청 경로
이러한 정보들을 노출시킬 수도 숨길 수도 있다.
option 넣기
//application.properties
server.error.include-exception = true
server.error.include-message=on_param
server.error.include-stacktrace=on_param
server.error.include-binding-errors=on_param
never:사용하지 않음
always: 항상 사용
on_param: 파라미터가 있을 때 사용
JavaScript
복사
실무에서는 사용하지 말자
API 예외 처리
API는 각 오류 상황에 맞는 오류 응답 스펙을 정하고, JSON으로 데이터를 내려줘야한다.
추가적으로 만들어야할 것
•
api 컨트롤러
•
application/json과 error-page/500을 잡을 수 있는 컨트롤러
@RequestMapping(value = "/error-page/500", produces = APPLICATION_JSON_VALUE)
public ResponseEntity<Map<String,Object>> errorPage500Api(HttpServletRequest request, HttpServletResponse response){
Map<String,Objecvt> result = new HashMap<>()
Exception ex = (Exception) request.getAttribute(ERROR_EXCEPTION);
result.put("status",request,getAttribute(ERROR_STATUS_CODE);
result.put("message",ex.getMessage());
Integer statusCode = (Integer) request.getAttribute(RequestDispatcher.ERROR_STATUS_CODE);
return new ResponseEntity<>(result,HttpStatus.valueOf(statusCode));
}
Java
복사
즉 순서를 생각해보면
Api에서 Exception을 던지고, 아무도 그걸 안 받아서 서버에서 다시 에러 페이지에 알맞는 컨트롤러를 호출
api호출에 대한 컨트롤러를 작성해서 이에 대한 ResponseEntityt를 반환
스프링 부트 기본 오류 처리
API 예외 처리도 스프링 부트가 제공하는 기본 오류 방식을 사용할 수 있다.
BasicErrorController는 text/html이 아닌 경우 json을 응답하도록 설계 되어있다.
기본 요청은 /error이다.
BasicErrorController는
1.
기본적으로 예외 코드에 맞는 html 페이지를 등록해놓으면
2.
에러가 발생했을 때 기본적으로 /error 경로로 보내버리고
3.
/error로 받는 컨트롤러를 구현해놓았다.
4.
이 때 에러 코드를 분석해서 알맞는 에러 페이지를 제공한다.
5.
또한 text/html이 아닌 경우는 ResponseEntity를 반환한다.
Html 페이지 vs API 오류
BasicErrorController를 확장하면 JSON 메시지도 변경할 수 있다.
다만 API오류는 @ExceptionHandler가 제공하는 기능을 사용하는 것이 더 나은 방법
이 BasicErrorController는 HTML 페이지를 제공하는 경우에 매우 편리함.
따라서 HTML화면을 처리할 때는 BasicErrorController를 사용하고, API 오류처리는 @ExceptionHandler를 사용하자
왜냐
API오류 처리는 API마다, 각각의 컨트롤러나 예외마다 서로 다른 응답 결과를 출력해야할 수도 있다.
회원과 관련된 API에서 예외가 발생할 때 응답과 상품과 관련된 API에서 발생하는 예외에 따라 그 결과가 달라질 수 있다.
HandlerExceptionResolver
예외가 발생해서 서블릿을 넘어 WAS까지 전달되면 HTTP 상태코드가 500으로 처리됨
발생하는 예외에 따라서 400,404등등 다른 상태코드도 처리하고 싶다.
오류 메시지,형식 등을 API마다 다르게 처리하고 싶다.
이럴 때 HandlerExceptionResolver가 필요함
HandlerExceptionResolver
스프링 MVC는 컨트롤러 밖으로 예외가 던져진 경우 예외를 해결하고, 동작을 새로 정의할 수 있는 방법을 제공
HandlerExceptionResolver - 인터페이스
public interface HandlerExceptionResolver{
ModelAndView resolveException(
HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex);
Java
복사
handler: 핸들러(컨트롤러) 정보
Exception ex: 핸들러(컨트롤러)에서 발생한 예외
이 인터페이스를 구현하면 된다.
ExceptionResolver가 ModelAndView를 반환하는 이유는 마치 try,catch를 하듯
Exception을 처리해서 정상 흐름처럼 변경하는 것이 목적
반환 값에 따른 동작 방식
•
빈 ModelAndView : new ModelAndView() 처럼 빈 ModelAndView를 반환하면 뷰를 렌더링하지 않고, 정상 흐름으로 서블릿이 리턴된다.
•
ModelAndView 지정: ModelAndView에 View, Model 등의 정보를 지정해서 반환하면 뷰를 렌더링함.
•
null: null을 반환하면, 다음 ExceptionResolver를 찾아서 실행, 만약 처리할 수 있는 ExceptionResolver가 없으면 예외 처리가 안되고, 기존에 발생한 예외를 서블릿 밖으로 던짐
ExceptionResolver 활용
1.
예외 상태 코드 변환
•
예외를 response.sendError(xxx)호출로 변경해서 서블릿에서 상태 코드에 따른 오류를 처리하도록 위임
•
이후 WAS는 서블릿 오류 페이지를 찾아서 내부 호출, 스프링 부트가 기본으로 설정한 /error가 호출됨
2.
뷰 템플릿 처리
•
ModelAndView에 값을 채워서 예외에 따른 새로운 오류 화면 뷰 렌더링해서 고객에게 제공
3.
API응답 처리
•
response.getWriter().println("hello"); 처럼 HTTP응답 바디에 직접 데이터를 넣어주는 것도 가능
•
여기에 JSON으로 응답하면 API응답 처리할 수 있음.
예외를 여기서 마무리하기
예외가 발생하면 WAS까지 예외가 던져지고, WAS에서 오류 페이지 정보를 찾아서 다시 /error를 호출하는 과정 → 너무 복잡함
ExceptionResolver를 활용하면 예외가 발생했을 때 이런 복잡한 과정 없이 여기에서 문제를 깔끔히 해결할 수 있음
그냥 직접 짜주고 빈 ModelAndView를 던진다.
사실 너무 복잡해서 스프링이 제공하는 ExceptionResolver를 쓴다.
ExceptionResolver
스프링 부트가 기본으로 제공하는 ExceptionResolver는 다음과 같다
ExceptionHandlerExceptionResolver
@ExceptionHandler를 처리함.
API 예외 처리는 대부분 이 기능으로 해결한다.
ResponseStatusExceptionResolver
HTTP상태코드를 지정해준다.
DefaultHandlerExceptionResolver
스프링 내부 기본 예외를 처리한다.
ResponseStatusExceptionResolver
•
@ResponseStatus가 달려있는 예외
•
ResponseStatusException 예외
DefaultHandledExceptionHandler
스프링 내부 예외 처리를 해결함
대표적으로 파라미터 바인딩 시점에 타입이 맞지 않으면 내부에서 TypeMismatchException이 발생하는데, 이 경우 에외가 발생하면 이 Handler가 동작해서 해결해줌
500오류가 아니라 400으로 바꿔준다.
ExceptionHandlerExceptionResolver
@ExceptionHandler를 해결한다.
•
@ExceptionHandler 애노테이션을 선언하고, 해당 컨트롤러에서 처리하고 싶은 예외를 지정해주면 됨.
•
해당 컨트롤러에서 예외가 발생하면 이 메서드가 호출된다.
•
지정한 예외 또는 그 예외의 자식 클래스는 모두 잡을 수 있다.
우선순위
•
항상 자세한 것이 우선권을 가진다. 예를 들어 부모,자식 클래스가 있다면
•
자식예외가 발생하면 자식예외처리 클래스가 실행되고, 부모예외가 실행되면 부모예외처리가 호출된다.
예외 생략시 메서드 파라미터의 예외가 지정됨
ControllerAdvice
정상 코드와 예외처리 코드가 하나의 컨트롤러에 섞여있으므로, ControllerAdvice를 사용하여 둘을 분리시킨다.
@Slf4j
@RestControllerAdvice
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> 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","내부 오류");
}
}
Java
복사
