[Spring]스프링 MVC 2편 - 예외 처리와 오류 페이지

📝서블릿 예외 처리 

스프링 예외 처리를 이해하기 위해선 순수 서블릿 컨테이너의 예외를 어떻게 처리하는지 알아야 한다. 

 

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

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

Exception (예외)

자바 직접 실행

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

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

 

웹 애플리케이션

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

애플리케이션에서 예외가 발생했는데, 어디선가 try - catch로 예외를 잡아 처리하면 문제가 없다.

다만 예외를 잡지 못하고 서블릿 밖으로 까지 예외가 전달되면 어떻게 될까?

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

결국 톰캣 같은 WAS까지 예외가 전달된다. WAS는 예외가 올라오면 서버 내부에서 처리할 수 없는 오류가 발생한 것으로

생각하여 HTTP 상태 코드 500을 반환한다.

 

response.sendError()

오류가 발생했을 때 HttpServletResponse가 제공하는 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()가 호출되었는지 확인한다. 그리고 호출되었다면 설정한 오류 코드에 맞추고 기본 오류 페이지를 보여준다.

 

📝서블릿 오류 처리 - 오류 화면 등록

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

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

 

public class WebServercustomizer implements WebServerFactoryCustomizer<ConfigurableWebServerFactory> {

  @Override
  public void customize(ConfigurableWebServerFactory factory) {
    ErrorPage errorPage404 = new ErrorPage(HttpStatus.NOT_FOUND, "/error-page/400");
    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);
  }
}

 

ErrorPage errorPage404 = new ErrorPage(HttpStatus.NOT_FOUND, "/error-page/400");
해당 코드는 오류 페이지를 등록하는 것이다. 즉 NOT_FOUND 발생시 "/error-page/400" 로 이동하라는 뜻이다.

 

또한 오류 페이지는 예외를 다룰 때 해당 예외와 그 자식 타입의 오류를 함께 처리한다. 예를 들어서 위의 경우

RuntimeException 은 물론이고 RuntimeException 의 자식도 함께 처리한다.

 

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

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

 

📝서블릿 예외 처리의 작동 원리

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

 

예외 발생 흐름

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

 

sendError 흐름

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

 

WAS는 해당 예외를 처리하는 오류 페이지 정보를 확인한다. (아까 오류 화면 등록했던 것)

public class WebServercustomizer implements WebServerFactoryCustomizer<ConfigurableWebServerFactory> {

  @Override
  public void customize(ConfigurableWebServerFactory factory) {
    ErrorPage errorPage404 = new ErrorPage(HttpStatus.NOT_FOUND, "/error-page/400");
    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 오류가 발생하면 WAS에서 오류 페이지 정보를 확인해  "/error-page/500"의 정보를 얻고 오류 페이지 출력을 위해 /error-page/500 를 다시 요청한다.

 

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

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

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

 

 

정확한 순서는 다음과 같다.

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

 

🚩오류 정보 추가

WAS는 오류 페이지를 단순히 다시 요청하는 것만 아니라, 오류 정보를 request의 attribute에 추가해 넘겨준다.

필요하면 해당 정보를 볼 수 있다.

 

오류 정보는 다음과 같다.

 public static final String ERROR_EXCEPTION ="javax.servlet.error.exception";
 public static final String ERROR_EXCEPTION_TYPE ="javax.servlet.error.exception_type";
 public static final String ERROR_MESSAGE = "javax.servlet.error.message";
 public static final String ERROR_REQUEST_URI ="javax.servlet.error.request_uri";
 public static final String ERROR_SERVLET_NAME ="javax.servlet.error.servlet_name";
 public static final String ERROR_STATUS_CODE ="javax.servlet.error.status_code";

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

 

 

📝서블릿 예외 처리 - 필터 

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

 

오류가 발생하면 오류 페이지를 출력하기 위해 WAS 내부에서 다시 한번 호출이 발생한다. 

여기서 한 가지 문제가 있다.

생각해보자
이미 한번 필터나, 인터셉터에서 로그인 체크를 완료했는데,
서버 내부 오류 페이지 호출을 위해 다시 한번 호출하는 것은 매우 비효율적이다.

 

결국 클라이언트로 부터 발생한 정상 요청인지, 아니면 오류 페이지를 출력하기 위한 것인지 구분해야한다. 

서블릿은 이러한 문제를 해결하기 위해 DispatcherType 이라는 추가 정보를 제공한다.

 

DispatchType

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

우리는 위의 포스팅에서 오류 정보를 출력해보았다. 

그리고 오류 페이지 출력은 서 dispatchType=ERROR 로 나오는 것을 확인할 수 있었다.

 

고객이 처음 요청하면 dispatchType의 상태가 REQUEST이다. 

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

 

javax.servlet.DispatcherType

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

필터의 doFilter

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

해당 방식으로 필터에 구분을 넣을 수 있다.

  @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);

 

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

인터셉터도 중복을 줄일 수 있다.

 

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

인터셉터는 필터처럼 DispatcherType을 설정할 수 없다. 

그러나 인터셉터는 강력한 패턴 활용을 통해 오류 페이지 경로에 대한 검사를 제외할 수 있다. 

 

 

 

📝스프링 부트 - 오류 페이지 

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

• WebServerCustomizer
• 예외 종류에 따라서 ErrorPage 추가
  • 예외 처리용 컨트롤러 추가 
  • 필터, 인터셉터 중복 제거 

 

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

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

개발자는 오류 페이지만 등록해주면 된다.

BasicErrorController는 기본적인 로직이 모두 개발되어 있다.

개발자는 오류 페이지 화면만 BasicErrorController가 제공하는 룰과 우선순위에 따라 등록만 하면 된다. 

 

뷰 선택 우선순위

1. 뷰 템플릿
   • resources/templates/error/500.html
   • resources/templates/error/5xx.html
2. 정적 리소스
   • resources/static/error/400.html
   • resources/static/error/404.html
   • resources/static/error/4xx.html
3. 적용 대상이 없을 때 뷰 이름
   • resources/templates/error.html

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

참고로 우선순위는 무조건 구체적인것 우선이다.

 

🚩 BasicErrorController가 제공하는 기본 정보

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`)

trace 같은 정보는 보안상 문제가 발생할 수 있기 때문에 BasicErrorController 오류 컨트롤러에서 다음 오류 정보를 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 포함 여부

 

스프링 부트 오류 관련 옵션

server.error.whitelabel.enabled=true : 오류 처리 화면을 못 찾을 시, 스프링 whitelabel 오 류 페이지 적용 server.error.path=/error : 오류 페이지 경로, 스프링이 자동 등록하는 서블릿 글로벌 오류 페이지 경로와BasicErrorController 오류 컨트롤러 경로에 함께 사용된다.

 

 

 

✔정리

우리는 스프링 부트가 제공하는 오류 관련 옵션의 구현에 대해 알아보았다. 물론 스프링 부트가 기능으로 사용하면 구현을 안해도 되지만 원리 정도는 알아둬야 한다고 생각한다.