김영한 - 스프링 MVC 2편 - 백엔드 웹 개발 핵심 기술 8일차

예외 처리와 오류 페이지

 

서블릿 예외 처리 

 

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

· Exception(예외)

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

 

Exception(예외)

웹 애플리케이션

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

애플리케이션에서 예외를 잡지 못하고 서블릿 밖으로 예외가 전달되면 어떻게 동작할까?

 

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

 

스프링 부트가 제공하는 기본 예외 페이지가 있다. 실습을 위해 이건 꺼두었다.

 

aaplication.properties

server.error.whitelabel.enabled=false

 

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

 

오류가 발생했을때 HttpServletResponse가 제공하는 sendError라는 메서드를 사용해도 된다.

이것을 호출한다고 당장 예외가 발생하는 것은 아니지만, 서블릿 컨테이너에게 오류가 발생했다는 점을 전달할 수 있다.

 

package hello.exception.servlet;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@Slf4j
@Controller
public class ServletExController {

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

    }

    @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가 호출 되었는지 확인한다.

호출 되었다면 설정한 오류 코드에 맞추어 기본 오류 페이지를 보여준다.

 

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

 

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

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

 

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

package hello.exception.servlet;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

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

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

 

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

new ErrorPage(RuntiomeException.class , "/error-page/500")

WAS는 오류 페이지를 출력 하기 위해 /error-page/500를 다시 요청한다.

 

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

 

1. WAS <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러(예외발생)

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

 

WAS는 오류 페이지 경로를 찾아서 내부에서 오류 페이지를 호출한다. 이때 오류 페이지 경로로 필터, 서블릿, 인터셉터, 컨트롤러가 모두 다시 호출된다.

 

오류 정보 추가

 

package hello.exception.servlet;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Slf4j
@Controller
public class ErrorPageController {

    //RequestDispatcher 상수로 정의되어 있음
    public static final String ERROR_EXCEPTION = "javax.servlet.error.exception";
    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";
    public static final String ERROR_EXCEPTION_TYPE = "javax.servlet.error.exception_type";

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

    }
}

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이라는 추가 정보를 제공한다.

 

DispatcherType

 

REQUEST : 클라이언트 요청 ERROR : 오류 요청

FORWARD : MVC에서 배웠던 서블릿에서 다른 서블릿이나 JSP를 호출할 때

RequestDispatcher.forward(request, response);

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

RequestDispatcher.include(request, response);

ASYNC : 서블릿 비동기 호출

 

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

filterRegistrationBean.setDispatcherTypes(DispatcherType.REQUEST, DispatcherType.ERROR);

이렇게 두 가지를 모두 넣으면 클라이언트 요청, 오류 페이지 요청에 필터가 호출된다.

아무것도 넣지 않으면 DispatcherType.REQUEST 이다.

클라이언트 요청이 이쓴 경우에만 필터가 적용된다.

 

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

 

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

인터셉터는 스프링이 제공하는 기능이기 때문에 필터의 DispatcherType 과 무관하게 항상 호출된다.

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

 

package hello.exception;

import hello.exception.filter.LogFilter;
import hello.exception.interceptor.LogInterceptor;
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.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import javax.servlet.DispatcherType;
import javax.servlet.Filter;
import javax.servlet.FilterRegistration;

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

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

 

스프링 부트 오류 페이지 

예외 처리 페이지를 만들기 위해 WebServerCustomizer 를 만들고 ErrorPageController 를 만들고 복잡한 과정이 있었다.

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

ErrorPage를 자동으로 등록한다. /error라는 경로로 기본 오류페이지를 설정한다.

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

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

 

뷰 선택 우선 순위

1. 뷰 템플릿

resources/templates/error/500.html

resources/templates/error/5xx.html

 

2.정적 리소스

resources/static/error/400.html

 

3.적용 대상이 없을 때 뷰 이름

resources/templates/error.html

 

뷰 템플릿이 정적 리소스보다 우선순위가 높고, 404, 500 처럼 구체적인 것이 5xx보다 높다.

 

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>
        <p>오류 화면 입니다.</p>
    </div>
    <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>

 

오류 관련 내부 정보들을 고객에게 노출하는 것은 좋지 않다.

그래서 BasicErrorController  컨트롤러에서 오류정보를 model에 포함할지 여부를 선택할 수 있다.

 

server.error.include-exception=true
server.error.include-message=on_param
server.error.include-stacktrace=on_param
server.error.include-binding-errors=on_param

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 포함 여부

 

기본 값이 never인 부분은 3가지 옵션을 사용할 수 있다.

never : 사용하지 않음

always : 항상 사용

on_param : 파라미터가 있을 때 사용

 

실무에서는 이것들을 노출하면 안된다!

사용자에게는 이쁜 오류 화면과 고객이 이해할 수 있는 간단한 오류 메시지를 보여주고 오류는 서버에 로그로 남겨서 로그로 확인해야 한다.

 

출처

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-2