스프링 오류 페이지

예외 처리

서블릿 예외 처리

• Exception
• response.sendError (Http 상태 코드)

웹 애플리케이션에서는 사용자의 요청별로 별도의 Thread가 할당되고, 서블릿 컨테이너 안에서 실행된다. try-catch로 예외를 잡아서 처리하면 문제가 없지만 애플리케이션에서 예외를 잡지 못하고, 서블릿 밖으로 예외를 전달하면 WAS까지 예외가 전달된다.

• 서블릿 예외 컨트롤러

@Slf4j
@Controller
public class ServletExController {

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

yml에서 whitelabel.enabled=false 설정을 해준다면 tomcat이 기본으로 제공하는 오류 화면을 볼 수 있다.

• response.sendError

HttpServletResponse가 제공하는 sendError라는 메서드를 사용하여, 서블릿 컨테이너에게 오류가 발생했다는 점을 전달할 수 있따.

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

    @GetMapping("/error-404")
    public void error404(HttpServletResponse response) throws IOException {
        // response 통해 error를 넣어줄 수 있다.
        response.sendError(404, "404 오류!");
    }

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

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

response.sendError()를 호출하면 response 내부에 오류가 발생했다는 정보를 저장할 수 있다.

서블릿 오류 페이지 제공

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

• 오류 페이지 등록

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

오류가 발생했을 경우 처리해줄 수 있는 컨트롤러가 필요하기 때문에 별도로 만들어 준다.

@Slf4j
@Controller
public class ErrorPageController {

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

localhost:8080/error-page/404을 입력하였을 경우 위와 같은 에러 페이지를 확인할 수 있다.

서블릿 오류 페이지 작동 원리

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

예외 발생 흐름

WAS ← 필터 ← 서블릿 ← 인터셉터, ← 컨트롤러(예외발생)

sendError 흐름

WAS ← 필터 ← 서블릿 ← 인터셉터 ← 컨트롤러(response.sendError())

WAS는 현재 오류 페이지의 정보를 확인하고 그에 맞는 오류 페이지를 보여준다.예를 들어 RuntimeException의 오류 페이지로 /error-page/500이 지정되어 있으면 이거에 맞는 페이지를 다시 요청하여 출력해준다.

WAS `/error-page/500` 재요청 → 필터 → 서블릿 → 인터셉터 → 컨트롤러 호출(/error-page/500) → view

즉, 예외가 발생하면 WAS까지 전파되고 WAS에서 다시 오류 페이지를 컨트롤러로 보내주는 형식이다.
WAS는 오류 페이지를 단순히 다시 요청만 하는 것이 아니라, 오류 정보를 request의 attribute에 추가해서 넘겨주기까지 한다.

• 담아줄 수 있는 정보

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

서블릿 예외 처리 필터

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

public enum DispatcherType {
 	FORWARD, // JSP 호출
 	INCLUDE, / 서블릿에서 다른 서블릿이나 JSP 결과 포함
 	REQUEST, // 클라이언트 요청
 	ASYNC, // 비동기 호출
 	ERROR // 오류 요청
}

@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) {
            log.info("EXCEPTION {}", e.getMessage());
            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> 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이다.), 오류 페이지 요청 전용 필터를 적용하고 싶다면 ERROR만 지정하면 된다.

서블릿 예외처리 인터셉터

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

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

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

excludePathPatterns()을 통하여 오류 페이지 경로를 뺴줄 수 있다.

• 인터셉터 흐름 정리

WAS(/error-ex, dispatchType=REQUEST) → 필터 → 서블릿 → 인터셉터 → 컨트롤러
WAS ← 필터 ← 서블릿 ← 인터셉터 ← 컨트롤러(예외발생)
WAS 오류 페이지 확인
WAS(/error-ex, dispatchType=REQUEST) → 필터(x) → 서블릿 → 인터셉터(x) → 컨트롤러(errorPage) → view

스프링 부트로 예외 페이지 처리하기

지금까지 Spring을 이용해서 예외처리 하기까지 복잡한 과정을 경험하였다. 하지만 부트를 이용하면 지금까지 과정을 스프링 부트에서 모두 제공해준다.
BasicErrorController라는 스프링 컨트롤러를 자동으로 등록해준다.

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

해당 경로 위치에 HTTP 상태 코드 이름의 뷰 파일을 넣어두면 스프링 부트가 view를 띄워준다.

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

하지만 model에 너무 많은 정보를 저장해서 보내면 보안상 문제가 되기 때문에 적당히 클라이언트가 이해할 수 있는 정보들만 보여주는 것이 가장 바람직하다.