[ 김영한 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 #8 ] 예외 처리와 오류 페이지 (1)

이번 섹션에서는 [예외 처리와 오류 페이지]에 대해서 알아보자.

👉 목차는 다음과 같다.

1) 프로젝트 생성
2) 서블릿 예외 처리 - 시작
3) 서블릿 예외 처리 - 오류 화면 제공
4) 서블릿 예외 처리 - 오류 페이지 작동 원리
5) 서블릿 예외 처리 - 필터
6) 서블릿 예외 처리 - 인터셉터
7) 스프링 부트 - 오류 페이지1
8) 스프링 부트 - 오류 페이지2
9) 정리

서비스를 개발하고 운영하다보면, 예상치 못하게 다양한 예외가 발생할 수 있다.
이렇게 예외가 발생하면, 고객에게는 정돈된 오류 페이지를 보여줘야 한다.

그래서 예외가 발생했을 때, 어떤 상태일때는 어떤 오류페이지를 정의할지 등의 매커니즘에 대해서 스프링은 어떤식으로 제공하는지, 그리고 서블릿은 어떤식으로 제공하는지 하나씩 알아보자.

이번 섹션은 1) ~ 6), 7) ~ 9) 로 나눠서 포스팅하고자 한다.

바로 하나씩 확인해보자.

---

1) 프로젝트 생성

• 스프링 부트 스타터 사이트로 이동해서 스프링 프로젝트를 생성하자. ( https://start.spring.io/ )
• 프로젝트 선택
  • Project: Gradle Project
  • Language: Java
  • Spring Boot: 2.7.16 (강의에서는 2.5.1로 하였다. 필자가 강의를 듣는 시점에는 선택지에 해당 버전이 없어, 2.7.16 버전으로 하였다.)
  • Project Metadata
    • Group: hello
    • Artifact: exception
    • Name: exception
    • Package name: hello.exception
    • Packaging: Jar
    • Java: 11
  • Dependencies
    • Spring Web
    • Lombok
    • Thymeleaf
    • Validation
• Generate 버튼 클릭 후 압축 파일을 내려받고, 압축 해제하여 intelliJ를 통해 열어보자.
  • 프로젝트를 열고, Lombok 세팅을 위해 [File > settings > Annotation Processors]에서 Enable Annotation Processing 체크박스 선택 후 intelliJ 재시작하자.
• 프로젝트를 실행해보자.
  
  • http://localhost:8080 호출해서 Whitelabel Error Page가 나오면 정상 동작.

 

예외 처리는, 서블릿 컨테이너가 어떤식으로 예외를 처리하는지 그 매커니즘을 먼저 이해하고, 그 위에서 스프링이 어떤식으로 예외를 처리하는지를 순차적으로 이해해야 제대로 된 예외처리를 이해할 수 있다.

따라서 다음 내용에서는 서블릿 예외 처리에 대해서 알아보자.

---

2) 서블릿 예외 처리 - 시작

스프링이 아닌 순수 서블릿 컨테이너는 예외를 어떻게 처리하는지 알아보자.

서블릿은 다음 2가지 방식으로 예외 처리를 지원한다.

• Exception (예외)
• response.sendError(HTTP 상태 코드, 오류 메시지)

하나씩 살펴보자.

 

Exception (예외)

자바 직접 실행

• 자바의 메인 메서드를 직접 실행하는 경우 main 이라는 이름의 쓰레드가 실행된다. 실행 도중에 예외를 잡지 못하고 처음 실행한 main() 메서드를 넘어서 예외가 던져지면, 예외 정보를 남기고 해당 쓰레드는 종료된다.

웹 애플리케이션

• 웹 애플리케이션은 사용자 요청별로 별도의 쓰레드가 할당되고, 서블릿 컨테이너 안에서 실행된다.
• 애플리케이션에서 예외가 발생했는데, 어디선가 try ~ catch로 예외를 잡아서 처리하면 아무런 문제가 없다. 그런데 만약에 애플리케이션에서 예외를 잡지 못하고, 서블릿 밖으로까지 예외가 전달되면 어떻게 동작할까?
  
  • 결국 톰캣 같은 WAS 까지 예외가 전달된다.

 

🤔 WAS는 예외가 올라오면 어떻게 처리해야 할까?
(WAS까지 예외가 전달되면, WAS는 어떻게 처리할까?)

한번 테스트 해보자.

• 먼저, 스프링 부트가 제공하는 기본 예외 페이지가 있는데 이건 꺼두자 (뒤에서 다시 설명하겠다.)
  
• ServletExController - 서블릿 예외 컨트롤러 생성: src > main > java > hello > exception 패키지 내부에 servlet 패키지를 생성하고, 그 내부에 ServletExController 클래스를 생성하자.
  
• 실행해서 호출해보자.
  
  • 실행해보면 다음처럼 tomcat이 기본으로 제공하는 오류 화면을 볼 수 있다.
  • 웹 브라우저에서 개발자 모드로 확인해보면 HTTP 상태 코드가 500으로 보인다. Exception 이 발생해서 WAS까지 전달되면, WAS는 서버 내부에서 처리할 수 없는 오류가 발생한 것으로 생각해서 HTTP 상태 코드 500을 반환한다. (+ 그러면서 본인이 그릴 수 있는 나름의 디자인으로 위 페이지를 뿌려준다.)
• 이번에는 아무 사이트나 호출해보자.
  
  • 해당하는 리소스가 없다. 톰캣이 기본으로 제공하는 404 오류 화면을 볼 수 있다.

 

response.sendError(HTTP 상태 코드, 오류 메시지)

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

이 메서드를 사용하면 HTTP 상태 코드와 오류 메시지도 추가할 수 있다.

• response.sendError(HTTP 상태 코드)
• response.sendError(HTTP 상태 코드, 오류 메시지)

 

👉 테스트 해보자.

• ServletExController - 추가: ServletExController에 아래 코드를 추가해보자.
  

• 실행해보자. ( http://localhost:8080/error-404 요청 시)
  
  • 상태 코드 404를 확인할 수 있다. (실행해보면 서블릿 컨테이너가 기본으로 제공하는 오류 화면을 볼 수 있다.)

• 실행해보자. ( http://localhost:8080/error-500 요청 시)
  
  • 상태 코드 500을 확인할 수 있다. (실행해보면 서블릿 컨테이너가 기본으로 제공하는 오류 화면을 볼 수 있다.)

 

sendError 흐름

• 참고)
  
  • response.sendError() 를 호출하면 response 내부에는 오류가 발생했다는 상태를 저장해둔다. 그리고 서블릿 컨테이너는 고객에게 응답 전에 response 에 sendError() 가 호출되었는지 확인한다. 그리고 호출되었다면 설정한 오류 코드에 맞추어 기본 오류 페이지를 보여준다.
  • (참고) 컨트롤러에서 response.sendError() 시, (예외가 발생한 것은 아니기 때문에) 요청에 대해서는 정상적으로 흐름이 리턴된다(컨트롤러 -> 인터셉터 -> 서블릿 -> 필터 -> WAS). 그런데 WAS까지 전달되고 나면, WAS는 response의 sendError가 호출되었는지 확인한다. 그리고 호출되었다면 설정한 오류 코드에 맞추어 기본 오류 페이지를 보여준다.

✔️ 정리

• 지금까지 서블릿 컨테이너가 제공하는 기본적인 예외처리 매커니즘에 대해서 알아보았다. (Exception (예외)가 발생하면, 서블릿 컨테이너는 500으로 처리한다. 또는 response.sendError가 호출된 경우, 설정한 오류 코드에 맞추어 기본 오류 페이지를 보여준다.)

서블릿 컨테이너가 제공하는 기본 예외 처리 화면은 사용자가 보기에 불편하다. 의미 있는 오류 화면을 제공해보자.

---

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

서블릿 컨테이너가 제공하는 기본 예외 처리 화면은 고객 친화적이지 않다. 서블릿이 제공하는 오류 화면 기능을 사용해보자.

서블릿은 Exception (예외)가 발생해서 서블릿 밖으로 전달되거나 또는 response.sendError() 가 호출되었을 때 각각의 상황에 맞춘 오류 처리 기능을 제공한다.
이 기능을 사용하면 친절한 오류 처리 화면을 준비해서 고객에게 보여줄 수 있다.

과거에는 web.xml 이라는 파일에 다음과 같이 오류 화면을 등록했다.

• 참고)
  
  • 에러 코드가 404인 경우, 오류 페이지를 /error-page/404.html로 보여준다.
  • 에러 코드가 500인 경우, 오류 페이지를 /error-page/500.html로 보여준다.
  • 예외 타입에 따라서도, RuntimeException이 발생하면, 오류페이지를 /error-page/500.html 로 보여준다.

 

지금은 스프링 부트를 통해서 서블릿 컨테이너를 실행하기 때문에, 스프링 부트가 제공하는 기능을 사용해서 서블릿 오류 페이지를 등록하면 된다.

👉 코드로 적용해보자.

• WebServerCustomizer - 서블릿 오류 페이지 등록: src > main > java > hello > exception 패키지 내부에 WebServerCustomizer 클래스를 생성하자.
  
  • response.sendError(404) : errorPage404 호출
  • response.sendError(500) : errorPage500 호출
  • RuntimeException 또는 그 자식 타입의 예외: errorPageEx 호출
  • 500 예외가 서버 내부에서 발생한 오류라는 뜻을 포함하고 있기 때문에 여기서는 예외가 발생한 경우도 500 오류 화면으로 처리했다. (물론, 분리해도 된다.)
  • 오류 페이지는 예외를 다룰 때 해당 예외와 그 자식 타입의 오류를 함께 처리한다. 예를 들어서 위의 경우 RuntimeException 은 물론이고 RuntimeException 의 자식도 함께 처리한다
  • 오류가 발생했을 때 처리할 수 있는 컨트롤러가 필요하다. 예를 들어서 RuntimeException 예외가 발생하면 errorPageEx 에서 지정한 /error-page/500 이 호출된다.
  • 따라서 이제 해당 오류를 처리할 컨트롤러가 필요하다.

• ErrorPageController 생성: src > main > java > hello > exception > servlet 패키지 내부에 ErrorPageController 클래스를 생성하자.
  

• 오류 처리 View 생성: resources/templates 디렉토리 내부에 error-page 디렉토리를 생성하고, 내부에 404.html과 500.html을 생성하자.

• 실행해보자.
  
  • 설정한 오류 페이지가 정상 노출되는 것을 확인할 수 있다.
  • 어떻게 된걸까? 예를 들어서, /error-ex 가 요청된 경우, 해당 컨트롤러 로직에서는 예외가 발생한다. 그러면 그게 쭉 WAS까지 전달이 된다. 이때, WAS에서는 예외에 해당하는 오류 정보가 등록되어 있으므로( ErrorPage errorPageEx = new ErrorPage(RuntimeException.class, "/error-page/500"); ) 설정된 오류 정보에 해당하는 경로( /error-page/500 )를 다시 호출한다.

 

다음 내용에서는 위에서 학습한 오류 페이지가 어떻게 동작된건지 작동 원리에 대해서 자세히 알아보자.

---

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

서블릿은 Exception (예외)가 발생해서 서블릿 밖으로 전달되거나 또는 response.sendError() 가 호출 되었을 때 설정된 오류 페이지를 찾는다.

예외 발생 흐름

• 참고)
  

sendError 흐름

• 참고)
  

WAS는 해당 예외를 처리하는 오류 페이지 정보를 확인한다. ( new ErrorPage(RuntimeException.class, "/error-page/500") )

예를 들어서 RuntimeException 예외가 WAS까지 전달되면, WAS는 오류 페이지 정보를 확인한다. 확인해보니 RuntimeException 의 오류 페이지로 /error-page/500 이 지정되어 있다. WAS는 오류 페이지를 출력하기 위해 /error-page/500 를 다시 요청한다.

오류 페이지 요청 흐름

• 참고)
  

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

• 참고)
  

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

 

정리하면 다음과 같다.

• 1) 예외가 발생해서 WAS까지 전파된다.
• 2) WAS는 오류 페이지 경로를 찾아서 내부에서 오류 페이지를 호출한다. 이때 오류 페이지 경로로 필터, 서블릿, 인터셉터, 컨트롤러가 모두 다시 호출된다. ( 필터와 인터셉터가 다시 호출되는 부분은 조금 뒤에 자세히 설명하겠다. )
  • 필터와 인터셉터가 다시 호출되는 부분은 조금 뒤에 자세히 설명하겠다.

 

(참고) 오류 정보 추가

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

• ErrorPageController - 오류 출력: ErrorPageController 클래스를 다음과 같이 수정해보자.
  
  • (참고) 정의된 상수는 RequestDispatcher 에 상수로 정의되어 있으니 참고하자.

• 실행해보자. ( http://localhost:8080/error-ex 요청시)
  
  • 정상적으로 로그가 출력됨을 확인할 수 있다.
  • (참고) dispatcherType은 뒤에서 설명한다.

• 실행해보자. ( http://localhost:8080/error-404 요청시)
  
  • 정상적으로 로그가 출력됨을 확인할 수 있다.
  • 실제 예외가 발생한것은 아니므로, ERROR_EXCEPTION, ERROR_EXCEPTION_TYPE 등은 null이 출력된다.

• 실행해보자. ( http://localhost:8080/error-500 요청시)
  
  • 정상적으로 로그가 출력됨을 확인할 수 있다.
  • 실제 예외가 발생한것은 아니므로, ERROR_EXCEPTION, ERROR_EXCEPTION_TYPE 등은 null이 출력된다.
  • 메시지는 따로 작성하지 않았으므로 비어있다.

 

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 상태 코드

---

5) 서블릿 예외 처리 - 필터

예외 처리에 따른 필터와 인터셉터 그리고 서블릿이 제공하는 DispatchType 를 이해해보자.

 

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

• 참고)
  

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

DispatcherType

필터는 이런 경우를 위해서 dispatcherTypes 라는 옵션을 제공한다. 이전 강의의 마지막에 다음 로그를 추가했다. ( log.info("dispatchType={}", request.getDispatcherType()) )

그리고 출력해보면 오류 페이지에서 dispatcherType=ERROR 로 나오는 것을 확인할 수 있다. 고객이 처음 요청하면 dispatcherType=REQUEST 이다.

이렇듯 서블릿 스펙은 실제 고객이 요청한 것인지, 서버가 내부에서 오류 페이지를 요청하는 것인지 DispatcherType 으로 구분할 수 있는 방법을 제공한다.

• javax.servlet.DispatcherType
  
  • REQUEST : 클라이언트 요청
  • ERROR : 오류 요청
  • FORWARD : MVC에서 배웠던 서블릿에서 다른 서블릿이나 JSP를 호출할 때 RequestDispatcher.forward(request, response);
  • INCLUDE : 서블릿에서 다른 서블릿이나 JSP의 결과를 포함할 때 RequestDispatcher.include(request, response);
  • ASYNC : 서블릿 비동기 호출

 

필터와 DispatcherType

필터와 DispatcherType이 어떻게 사용되는지 알아보자.
(DispatcherType에 따라서 필터가 어떻게 호출되는지 테스트해보자.)

👉 코드로 확인해보자.

• LogFilter 생성: src > main > java > hello > exception > filter 패키지를 생성하고, 내부에 LogFilter 클래스를 생성하자.
  
  • 이전 섹션에서 했던 필터, 인터셉터 내용에서 필터에서 했던 예시와 같다.
  • 로그를 출력하는 부분에 request.getDispatcherType() 을 추가하였다.

• WebConfig 생성 - 필터 등록: src > main > java > hello > exception 패키지 내부에 WebConfig 클래스를 생성하자.
  
  • filterRegistrationBean.setDispatcherTypes(DispatcherType.REQUEST, DispatcherType.ERROR);
    • 이렇게 두 가지를 모두 넣으면 클라이언트 요청은 물론이고, 오류 페이지 요청에서도 필터가 호출된다. 아무것도 넣지 않으면 기본 값이 DispatcherType.REQUEST 이다. 즉 클라이언트의 요청이 있는 경우에만 필터가 적용된다. 특별히 오류 페이지 경로도 필터를 적용할 것이 아니면, 기본 값을 그대로 사용하면 된다.
    • 물론 오류 페이지 요청 전용 필터를 적용하고 싶으면 DispatcherType.ERROR 만 지정하면 된다.

• 실행해보자. ( http://localhost:8080/error-500 요청시)
  
  • 로그를 보면, 최초 클라이언트 요청시 정상적으로 LogFilter 로그가 출력되었다. 그때는 dispatcherType이 REQUEST로 들어왔다. (참고로 컨트롤러 로직에는 response.sendError가 적용되어있다.)
  • 따라서 이후에, LogFilter에 요청이 다시 들어온 로그가 확인된다. (이때 dispatcherType은 ERROR이고, 경로는 /error-page/500으로 들어온다. 서버가 다시 요청한 것이다.)

• 실행해보자. ( filterRegistrationBean.setDispatcherTypes(DispatcherType.REQUEST, DispatcherType.ERROR); 주석 처리)
  
  • 로그를 보면, 최초 클라이언트 요청시 정상적으로 LogFilter 로그가 출력되었다. (DispatcherType이 REQUEST 이므로 LogFilter는 적용 대상이 된다.)
  • 이후 오류 경로가 호출될 때는 DispatcherType이 ERROR이므로, 이때는 LogFilter가 적용되지 않은 것을 확인할 수 있다.

 

그러면 인터셉터는 어떻게 될까? 필터는 서블릿 기술이지만, 인터셉터는 스프링 기술이다. 인터셉터는 다른 방법이 필요하다.

다음 내용을 통해 알아보자.

---

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

인터셉터 중복 호출 제거

인터셉터의 경우 중복 호출을 어떻게 막을 수 있는지 알아보자.

 

👉 코드를 통해 확인해보자.

• LogInterceptor 생성: src > main > java > hello > exception > interceptor 패키지를 생성하고, 내부에 LogInterceptor 클래스를 생성하자.
  
  • 앞선 섹션에서 학습했던 코드와 거의 동일하다. (로그에 dispatcherType만 추가하였다.)

• WebConfig - 인터셉터 등록: 다음과 같이 적용하자.
  
  • 앞서 필터의 경우에는 필터를 등록할 때 어떤 DispatcherType 인 경우에 필터를 적용할 지 선택할 수 있었다. 그런데 인터셉터는 서블릿이 제공하는 기능이 아니라 스프링이 제공하는 기능이다. 따라서 DispatcherType 과 무관하게 항상 호출된다.
  • 대신에 인터셉터는 위와 같이 요청 경로에 따라서 추가하거나 제외하기 쉽게 되어 있기 때문에, 이러한 설정을 사용해서 오류 페이지 경로를 excludePathPatterns 를 사용해서 빼주면 된다.
  • (참고) 위 코드에서 /error-page/** 를 제거하면 error-page/500 같은 내부 호출의 경우에도 인터셉터가 호출된다.
  • (참고) 인터셉터와 중복으로 처리되지 않기 위해 앞의 logFilter() 의 @Bean 에 주석을 달아두자.

• 실행해보자. ( http://localhost:8080/error-500 요청시 )
  
  • 최초 요청시 LogInterceptor가 적용되어, 내부 로그가 출력됨을 확인할 수 있다.
  • 이후에 오류 경로가 호출될 때는 LogInterceptor가 적용되지 않는 것을 확인할 수 있다.

• 실행해보자. ( excludePathPatterns에서 "/error-page/**" 제거시 )
  
  • 최초 요청시 LogInterceptor가 적용되어, 내부 로그가 출력됨을 확인할 수 있다.
  • 이후에 오류 경로가 호출될 때도 LogInterceptor가 적용되어, 내부 로그가 출력됨을 확인할 수 있다.

 

전체 흐름을 정리해보자.

• (가정) /hello 정상 요청
  
  • 만약 /hello 라고 요청하면, dispatcherType이 REQUEST로 쭉 넘어간다.

• (가정) /error-ex 오류 요청
  
  • WAS에서 /error-ex 를 요청하면, 처음에는 dispatcherType이 REQUEST로 쭉 넘어간다.
  • 그런데, 컨트롤러에서 예외가 발생했다. 그래서 예외가 WAS까지 쭉 올라갔다.
  • WAS에서는 오류 정보를 체크한다.
  • 해당 오류 경로로 내부에서 다시 요청한다. (그때 dispatcherType을 ERROR로 보낸다.) 참고로 아래와 같이 필터와 인터셉터를 설정했다면, 요청 과정에서 필터와 인터셉터는 적용되지 않는다.
    • (참고) 필터는 DispatchType 으로 (내부 호출에 대한) 중복 호출 제거 ( dispatchType=REQUEST )
    • (참고) 인터셉터는 경로 정보로 (내부 호출에 대한) 중복 호출 제거( excludePathPatterns("/error-page/**") )

---

강의를 듣고 정리한 글입니다. 코드와 그림 등의 출처는 김영한 강사님께 있습니다.