서블릿 예외 처리 - 시작

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

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

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

Exception(예외)

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

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

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

결국 톰갯 같은 WAS 까지 예외가 전달된다. WAS는 예외가 올라오면 어떻게 처리해야 할까?
한번 테스트 해보자.

package hello.exception.servlet;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.GetMapping;
@Slf4j
@Controller
 public class ServletExController {
     @GetMapping("/error-ex")
     public void errorEx() {
throw new RuntimeException("예외 발생!"); }
}

실행해보면 다음처럼 tomcat이 기본으로 제공하는 오류 화면을 볼 수 있다.

HTTP Status 500 – Internal Server Error

웹 브라우저에서 개발자 모드로 확인해보면 HTTP 상태 코드가 500으로 보인다.
Exception의 경우 서버 내부에서 처리할 수 없는 오류가 발생한 것으로 생각해서 HTTP 상태 코드 500을 반환한다.

아무 사이트나 호출하면

톰캣이 기본으로 제공하는 404 오류 화면을 볼 수 있다.

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

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

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

ServletController - 추가

@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.sendError()를 호출하면 response내부에는 오류가 발생했다는 상태를 저장해둔다.
그리고 서블릿 컨테이너는 고객에게 응답 전에 response에 sendError() 가 호출되었는지 확인한다. 그리고 호출되었다면 설정한 오류 코드에 맞추어 기본 오류 페이지를 보여준다.

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

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

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

서블릿은 Exception이 발생해서 서블릿 밖으로 전달되거나 또는 response.sendError() 가 호출 되었을 때 각각의 상황에 맞춘 오류 처리 기능을 제공한다.

이 기능을 사용하면 친절한 오류 처리 화면을 준비해서 고객에게 보여줄 수 있다.

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

<web-app>
     <error-page>
     <error-code>404</error-code>
     <location>/error-page/404.html</location>
     </error-page>
     <error-page>
     <error-code>500</error-code>
     <location>/error-page/500.html</location>
     </error-page>
     <error-page>
     <exception-type>java.lang.RuntimeException</exception-type>
     <location>/error-page/500.html</location>
     </error-page>
 </web-app>

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

서류 오류 페이지 등록

@Component
public class WebServerCustomizer
  implements WebServerFactoryCustomizer<ConfigurableWebServerFactory> {
  @Override
  public void customize(ConfigurableWebServerFactory factory) {

    ErrorPage errorPage404 = new ErrorPage(HttpStatus.NOT_FOUND, "/error-page/404");
    ErrorPage errorPage500 = new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR, "/error-page/500");
    ErrorPage errorPageEx = new ErrorPage(RuntimeException.class, "/error-page/500");

    factory.addErrorPages(errorPage404, errorPage500, errorPageEx);
  }
}

500 예외가 서버 내부에서 발생한 오류라는 뜻을 포함하고 있기 때문에 여기서는 예외가 발생한 경우 500 오류 화면으로 처리함

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

오류가 발생했을 때 처리할 수 있는 컨트롤러가 필요하다. 예를 들어서 RuntimeException 예외가 발생하면 errorPageEx에서 지정한 /error-page/500이 호출된다.

해당 오류를 처리할 컨트롤러가 필요하다.

@Slf4j
@Controller
public class ErrorPageController {

  @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";
  }
}

그리고 resources/templates/error-page/404.html, resources/templates/error-page/500.html 파일을 생성하자.

그리고 실행해보면 404, 500 각각 에러코드에 따른 html 파일에서 만든 화면이 보이게 된다.

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

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

예외 발생 흐름
WAS(여기까지 전파) <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러(예외발생)

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

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

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

중요한 점은 웹 브라우저는 서버 내부에서 이런일이 일어나는지 전혀 모른다는점이다,. 오직 서버 내부에서 오류 페이지를 렌더링하기 위해 추가적인 호출을 하는 것이다.

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

서블릿 예외 처리 - 필터

목표
예외 처리에 따른 필터와 그리고 서블릿이 제공하는 DispatchType 이해하기

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

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

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

DispatcherType

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

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

이러한 로그를 추가하고 출력해보면 오류 페이지에서 dispatchType=ERROR 로 나오는 것을 확인할 수 있다.

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

public enum DispatcherType {
     FORWARD,
     INCLUDE,
     REQUEST,
     ASYNC,
     ERROR
}

필터와 DispatherType

LogFilter - DispatcherType 로그 추가

package hello.exception.filter;
 import lombok.extern.slf4j.Slf4j;
 import javax.servlet.*;
 import javax.servlet.http.HttpServletRequest;
 import java.io.IOException;
 import java.util.UUID;
 @Slf4j
 public class LogFilter implements Filter {
     @Override
     public void init(FilterConfig filterConfig) throws ServletException {
         log.info("log filter init");
     }
@Override
     public void doFilter(ServletRequest request, ServletResponse response,
 FilterChain chain) throws IOException, ServletException {
         HttpServletRequest httpRequest = (HttpServletRequest) request;
         String requestURI = httpRequest.getRequestURI();
         String uuid = UUID.randomUUID().toString();
         try {
             log.info("REQUEST  [{}][{}][{}]", uuid, request.getDispatcherType(),
 requestURI);
             chain.doFilter(request, response);
         } catch (Exception e) {
             throw e;
         } finally {
             log.info("RESPONSE [{}][{}][{}]", uuid, request.getDispatcherType(),
 requestURI);
         }
}
     @Override
     public void destroy() {
         log.info("log filter destroy");
     }
}

로그를 출력하는 부분에 request.getDispatherType()을 추가해두었다.

WebConfig

 package hello.exception;
 import hello.exception.filter.LogFilter;
 import org.springframework.boot.web.servlet.FilterRegistrationBean;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 import javax.servlet.DispatcherType;
 import javax.servlet.Filter;
 @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);
이렇게 두 가지를 모두 넣으면 클라이언트 요청은 물론이고, 오류 페이지 요청에서도 필터가 호출된다.
아무것도 넣지 않으면 기본 값이 REQUEST이다.]

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

LogInterceptor - DispatcherType 로그 추가

package hello.exception.interceptor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.web.servlet.HandlerInterceptor;
 import org.springframework.web.servlet.ModelAndView;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import java.util.UUID;
 @Slf4j
 public class LogInterceptor implements HandlerInterceptor {
     public static final String LOG_ID = "logId";
@Override
     public boolean preHandle(HttpServletRequest request, HttpServletResponse
 response, Object handler) throws Exception {
         String requestURI = request.getRequestURI();
         String uuid = UUID.randomUUID().toString();
         request.setAttribute(LOG_ID, uuid);
         log.info("REQUEST  [{}][{}][{}][{}]", uuid, request.getDispatcherType(),
 requestURI, handler);
         return true;
     }
@Override
     public void postHandle(HttpServletRequest request, HttpServletResponse
 response, Object handler, ModelAndView modelAndView) throws Exception {
         log.info("postHandle [{}]", modelAndView);
     }
     @Override
     public void afterCompletion(HttpServletRequest request, HttpServletResponse
 response, Object handler, Exception ex) throws Exception {
         String requestURI = request.getRequestURI();
         String logId = (String)request.getAttribute(LOG_ID);
         log.info("RESPONSE [{}][{}][{}]", logId, request.getDispatcherType(),
 requestURI);
         if (ex != null) {
             log.error("afterCompletion error!!", ex);
         }
    } 
}

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

대신에 인터셉터는 다음과 같이 요청 경로에 따라서 추가하거나 제외하기 쉽게 되어 있기 때문에, 이러한 설정을 사용해서 오류 페이지 경로를 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-page/** 를 제거하면 error-page/500 같은 내부 호출의 경우에도 인터셉터가 호출된다.

전체 흐름 정리

/hello 정상 요청
WAS(/hello, dispatherType=REQUEST) -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러 -> View

/error-ex 오류 요청

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

=> 위의 필터와 인터셉터의 기능으로 오류가 발생하고 그 오류가 WAS까지 가고 오류 페이지를 보여주기 위해 WAS에서 다시 컨트롤러로 갈 때, 필터와 인터셉터를 안거치고 컨트롤러까지 가서 View를 뿌려줄 수 있는 것이다.

스프링 부트 - 오류 페이지

지금까지 예외 처리 페이지를 만들기 위해 다음과 같은 복잡한 과정을 거쳤다.

• WebServerCutomizer 만듥도
• 예외 종류에 따라서 ErrorPage를 추가하고
  • 예외 처리용 컨트롤러 ErrorPageController 를 만듬

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

• ErrorPage를 자동으로 등록한다. 이때 /error 라는 경로로 기본 오류 페이지를 설정한다.
• BasicErrorController 라는 스프링 컨트롤러를 자동으로 등록한다.
  • ErrorPage에서 등록한 /error를 매핑해서 처리하는 컨트롤러이다.

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

정리
스프링 부트가 기본으로 제공하는 오류 페이지를 활용하면 오류 페이지와 관련된 대부분의 문제는 손쉽게 해결할 수 있다.