스프링 예외처리, 오류페이지

본 포스트는 김영한님의 인프런강의 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술을 보고 정리한 포스트입니다. 자세한 내용은 강의를 참고해주세요.

 

*예외처리, 오류페이지

고객이 웹페이지를 이용함에 있어서 예외가 발생하거나 오류가 발생할 때를 대비해 오류페이지를 커스텀하여 만들면 좋은데 스프링부트가 제공하는 기본 오류페이지는 디자인적으로나 가독성면에서 좋지못하다. 그렇기 때문에 개발자는 고객을 위한 오류페이지를 따로 만들어야 한다.

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

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

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

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

위의 예제를 실행해보면 tomcat이 기본으로 제공하는 오류화면을 볼 수 있다. 

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

    @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, "500오류!");
    }

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


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

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

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

오류가 발생햇을 때 처리할 수 있는 컨트롤러가 필요하다. 예를 들어서 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";
    }
}

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

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

서블릿 밖으로 전달된 예외 혹은 오류가 WAS에서 해당 예외를 처리하는 오류 페이지 정보를 확인한다.

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

그럼 오류 페이지 요청 흐름은 다음과 같다
WAS -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러(예외 발생) -> 인터셉터 -> 서블릿 -> 필터 -> WAS (/error-page/500 다시요청) -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러 -> View

오류가 발생하면 오류 페이지를 출력하기 위해 WAS내부에서 다시 한번 호출이 발생한다. 이때 필터, 서블릿, 인터셉터도 모두 다시 호출된다. 그런데 로그인 인증 체크 같은 경우를 생각해보면, 이미 한번 필터나 인터셉터에서 로그인 체크를 완료했다. 따라서 서버 내부에서 오류 페이지를 호출한다고 해서 해당 필터나 인터셉터가 한번 더 호출되는 것은 매우 비효율적이다. 

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

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

필터를 등록할 때 setDispatcherType메소드를 적어주면 디폴트값이 DispatcherType.REQUEST이기 때문에 DispatcherType.ERROR로 요청하는 것은 걸러지게 된다. 

인터셉터는 excludePathPatterns에 오류페이지를 호출하는 url을 추가해주기만 하면 된다.

그렇게 되면 오류페이지의 요청 흐름은 이렇게 바뀐다.

원래 : WAS -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러(예외 발생) -> 인터셉터 -> 서블릿 -> 필터 -> WAS (/error-page/500 다시요청) -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러 -> View

개선 : WAS -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러(예외 발생) -> 인터셉터 -> 서블릿 -> 필터 -> WAS(오류 페이지 확인) -> 필터(X) -> 서블릿 -> 인터셉터(X) -> View

이렇듯 필터와 인터셉터를 거치지 않고 곧바로 View를 호출한다. 

위의 방법은 스프링부트를 전혀 사용하지 않고 쓰는 방법이다. 그렇다면 스프링 부트는 어떻게 이 문제를 해결할까?


*예외처리 오류페이지 - 스프링부트
지금까지 예외 처리 페이지를 만들기 위해서 다음과 같은 복잡한 과정을 거쳤다.
1. WebServerCustomizer (오류 등록)
2. 예외 종류에 따라서 ErrorPage를 추가
3. 예외 처리용 컨트롤러를 만듦

스프링 부트는 이런 과정을 모두 기본으로 제공한다.
ErrorPage를 자동 등록하고, /error라는 경로로 기본 오류 페이지를 설정한다. 또한 컨트롤러 또한 자동으로 등록되어 개발자가 아주 편하게 개발할 수 있도록 자동화를 완료했다.

그럼 이제 스프링 부트를 이용하여 오류페이지를 커스텀 해보자
1. resources에 templates혹은 static폴더에 error라는 디렉토리를 만든다.
2. 스프링 부트에서 제공하는 규칙에 따라 html파일을 만든다. (404.html, 5xx.html)

예를 들어 페이지가 존재하지 않다면 404.html을 호출한다. 404.html이 없다면 4xx.html이 호출된다. 4xx.html마저도 없으면 error.html이 호출된다. error.html도 없으면 스프링 부트가 제공하는 기본 오류 페이지인 whitelabel을 보여준다.