Servlet 예외 처리
최종적으로 알고 싶은 것은 스프링의 예외처리이지만, 서블릿 컨테이너위에서 스프링이 돌아가기 때문에 서블릿이 어떻게 예외처리를 하는지부터 알고가자.
스프링이 아닌 순수 Servlet 컨테이너는 예외를 어떻게 처리할까??
Serlet은 2가지 방식으로 예외 처리를 지원한다. - Exception(예외) - response.sendError(HTTP 상태 코드, 오류 메시지)
🔧 Exception
자바의 메인 메서드를 직접 실행하는 경우 main이라는 이름의 쓰레드가 실행되는데, 이 때 예외를 catch하지 못하고 main메서드를 넘어 예외가 throw되면 예외 정보를 남기고 해당 쓰레드는 종료된다.
웹 애플리케이션은 사용자 요청 별로 쓰레드가 할당되고, Servlet 컨테이너 안에서 실행된다.애플리케이션 내에서 발생한 예외를 try-catch로 처리하면 문제가 없지만, 만약 Servlet 밖으로까지 예외가 전달되면??
컨트롤러(Exception 발생) -> 인터셉터 -> 서블릿 -> 필터 -> WAS
WAS까지 예외가 전달되면 어떻게 처리해야 할까?
한번 WAS까지 예외를 던져보자.(스프링 부트가 제공하는 기본 예외 페이지를 꺼두고)
application.properties에 아래 코드를 추가해 스프링 부트가 제공하는 기본 예외 페이지를 사용하지 않는다.
server.error.whitelabel.enabled=false
컨트롤러를 하나 만들어 단순히 RuntimeException을 던져보겠다. 현재 어느 곳에서도 catch하지 않기 때문에 Exception이 WAS까지 전달될 것이다.
이는 Tomcat이 기본으로 제공하는 오류 화면이고 HTTP 상태 코드가 500이다.
Exception의 경우 서버 내부에서 처리할 수 없는 오류가 발생한 것으로 생각하여 Tomcat은 500을 반환한다.
🔧 response.sendError
오류가 발생했을 때 HttpServletResponse가 제공하는 sendError 메서드를 사용하여 Servlet 컨테이너에게 오류가 발생했다는 것을 전달할 수 있다.(예외가 발생하는 것이 아님)
sendError를 사용하면 HTTP 상태 코드와 오류 메시지도 추가할 수 있다.
sendError를 사용하여 오류를 Servlet 컨테이너에게 알려주는 컨트롤러를 만들었다.
response.sendError()를 호출하면 response 내부에는 오류가 발생했다는 상태를 저장해둔다. 이 때 Exception이 발생한 것이 아니기 때문에 정상적으로 흐름에 따라 WAS까지 return된다.
서블릿 컨테이너(여기서는 Tomcat)는 클라이언트에 응답하기 전에 response에 sendError()가 호출되었는지 확인한다. 호출되었다면 설정한 오류 코드에 맞추어 기본 오류 페이지를 보여준다.
🔧오류 화면 기능
서블릿 컨테이너가 제공하는 기본 예외 처리 화면말고 서블릿이 제공하는 오류 화면 기능을 사용해보자.
즉, 상황에 맞춰 직접 만든 오류 화면을 보여줄 수 있는 기능이다.
과거에는 web.xml이라는 파일에 오류 화면을 등록했지만 스프링 부트를 통해 서블릿 컨테이너를 실행하기 때문에 스프링 부트가 제공하는 기능을 사용해서 서블릿 오류 페이지를 등록하면 된다.
WebServerFactoryCustomizer<ConfigurableWebServerFactory>을 구현하는 클래스를 만들면된다.
구현하는 메서드로 customize가 있는데 여기서 어떤 상태코드 또는 예외에 대해서 어떤 페이지를 보여줄지를 설정한다.좀 더 정확히 말하면 404에러가 발생하면 "/error-page/400" URL로 보내주므로 컨트롤러와 매핑되게 된다.
오류 페이지는 예외를 다를 때 해당 예외와 그 자식 타입의 오류도 함께 처리하기 때문에 RuntimeException의 자식도 함께 처리해준다. 이 클래스를 @Component를 통해 컴포넌트 스캔의 대상으로 지정하여 스프링 컨테이너에 등록해주어야한다.
이제 오류를 처리할 컨트롤러를 만들자
컨트롤러에서 호출되어 랜더링될 View를 만들었다.
==> resources/templates/error-page/404.html 과 resources/templates/error-page/500.html
이제 서버를 실행시켜 원하는 대로 동작하는지 테스트해보자.
"/error-ex"로 접속을 했더니 직접 만든 custom 오류 페이지가 나왔다.
어떻게 이런 결과가 나온 것인지 동작과정을 살펴보자.
먼저 "error-ex"로 접속을 하면 아래 컨트롤러와 매핑된다.
예외를 던지고 현재 스프링 부트가 기본으로 제공하는 예외 페이지를 disabled 해두었고 예외를 catch하는 곳이 어디에도 없기 때문에 해당 예외가 서블릿 컨테이너(Tomcat)까지 전달된다.
이 때 서블릿 컨테이너가 등록된 WebServerCustomizer의 오류 페이지를 보고 "/error-page/500"을 호출한다.
해당 url로 접속하며 아래 컨트롤러가 매핑된다.
이 컨트롤러에서 View(500.html)를 호출하여 위와 같은 오류 페이지가 클라이언트에게 보여지게 된다.
나머지 "/error-404", "/error-500"으로 접속하였을 때도 위와 동일한 과정으로 동작한다.
위 과정을 흐름에 따라 나타내보면
1. WAS(여기까지 전파) <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러(예외발생)
2. WAS `/error-page/500` 다시 요청 -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러(/errorpage/500) -> View
여기서 핵심은 클라이언트는 서버 내부에서의 이런 과정을 전혀 모르고 알 필요도 없다는 것이다. 오직 서버 내부에서 오류 페이지를 찾기 위해 추가적인 호출을 하는 것!!!
오류 정보 추가
WAS는 오류 페이지를 다시 요쳥하는 것 뿐만 아니라, 오류 정보를 request의 attribute에 추가해서 넘겨주기 때문에 오류 페이지에서 전달된 오류 정보를 사용할 수있다.
RequestDispatcher 인터페이스에 위와 같이 상수로 저장되는 Attribute 이름이 지정되어 있다. 이 중에서 몇가지만 써서 사용해보자.
HttpServletRequest를 매개변수로 받아 그 안에 담긴 오류 정보를 로그로 남기는 메서드를 만들었다.
이를 각 컨트롤러에 추가하고 테스트해보자.
먼저, "/error-ex"로 접속하여 WAS로 RuntimeException을 던졌다.
서버 내부적으로 "/error-page/500"으로 보내 해당 컨트롤러를 다시 호출하게 되는데 이 때 Request에 위와 같은 에러에 관한 정보를 담아 보내준 것이다.
서블릿 예외처리를 할 때 필터와 인터셉터는 어떻게 맞물려서 동작하는걸까?
필터
오류가 발생하면 오류 페이지를 출력하기 위해 WAS 내부에서 호출이 다시 발생한다. 이 때 필터, 서블릿, 인터셉터도 모두 다시 호출되는데, 필터나 인터셉터가 로그인 인증 체크를 한다고 가정해보자.
이미 인증체크를 통과했는데 다시 호출되어 한번 더 인증 체크를 하는 것은 매우 비효율적이다.
따라서 해당 요청이 정상 요청인지 아니면 오류 페이지를 출력하기 위한 내부의 요청인지를 구분할 수 있어야한다.
이를 위해 서블릿은 DispatcherType 이라는 추가 정보를 제공한다.
DispatcherType
위에서 오류 추가 정보를 알아보면서 로그로 request.getDispatcherType()을 남겼다. 오류 페이지에서는 이것은 ERROR라고 출력되고 고객의 정상요청은 REQUEST이다.
이렇게 서블릿 스펙인 해당 요청이 클라이언트가 요청한 것인지 서버 내부적으로 오류 페이지를 요청하는 것인지를 DispatcherType으로 구분할 수 있다.
DispatcherType의 종류는 아래와 같다.
- REQUEST : 클라이언트 요청
- ERROR : 에러 페이지 요청
- FORWARD : 서블릿에서 다른 서블릿이나 JSP를 호출할 때 ==> RequestDispatcher.forward(request, response)
- INCLUDE : 서블릿에서 다른 서블릿이나 JSP의 결과를 포함할 때 ==> RequestDispatcher.include(request, response)
- ASYNC : 서블릿 비동기 호출
이전에 만들었던 로그 필터와 거의 동일하다. getDispatcherType()만 추가로 찍어줌.
Config 클래스를 만들어 필터를 등록시켜주었는데, setDispatcherTypes를 통해 DispatcherType이 REQEUST나 ERROR 일때만 필터가 호출되도록 설정하였다.
RuntimeException을 발생시키는 "/error-ex"로 접속해보았다.
처음 요청을 보냈을 때는 당연히 DispatcherType이 REQUEST이다. 하지만 예외가 발생하고 서블릿 컨테이너까지 예외가 전달된다. 그 뒤에 로그 필터로 다시 요청이 들어오는데
이번에는 DispatcherType이 ERROR이다. 서버가 내부적으로 호출을 하였다.
필터와 Dispatcher Servlet을 지나 컨트롤러가 호출되고 마지막으로 응답이 나간 것을 확인할 수 있다. 현재는 LogFilter를 REQUEST, ERROR에 호출되도록 해놓았기 때문에 2번 호출된 것을 확인할 수 있다.
참고로 setDispatcherType을 하지 않으면 default로 REQUEST 에만 필터가 적용된다.
인터셉터
이번에는 인터셉터를 살펴보자.
필터의 경우에는 DispatcherType에 따라 호출되게 설정할 수 있었지만, 인터셉터는 Spring이 제공하는 기능이기 때문에 DispatcherType에 관계없이 호출된다.
대신에 excludePathPatterns에 오류페이지 경로를 추가하여 오류페이지가 호출될 경우에는 제외를 해준다.
서블릿 컨테이너에 오류가 전달됐을때 호출하도록 설정한 경로인 "/error-page/404", "/error-page/500"를
"/error-page/**"을 통해 모두 인터셉터에서 제외시켜준 것이다.
로그를 살펴보면 먼저 "/error-ex"로 접속을하면 인터셉터가 호출되고 preHandle()이 먼저 호출된다. 이 때 컨트롤러에서는 예외가 발생하고 따라서 postHandle은 호출되지 않고 예외가 afterCompletion으로 던져진다. 이 예외는 서블릿 컨테이너에게까지 전달되고 다시 "/error-page/500"을 내부적으로 요청하는데 이는 excludePatterns를 통해 인터셉터의 호출을 제외시켜놓은 경로이기 때문에 인터셉터는 호출되지 않고 DispatcherServlet을 통해 컨트롤러가 호출되어 클라이언트에게
오류 페이지(응답)을 보냈다.
🌱Spring Boot의 오류 페이지
앞서 예외 처리 페이지를 만들기 위해서 WebServerFactoryCustomizer<ConfigurableWebServerFactory>를 구현하는 클래스를 만들고, 예외 종류에 따라 ErrorPage를 추가하고 예외 처리용 컨트롤러를 만들었다.
Spring Boot는 이런 과정을 모두 기본으로 제공한다.😜
"/error"라는 경로로 ErrorPage를 자동으로 등록한다.(상태 코드와 예외를 설정하지 않으면 기본 오류 페이지로 사용)
BasicErrorController라는 스프링 컨트롤러가 자동으로 등록된다.(/error를 매핑하여 처리하는 컨트롤러)
오류가 발생하면 오류 페이지로 /error를 기본 요청하고 BasicErrorController로 매핑되는 것이다.
BasicErrorController는 기본적인 로직이 모두 개발되어 있으므로 개발자는 오류 페이지화면만 제공하는 룰과 우선순위에 따라서 등록하면된다.
정적 HTML은 static 하위에 뷰 템플릿을 사용하는 동적 HTML은 templates/error하위에 위치시킨다.
뷰 템플릿이 정적 리소스보다 우선순위가 높다. 만약 뷰 템플릿과 정적 리소스에 적용 대상이 없다면 resources/templates/error.html을 찾는다.
이름에도 규칙이 존재하는데 4xx.html은 400번대 에러(401,402,403.....)에 적용되는 것이고 404.html은 404에러에만
구체적으로 적용된다. (구체적인 것이 더 우선순위가 높음)
즉, 404에러가 발생하면 404.html이 호출되고 그 외의 400번대 에러에는 4xx.html이 호출되는 것이다.
추가로 BasicErrorController는 아래와 같은 정보를 Model에 담아 View에 전달하기 때문에 뷰 템플릿을 사용하게되면
이를 사용할 수 있게된다.
- timestamp, status, error, exception, trace, message, errors, path 등등
이와 같이 Model에 담긴 값이 View로 넘어오기 때문에 뷰 템플릿에서 꺼내 사용할 수 있게된다.
위와 같이 뷰 템플릿에서 오류 정보를 출력할 수 있는데 그 중에 절반이 값이 null인 것을 볼 수 있는데, 오류 관련 내부 정보를 클라이언트에게 노출하는 것은 좋지 않다. 보안상 문제도 있고, 고객이 이를 읽어도 혼란만 가중될 뿐이다.
따라서 BasicErrorController에서 다음 오류 정보를 Model에 포함할지 여부를 선택할 수 있다.
default는 포함하지 않도록 설정되어 있음.
- 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 포함 여부
확인을 위해 Model에 포함하도록 설정하고 다시 실행시켜보자.
ㅋㅋㅋㅋㅋㅋㅋㅋㅋ.... 황급히 바로 주석처리 했음
여하튼 이런 오류 정보를 고객에게 모두 보여주는 것이 의미가 있을까? 보안상에 문제는 없을까? 따라서 기본적으로 Model에 포함되지 않는다.
또 다른 옵션으로 on_param이 있는데 이 옵션은 파라미터가 있을 때만 해당 정보를 노출한다. 이는 디버그 시 문제를 확인하기 위해 사용될 수 있는 옵션이다. 이 옵션으로 설정하고 "/error-ex?message=&errors=&trace="으로 접속하면 해당 정보가 노출되고 단순히 "/error-ex"로 접속하면 노출되지 않는다.
사용자에게는 예쁘고 친절한 오류 화면과 이해가능한 간단한 메시지를 보여주고
오류는 서버단의 로그로 남겨 확인해야한다!!!!
그외 오류 관련 옵션
server.error.whitelabel.enabled= : 오류 화면을 찾지 못했을 시 스프링 whitelabel 오류 페이지 적용(default = true)
server.error.path= : 오류 페이지 경로, 스프링이 자동 등록하는 오류 페이지 경로와 BasicErrorController에 매핑될 경로(default = /error)
'Spring > Spring MVC' 카테고리의 다른 글
| Spring Type Converter (0) | 2021.08.03 |
|---|---|
| API 예외 처리 (0) | 2021.07.28 |
| 필터, 인터셉터 (0) | 2021.07.21 |
| 쿠키, 세션 (0) | 2021.07.17 |
| Bean Validation (0) | 2021.07.14 |