Spring MVC 2편 - 예외 처리와 오류 페이지

본 게시글은 인프런 김영한 선생님 강의 스프링 MVC 2편을 완강하고 배운 것을 남기고자 적은 포스팅입니다.

 

강의 링크는 아래와 같습니다.

 

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-2/dashboard

스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 - 인프런 | 강의

 

이제 예외 처리와 오류 페이지에 대해 알아보자.

우선 스프링이 아닌 순수 서블릿 컨테이너가 예외 처리를 하는 방법부터 알아보자.

 

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

 

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

 

자바의 메인 메서드를 직접 실행하는 경우 main이라는 이름의 스레드가 실행된다.

실행 도중에 예외를 잡지 못하고 처음 실행한 main 메서드를 넘어서 예외가 던져지면, 예외 정보를 남기고 해당 스레드는 종료된다.

 

웹 애플리케이션은 사용자 요청 별로 별도의 스레드가 할당되고, 서블릿 컨테이너 안에서 실행된다.

애플리케이션 예외가 발생하면 try - catch로 예외를 잡아서 처리해야 한다. 만약 이를 못 잡고 서블릿 밖으로 까지 예외가 전달되면 어떻게 될까?

 

컨트롤러 -> 인터셉터 -> 서블릿 -> 필터 -> WAS(여기까지 전파) 

 

결국 톰캣 같은 WAS까지 전달된다. WAS는 예외가 올라오면 어떻게 처리해야 할까?

먼저 스프링이 기본적으로 제공하는 화이 트러블 예외 페이지는 꺼두자.

application.properties에 다음과 같은 코드를 작성한다.

 

server.error.whitelabel.enabled=false

 

이제 한 아래와 같은 URI로 매핑되면 컨트롤러 안에 메서드가 예외를 던진다고 생각해보자.

 

@GetMapping("/error-ex")
 public void errorEx() {
 throw new RuntimeException("예외 발생!");
 }

 

실행하면 tomcat이 제공하는 기본 오류 화면을 볼 수 있다.

웹 브라우저에서 개발자 모드로 확인해보면 HTTP 상태 코드가 500으로 보인다.

Exception의 경우 서버 내부에서 처리할 수 없는 오류가 발생한 것으로 생각해서 HTTP 상태 코드 500을 반환한다.

다른 URI로 호출하면 404 화면을 확인할 수 있다.

 

 

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

 

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

 

아래와 같이 컨트롤러 안에 코드를 추가해보자.

 

@GetMapping("/error-404")
public void error404(HttpServletResponse response) throws IOException {
 response.sendError(404, "404 오류!");
}

@GetMapping("/error-500")
public void error500(HttpServletResponse response) throws IOException {
 response.sendError(500);
}

 

sendError 흐름은 아래와 같다.

 

컨트 롤라 -> 인터셉터 -> 서블릿 -> 필터 -> WAS(sendError 호출 기록 확인)

 

response.sendError()를 호출하면 response 내부에는 오류가 발생했다는 상태를 저장해둔다.

그리고 서블릿 컨테이너는 고객에게 응답 전에 response에 sendError()가 호출되었는지 확인한다.

그리고 호출되었다면 설정한 오류 코드에 맞추어 기본 오류 페이지를 보여준다.

 

아래와 같은 URI를 실행하면 서블릿 컨테이너가 기본으로 제공하는 오류 화면을 볼 수 있다.

 

http://localhost:8080/error-ex

http://localhost:8080/error-404

http://localhost:8080/error-500

 

서블릿 컨테이너가 제공하는 기본 예외 처리 화면은 속된 말로 못생겼다.

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

 

과거에는 web.xml이라는 파일에 오류 화면을 등록했다. 이 코드는 중요하지 않으므로 생략하겠다.

 

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

 

아래와 같은 코드를 작성한다.

 

@Component
public class WebServerCustomizer implements
WebServerFactoryCustomizer<ConfigurableWebServerFactory> {

 @Override
 public void customize(ConfigurableWebServerFactory factory) {
     ErrorPage errorPage404 = new ErrorPage(HttpStatus.NOT_FOUND, "/errorpage/404");
     ErrorPage errorPage500 = new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR, "/error-page/500");
     ErrorPage errorPageEx = new ErrorPage(RuntimeException.class, "/errorpage/500");
     //오류 페이지 등록
     
     
     factory.addErrorPages(errorPage404, errorPage500, errorPageEx);
     }
}

 

참고로 오류 페이지는 예외를 다룰 때 해당 예외와 그 자식 타입의 오류를 함께 처리한다. 예를 들어서 위의 경우 RuntimeException 은 물론이고 RuntimeException의 자식도 함께 처리한다.

 

이제 컨트롤러에다가 아래 코드를 추가한다.

 

@RequestMapping("/error-page/404")
 public String errorPage404(HttpServletRequest request, HttpServletResponse 
response) {
     log.info("errorPage 404");
     return "error-page/404";
 }
 
 @RequestMapping("/error-page/500")
 public String errorPage500(HttpServletRequest request, HttpServletResponse 
response) {
     log.info("errorPage 500");
     return "error-page/500";
 }

 

이제 오류 처리를 할 error-page 디렉터리 안에 404.html, 500 html을 만들면 된다. HTML 뷰 작성은 넘어가자.

그럼 이제 URI로 매핑을 하면 ErrorPage들이 전부 정상적으로 렌더링 된다.

 

 

이제 서블릿 예외 처리에서 오류 페이지 작동 원리를 알아보자.

우리는 위에서 예외 발생 흐름과 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에 추가해서 넘겨준다. 그러면 오류 페이지에서 이렇게 전달된 오류 정보를 사용할 수 있다.

 

 

서블릿 예외 처리 - 필터

 

예외 발생과 오류 페이지 요청 흐름을 마지막으로 정리하겠다.

 

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

 

오류가 발생하면 오류 페이지를 출력하기 위해 서버 내부에서 다시 URI에 대해 요청이 발생한다. 그러면 다시 필터, 서블릿, 인터셉터가 호출되는데 이는 매우 비효율적이다.

결국 클라이언트로부터 발생한 정상 요청인지, 아니면 오류 페이지를 출력하기 위한 내부 요청인지 구분할 수 있어야 한다. 서블릿은 이런 문제를 해결하기 위해 DispatcherType이라는 추가 정보를 제공한다.

 

필터는 이런 경우를 위해서 dispatcherTypes라는 옵션을 제공한다.

아래와 같은 코드를 작성하고 출력해보면 오류 페이지에서 dispatchType=ERROR로 나오는 것을 확인할 수 있다.

 

log.info("dispatchType={}", request.getDispatcherType())

 

다양한 DispatcherType가 존재한다.

 

• FORWARD : 다른 서블릿이나 JSP를 호출할 때
• INCLUDE : 서블릿에서 다른 서블릿이나 JSP의 결과를 포함할 때
• REQUEST : 클라이언트 요청
• ASYNC : 서블릿 비동기 호출
• ERROR : 오류 요청

 

이제 아래와 같은 코드를 작성해보겠다.

 

@Configuration
public class WebConfig implements WebMvcConfigurer {

 @Bean
 public FilterRegistrationBean logFilter() {
     FilterRegistrationBean<Filter> filterRegistrationBean = new
    FilterRegistrationBean<>();
     filterRegistrationBean.setFilter(new LogFilter());
     filterRegistrationBean.setOrder(1);
     filterRegistrationBean.addUrlPatterns("/*");
     
     //여기가 중요
     filterRegistrationBean.setDispatcherTypes(DispatcherType.REQUEST,DispatcherType.ERROR);
     
     
     return filterRegistrationBean;
 }
}

 

filterRegistrationBean.setDispatcherTypes(DispatcherType.REQUEST, DispatcherType.ERROR);

이렇게 두 가지를 모두 넣으면 클라이언트 요청은 물론이고, 오류 페이지 요청에서도 필터가 호출된다. 아무것도 넣지 않으면 기본 값이 DispatcherType.REQUEST이다. 즉 클라이언트의 요청이 있는 경우에만 필터가 적용된다. 특별히 오류 페이지 경로도 필터를 적용할 것이 아니면, 기본 값을 그대로 사용하면 된다. 물론 오류 페이지 요청 전용 필터를 적용하고 싶으면 DispatcherType.ERROR 만 지정하면 된다.

 

 

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

 

앞서 필터의 경우에는 필터를 등록할 때 어떤 DispatcherType 인 경우에 필터를 적용할지 선택할 수 있었다. 그런데 인터셉터는 서블릿이 제공하는 기능이 아니라 스프링이 제공하는 기능이다. 따라서 DispatcherType과 무관하게 항상 호출된다.

 

대신에 인터셉터는 다음과 같이 요청 경로에 따라서 추가하거나 제외하기 쉽게 되어 있기 때문에, 이러한 설정을 사용해서 오류 페이지 경로를 excludePathPatterns를 사용해서 빼주면 된다.

 

@Configuration
public class WebConfig implements WebMvcConfigurer {

 @Override
 public void addInterceptors(InterceptorRegistry registry) {
     registry.addInterceptor(new LogInterceptor())
     .order(1)
     .addPathPatterns("/**")
     .excludePathPatterns(
     "/css/**", "/*.ico"
     , "/error", "/error-page/**" //오류 페이지 경로
     );
 }
}

 

정리하면! /error-ex로 오류 요청이 가면

 

• 필터는 DispatchType로 중복 호출 제거
• 인터셉터는 경로 정보로 중복 호출 제거

 

 

지금까지는 WebServerCustomizer를 만들고 예외 종류에 따라 ErrorPage를 추가하고 예외 처리용 컨트롤러를 만드는 복잡한 과정을 거쳐 예외 처리 페이지를 만들었다.

 

사실!!! 스프링 부트는 이런 과정을 모두 기본으로 제공한다.

 

• ErrorPage를 자동으로 등록한다. 이때 /error라는 경로로 기본 오류 페이지를 설정한다.
  • new ErrorPage("/error") , 상태 코드와 예외를 설정하지 않으면 기본 오류 페이지로 사용된다.
  • 서블릿 밖으로 예외가 발생하거나, response.sendError(...)가 호출되면 모든 오류는 /error를 호출하게 된다.
• BasicErrorController라는 스프링 컨트롤러를 자동으로 등록한다.
  • ErrorPage에서 등록한 /error를 매핑해서 처리하는 컨트롤러다.

 

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

 

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

 

뷰 선택 우선순위는 아래와 같다.

 

• 뷰 템플릿 (ex resources/template/error/500.html)
• 정적 리소스 (ex resources/static/error/400.html)
• 적용 대상이 없을 때 뷰 이름 (ex error.html)

해당 경로에 HTTP 상태 코드 이름의 뷰 파일을 넣어두면 된다.

뷰 템플릿이 정적 리소스보다 우선순위가 높고, 404, 500처럼 구체적인 것이 5XX처럼 덜 구체적인 것보다 우선순위가 높다. 5xx, 4xx라고 하면 500대, 400대 오류를 처리해준다.

 

이제 오류 뷰 템플릿 4xx.html, 500.html, 404.html을 작성했다고 생각하자.

그리고 오류 테스트를 진행하면 오류 페이지가 정상적으로 렌더링 된다.

 

참고로 BasicController는 오류 정보를 model에 담아서 뷰에 전달한다. 뷰는 이 값들을 활용할 수 있다.

 

정리하자면 스프링 부트의 기능을 활용하자! 이를 활용하면 정말 쉽게 오류 페이지를 다룰 수 있다.