예외처리와 오류 페이지

서블릿 예외 처리

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

 

서블릿은 두가지 방식의 예외처리를 지원한다.

- Exception 

- response.sendError(상태코드, 메세지)

 

웹 애플리케이션에서 예외를 잡지 못했을 때

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

(스프링 부트가 제공하는 예외 페이지 설정은 꺼두자.)

 

package hello.exception.servlet;

import jakarta.servlet.http.HttpServletResponse;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

import java.io.IOException;

@Slf4j
@Controller
public class ServletExceptionController {

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

 

애플리케이션을 실행하면 다음과 같은 화면이 출력된다.

 

 

우리가 평소에 보던 화면과 다르다.

이 화면이 톰캣이 기본으로 제공하는 오류 화면이다.

 

@Slf4j
@Controller
public class ServletExceptionController {
    @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를 사용하면 당장 예외가 발생하는것은 아니지만, 서블릿 컨테이너에게 오류가 발생했다는 점을 전달할 수 있다.

 

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

 

위 기본 에러화면은 사용자가 보기 불편하다. 의미 있는 오류 화면을 제공해보자

 

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

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

package hello.exception;

import org.springframework.boot.web.server.ConfigurableWebServerFactory;
import org.springframework.boot.web.server.ErrorPage;
import org.springframework.boot.web.server.WebServerFactoryCustomizer;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;

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

 

Httpstatus에 맞는 경로로 이동해주는 코드이다.

참고로 RuntimeException은 자식 예외까지 모두 포함된다.

package hello.exception.servlet;

import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

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

 

(View 코드는 생략)

그럼 해당 HttpStatus에 맞는 페이지로 이동된다.

 

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

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

WAS는 해당 예외를 처리하는 오류 페이지 정보를 확인한다.

new Error(RuntimeException.class, "/error-page/500")

 

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

 

오류 페이지 요청 흐름

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

 

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

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

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

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

 

오류 정보 추가

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

package hello.exception.servlet;

import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Slf4j
@Controller
public class ErrorPageController {
    //RequestDispatcher 상수로 정의되어 있음
    public static final String ERROR_EXCEPTION = "jakarta.servlet.error.exception";
    public static final String ERROR_EXCEPTION_TYPE = "jakarta.servlet.error.exception_type";
    public static final String ERROR_MESSAGE = "jakarta.servlet.error.message";
    public static final String ERROR_REQUEST_URI = "jakarta.servlet.error.request_uri";
    public static final String ERROR_SERVLET_NAME = "jakarta.servlet.error.servlet_name";
    public static final String ERROR_STATUS_CODE = "jakarta.servlet.error.status_code";

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

        return "error-page/404";
    }

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

        return "error-page/500";
    }

    private void printErrorInfo(HttpServletRequest request) {
        log.info("ERROR_EXCEPTION: {}", request.getAttribute(ERROR_EXCEPTION));
        log.info("ERROR_EXCEPTION_TYPE: {}", request.getAttribute(ERROR_EXCEPTION_TYPE));
        log.info("ERROR_MESSAGE: {}", request.getAttribute(ERROR_MESSAGE)); //ex의 경우 NestedServletException 스프링이 한번 감싸서 반환
        log.info("ERROR_REQUEST_URI: {}", request.getAttribute(ERROR_REQUEST_URI));
        log.info("ERROR_SERVLET_NAME: {}", request.getAttribute(ERROR_SERVLET_NAME));
        log.info("ERROR_STATUS_CODE: {}", request.getAttribute(ERROR_STATUS_CODE));
        log.info("dispatchType={}", request.getDispatcherType());
    }
}

 

 

서블릿 예외처리 - 필터

예외처리에 따른 필터와 인터셉터 그리고 서블릿이 제공하는 DispatcherType 이해하기

 

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

 

결국 클라이언트에 대한 요청인지, 아니면 오류 페이지를 출력하기 위한 내부 요청인지 구분할 수 있어야한다. 

DispatcherType을 활용하면 해결할 수 있다.

 

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by FernFlower decompiler)
//

package jakarta.servlet;

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

    private DispatcherType() {
    }
}

 

- REQUEST : 클라이언트 요청

- ERROR : 오류 요청

- FORWARD : 서블릿에서 다른 서블릿이나 JSP를 호출

- INCLUDE :  서블릿에서 다른 서블릿이나 JSP 결과를 포함

- ASYNC : 서블릿 비동기 호출

@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.getDispatcherType() 추가

 

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Bean
    public FilterRegistrationBean logFilter() {
        FilterRegistrationBean<Filter> filterFilterRegistrationBean = new FilterRegistrationBean<>();
        filterFilterRegistrationBean.setFilter(new LogFilter());
        filterFilterRegistrationBean.setOrder(1);
        filterFilterRegistrationBean.addUrlPatterns("/*");
        filterFilterRegistrationBean.setDispatcherTypes(DispatcherType.REQUEST, DispatcherType.ERROR);

        return filterFilterRegistrationBean;
    }
}

 

setDispatcherTypes에 REQUEST, ERROR 두가지를 넣으면 클라이언트 요청, 오류 페이지 요청에서도 필터가 호출된다.

아무것도 적지 않을경우 (setDispatcherTypes를 선언하지 않을경우) default value는 REQUEST

 

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

이번에는 인터셉터 중복 호출을 제거해보자

package hello.exception.interceptor;

import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

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

 

크게 달라진건 없고 log.info에 getDispatcherType()을 추가했다.

@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/**");// 오류 페이지 경로
    }
}

 

인터셉터는 DispatcherType을 따로 설정할 수 있었다. 하지만 인터셉터는 없다. 인터셉터는 서블릿이 제공하는게 아니라 스프링이 제공하는 기능이다. 따라서 DispatcherType과 무관하게 항상 호출된다.

 

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

1. WAS(/error-ex, dispatchType=REQUEST) -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러

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

3. WAS 오류 페이지 확인

4. WAS(/error-page/500, dispatchType=ERROR) -> 필터(x) -> 서블릿 -> 인터셉터(x) -> 컨트롤러(/error-page/500) -> View

 

컨트롤러에서 예외가 터지면 WAS (톰캣)이 그 예외를 잡고, 설정된 내부 예외 페이지로 foward해준다. 이 때 WAS는 이건 예외처리 흐름이다라고 표시하기 위해 DispatchType을 ERROR로 바꿔서 요청을 다시 보낸다.

 

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

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

- WebServerCustomizer 생성

- 예외 종류에 따라서 ErrorPage 추가

- 예외 처리용 컨트롤러 ErrorPageController 생성

 

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

- ErrorPage 자동 등록. 기본 경로는 /error

- new ErrorPage("/error"), 상태코드와 예외를 설정하지 않으면 기본 오류 페이지로 사용된다.

- 서블릿 박에서 예외가 발생하거나 response.sendError()가 호출되면 모둔 오류는 /error 호출

- BasicErrorController라는 스프링 컨트롤러를 자동으로 등록 (ErrorPage에서 등록한 /error를 매핑해서 처리하는 컨트롤러)

 

WebServerCustomizer의 @Component를 주석으로 처리하자

 

이제 오류가 발생했을 때 오류페이지로 /error를 기본으로 요청한다. 

 

개발자는 오류 페이지만 등록하면 된다

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

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

정적 HTML이면 정적 리소스, 뷰 템플릿을 사용해서 동적으로 오류 화면을 만들고 싶으면 뷰 템플릿 경로에 만들어 넣으면 된다.

 

뷰 선택 우선순위

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. 적용 대상이 없을때 뷰 이름(error)

- resources/templates/error.html

 

구체적인것부터 덜 구체적인 순으로 우선순위가 높다.

 

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

BasicErrorController는 다음 정보를 model에 담아서 뷰에 전달한다. 이 값을 활용해서 출력할 수 있다.

<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="utf-8">
</head>
<body>
<div class="container" style="max-width: 600px">
    <div class="py-5 text-center">
        <h2>500 오류 화면 스프링 부트 제공</h2>
    </div>
    <div>
    </div>
    <p>오류 화면 입니다.</p>
    <ul>
        <li>오류 정보</li>
        <ul>
            <li th:text="|timestamp: ${timestamp}|"></li>
            <li th:text="|path: ${path}|"></li>
            <li th:text="|status: ${status}|"></li>
            <li th:text="|message: ${message}|"></li>
            <li th:text="|error: ${error}|"></li>
            <li th:text="|exception: ${exception}|"></li>
            <li th:text="|errors: ${errors}|"></li>
            <li th:text="|trace: ${trace}|"></li>
        </ul>
        </li>
    </ul>
    <hr class="my-4">
</div> <!-- /container -->
</body>
</html>

 

 

이런 정보를 제공할 순 있으나, 왠만하면 쓰지말자. 보안 이슈가 있고 고객이 볼 내용은 아니다.

오류는 서버에 로그를 남겨서 로그를 확인해야 한다.

 

공통 처리 컨트롤러의 기능을 변경하고싶으면 ErrorController 인터페이스를 상속받아 구현하거나 BasicErrorController를 상속받아서 기능을 추가하면 된다.