스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 - sec08
출처 : 스프링 MVC 2편

예외 처리와 오류 페이지

서블릿 예외 처리

Exception

자바에서 예외를 던지게 되면 예외 정보를 남기고 Main쓰레드나 해당 코드를 실행한 쓰레드는 종료된다.
BUT! 우리가 만들 웹 애플리케이션은 어떻게 될까?

WAS <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러(예외 발생)

톰캣 같은 WAS까지 예외가 전달됨 => 톰캣이 기본으로 제공하는 오류 화면은 정말 BASIC 그 자체
Exception의 경우, 서브 내부에서 처리할 수 없는 오류가 발생한 것으로 생각해서 HTTP 500을 반환해 줌

Response.sendError(Http 상태 코드, 오류 메시지)

HttpServletResponse가 제공하는 SendError() 메서드를 사용해도 됨!
이것을 호출한다고 해서 당장 예외가 발생하는 것은 아니지만, 서블릿 컨테이너에게 오류가 발생했다는 것을 전달할 수 있음!

WAS(sendError 호출 기록 확인) <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러
(response.sendError())

이 메서드를 호출하면 response 내부에는 오류가 발생했다는 상태를 저장해 둠 => 서블릿 컨테이너는 고객에게 응답 전에 response에 sendError메서드가 호출되었는지 확인 함 => 호출되었다면 설정한 오류 코드에 맞춰 기본 오류 페이지를 보여줌

서블릿 예외 처리 - 오류 화면 제공

오류 페이지는 예외를 다룰 때 해당 예외와 그 자식 타입의 오류를 함께 처리함, 그리고 오류가 발생할 때 처리할 수 있는 컨트롤러가 필요함

서블릿 예외 처리 - 오류 페이지 작동 원리

1. 예외가 발생해서 WAS까지 전파
2. WAS는 오류 페이지 경로를 찾아서 내부에서 오류 페이지를 호출, 이때 오류 페이지 경로로 필터, 서블릿, 인터셉터, 컨트롤러가 모두 다시 호출

WAS는 해당 예외를 처리하는 오류 페이지 정보를 확인함
new ErrorPage(RuntimeException.class, "/error-page/500")
ex) RuntimeException 예외가 WAS까지 전달되면, WAS는 오류 페이지 정보를 확인 => 확인 후, RuntimeException 의 오류 페이지로 /error-page/500 이 지정되어 있는 것을 알게 되고, WAS는 오류 페이지를 출력하기 위해 /error-page/500 를 다시 요청
오류 페이지 요청 흐름

WAS /error-page/500 다시 요청 -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러(/error-page/500) -> View

예외 발생과 오류 페이지 요청 흐름

1. WAS(여기까지 전파) <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러(예외발생)
2. WAS 오류 페이지 확인
3. WAS /error-page/500 다시 요청 -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러(/errorpage/500) -> View

중요한 점은 웹 브라우저(클라이언트)는 서버 내부에서 이런 일이 일어나는지 전혀 모름! 오직 서버 내부에서 오류 페이지를 찾기 위해 추가적인 호출을 함!

오류 정보 추가

WAS는 오류 페이지를 단순히 다시 요청만 하는 것이 아니라, 오류 정보를 request 의 attribute에 추가해서 넘겨줌 => 필요하면 오류 페이지에서 이렇게 전달된 오류 정보 사용 가능

서블릿 예외 처리 - 필터

오류가 발생하면 오류 페이지를 출력하기 위해 WAS 내부에서 다시 한번 호출이 발생한고 이때, 서블릿, 인터셉터도 모두 다시 호출됨! 그런데 로그인 인증 체크 같은 경우를 생각해보면, 이미 한번 필터나, 인터셉터에서 로그인 체크를 완료함 => 서버 내부에서 오류 페이지를 호출한다고 해서 해당 필터나 인터셉트가 한번 더 호출되는 것은 매우 비효율적
결국 클라이언트로 부터 발생한 정상 요청인지, 아니면 오류 페이지를 출력하기 위한 내부 요청인지 구분 해야 함 => 서블릿은 이런 문제를 해결하기 위해 DispatcherType 이라는 추가 정보를 제공

DispatcherType

필터의 경우 이런 중복을 막기 위해 dispatcherTypes라는 옵션을 제공함
로그를 통해, 출력해보면 오류 페이지에서 dispatchType=ERROR 로 나오고 고객이 처음 요청하면 dispatcherType=REQUEST 라고 나옴
이렇듯 서블릿 스펙은 실제 고객이 요청한 것인지, 서버가 내부에서 오류 페이지를 요청하는 것인지 DispatcherType 으로 구분할 수 있는 방법 제공
종류

• REQUEST : 클라이언트 요청
• ERROR : 오류 요청
• FORWARD : MVC에서 배웠던 서블릿에서 다른 서블릿이나 JSP를 호출할 때, RequestDispatcher.forward(request, response);
• INCLUDE : 서블릿에서 다른 서블릿이나 JSP의 결과를 포함할 때, RequestDispatcher.include(request, response);
• ASYNC : 서블릿 비동기 호출
  사용 방법
  WebConfig에서 필터를 등록할 때, filterRegistrationBean.setDispatcherTypes(DispatcherType.REQUEST, DispatcherType.ERROR);
  이렇게 두 가지를 모두 넣으면 클라이언트 요청은 물론이고, 오류 페이지 요청에서도 필터가 호출됨!
  아무것도 넣지 않으면 기본 값은 DispatcherType.REQUEST => 클라이언트의 요청이 있는 경우에만 필터가 적용
  특별히 오류 페이지 경로도 필터를 적용할 것이 아니면, 기본 값 그대로 사용
  물론 오류 페이지 요청 전용 필터를 적용하고 싶으면 DispatcherType.ERROR 만 지정하면 끝!

서블릿 예외 처리 - 인터셉터

필터의 경우, 필터를 등록할 때 어떤 DispatcherType 인 경우에 필터를 적용할 지 선택할 수 있었지만, 인터셉터는 서블릿이 제공하는 기능이 아니라 스프링이 제공하는 기능이기 때문에 DispatcherType 과 무관하게 항상 호출됨
그렇기 때문에, 요청 경로에 따라서 추가하거나 제외하기 쉽게 되어 있기 때문에, 이러한 설정을 사용해서 오류 페이지 경로를 excludePathPatterns 를 사용해서 빼주면 됨

스프링 부트 - 오류 페이지

예외 처리 페이지를 만들기 위해서 다음과 같은 복잡한 과정을 해냄

1. WebServerCustomizer 를 만들기
2. 예외 종류에 따라서 ErrorPage 를 추가
3. 예외 처리용 컨트롤러 ErrorPageController 생성

스프링 부트는 위의 과정을 모두 기본으로 제공
ErrorPage 를 자동으로 등록해주고, /error 라는 경로로 기본 오류 페이지를 설정
=> new ErrorPage("/error") , 상태코드와 예외를 설정하지 않으면 기본 오류 페이지로 사용됨, 서블릿 밖으로 예외가 발생하거나, response.sendError(...) 가 호출되면 모든 오류는 /error 를 호출

BasicErrorController 라는 스프링 컨트롤러를 자동으로 등록해줌, ErrorPage 에서 등록한 /error 를 매핑해서 처리하는 컨트롤러
+) ErrorMvcAutoConfiguration 라는 클래스가 오류 페이지를 자동으로 등록해 줌

오류가 발생했을 때, 오류 페이지로 /error 를 기본 요청 => 스프링 부트가 자동 등록한 BasicErrorController 는 이 경로를 기본으로 받음

BasicErrorController 는 기본적인 로직이 모두 개발되어 있어서 개발자는 오류 페이지 화면만 BasicErrorController 가 제공하는 룰과 우선순위에 따라서 등록하면
됨! 정적 HTML이면 정적 리소스, 뷰 템플릿을 사용해서 동적으로 오류 화면을 만들고 싶으면 뷰 템플릿 경로에 오류 페이지 파일을 만들어서 넣어두기만 하면 됨

뷰 선택 우선 순위
언제나 구체적인 것이 우선 순위를 먼저 가짐
1. 뷰 템플릿
resources/templates/error/500.html
resources/templates/error/5xx.html
2. 정적 리소스( static , public )
resources/static/error/400.html
resources/static/error/404.html
resources/static/error/4xx.html
3. 적용 대상이 없을 때 뷰 이름( error )
resources/templates/error.html

BasicErrorController가 제공하는 기본 정보
model에 담아서 뷰에 전달함

• timestamp: Fri Feb 05 00:00:00 KST 2021
• status: 400
• error: Bad Request
• exception: org.springframework.validation.BindException
• trace: 예외 trace
• message: Validation failed for object='data'. Error count: 1
• errors: Errors(BindingResult)
• path: 클라이언트 요청 경로 (/hello)

오류 관련 내부 정보들을 고객에게 노출하는 것은 좋지 않음!
고객이 해당 정보를 읽어도 혼란만 더해지고, 보안상 문제가 될 가능성 높음

=> 오류 컨트롤러에서 다음 오류 정보를 model 에 포함할지 여부 선택 가능
application.properties에서 설정이 가능함

• server.error.include-exception=false : exception 포함 여부( true , false )
• server.error.include-message=never : message 포함 여부
• server.error.include-stacktrace=never : trace 포함 여부
• server.error.include-binding-errors=never : errors 포함 여부

기본 값이 never인 부분은 3가지 옵션 사용 가능함
never(사용하지 않음), always(항상 사용), on_param(파라미터가 있을 때 사용)
on_param 은 파라미터가 있으면 해당 정보를 노출, 디버그 시 문제를 확인하기 위해 사용 가능 BUT! 이 부분도 개발 서버에서 사용할 수 있지만, 운영 서버에서는 권장 X
on_param 으로 설정하고 HTTP 요청시 파라미터를 전달하면 해당 정보들이 model 에 담겨서 뷰 템플릿에서 출력되는데, 실무에선 이것들을 노출해서는 NEVER 안됨
우리 고객에게는 이쁜 화면과 간단한 오류 메시지만 보여주자^^

스프링 부트 오류 관련 옵션
server.error.whitelabel.enabled=true : 오류 처리 화면을 못 찾을 시, 스프링 whitelabel 오류 페이지 적용
server.error.path=/error : 오류 페이지 경로, 스프링이 자동 등록하는 서블릿 글로벌 오류 페이지 경로와 BasicErrorController 오류 컨트롤러 경로에 함께 사용
확장 포인트
에러 공통 처리 컨트롤러의 기능을 변경하고 싶으면 ErrorController 인터페이스를 상속 받아서 구현하거나 BasicErrorController 상속 받아서 기능을 추가하면 됨