[Spring] ExceptionHandler , ErrorPage(예외 처리, 오류 페이지)

Spring/Spring MVC - 활용

[Spring] ExceptionHandler , ErrorPage(예외 처리, 오류 페이지)

진이최고다 2023. 9. 13. 22:55

서블릿 예외 처리

서블릿 환경에서의 예외 처리에 대해 이해하려면 웹 애플리케이션의 구조와 동작원리를 알아야 한다.

1. 예외 처리 방법

서블릿에서 예외 처리는 주로 두 가지 방법으로 처리된다.

Exception을 통한 처리
respon.sendError(상태 코드, 오류 메시지)를 통한 처리

2. 자바 직접 실행 vs 웹 애플리케이션

자바 직접 실행

자바의 메인 메서드를 직접 실행하는 경우 main이라는 이름의 쓰레드가 실행된다. 실행 도중에 예외를 처리하지 않으면, 처음 실행한 main() 메서드를 넘어 예외 정보가 출력되고, 해당 쓰레드는 종료된다.

웹 애플리케이션

웹 애플리케이션에서는 각 사용자 요청마다 별도의 쓰레드가 생성된다.이러한 쓰레드들은 서블릿 컨테이너 내에서 동작한다. 만약 웹 애플리케이션 내에서 예외가 발생하고 이를 적절히 처리하지 않으면, 예외는 서블릿 컨테이너까지 전파된다.

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

3. WAS의 예외 처리

일반적으로 서블릿 컨테이너는 설정에 따라 사용자에게 특정 오류 페이지를 보여주거나 로그를 남긴다.

이렇게 함으로써 사용자는 애플리케이션 내부의 실제 오류 내용을 보지 못하게 하여 보안을 유지하면서, 개발자는 로그를 통해 오류를 파악할 수 있다.

4. 스프링 부트의 기본 예외 페이지

스프링 부트는 기본적으로 예외 발생 시 특정 오류 페이지를 제공한다.

하지만 이 기능을 비 활성화라면 'application.properties' 파일에 다음 설정을 추가해야 한다.

server.error.whitelabel.enabled=false

이렇게 설정하면, 스프링 부트의 기본 오류 페이지 기능이 꺼지게 되어 순수 서블릿 컨테이너의 예외 처리 방식을 볼 수 있다.

ServletExController - 서블릿 예외 컨트롤러

1. 기본 예외 처리

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

런타임 예외를 발생 시키며, 이를 실행하면 톰캣의 기본 오류 페이지인 'HTTP Satus 500 - Internal Server Error' 를 볼 수 있다. 이는 서버 내부에서 처리할 수 없는 오류로 간주되어 HTTP 상태코드 500을 반환한다.

2. 404 오류 페이지

웹 브라우저에서 존재하지 않는 페이지를 요청하면 'HTTP Status 404 - Not Found' 화면이 표시된다.

3. response.sendError() 사용

'HttpServletResponse' 에서 제공하는 'sendError' 메서드는 오류를 전달하는 데 사용된다. 이 메서드를 통해 HTTP 상태 코드와 선택적인 오류 메시지를 함께 전달할 수 있다.

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

4.sendError 흐름

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

'response.sendError()'를 호출하면, 이 메서드는 response 객체 내에 오류 정보를 저장한다. 서블릿 컨테이너는 클라이언트에 응답을 보내기 전에 이 오류 정보를 확인하고, 오류가 있을 경우 해당 오류에 맞는 기본 오류 페이지를 제공한다.

5. 오류 화면 예시

http://localhost:8080/error-ex (HTTP Status 500 – Internal Server Error)
http://localhost:8080/error-404 (HTTP Status 404 – Bad Request)
http://localhost:8080/error-500 (HTTP Status 500 – Internal Server Error)

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

오류 페이지는 사용자에게 친화적이지 않기 때문에, 사용자에게 오류 메시지를 제공할 필요가 있다.

서블릿은 Exception이 발생해서 서블릿 밖으로 전달되거나, response.sendError()가 호출되었을 떄 각각의 상황에 맞춘 오류 처리 기능을 제공한다. 이 기능을 사용하면 오류 처리 화면을 사용자에게 보여줄 수 있다.

1. 오류 페이지 등록 전통적인 방법 : web.xml

과거에는 'web.xml' 파일을 사용하여 오류 페이지를 등록하였다.

다음과 같은 형식으로 404오류, 500오류, 런타임 예외에 대한 오류 페이지를 지정할 수 있다.

<web-app>
    <error-page>
        <error-code>404</error-code>
        <location>/error-page/404.html</location>
    </error-page>
    <error-page>
        <error-code>500</error-code>
        <location>/error-page/500.html</location>
    </error-page>
    <error-page>
        <exception-type>java.lang.RuntimeException</exception-type>
        <location>/error-page/500.html</location>
    </error-page>
</web-app>

2. 스프링 부트를 이용한 오류 페이지 등록

스프링 부트를 사용할 경우, 서블릿 컨테이너의 설정을 직접 변경할 수 있다.

'WebServerFactoryCustomizer' 인터페이스를 구현하여, 오류 페이지를 추가하는 방법은 다음과 같다.

@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 과 함께 자식도 함께 처리된다.

오류 페이지 처리

실제로 오류 페이지를 호출할 때, 오류 상황에 따른 로직 처리와 응답를 위한 컨트롤러를 구현할 필요가 있다. 예를 들어서 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");
        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";
    }

}

오류 처리 view

오류 처리를 위한 사용자 친화적인 화면을 제공하기 위해서는 특정 View 제공해야 하며, 미리 정의된 오류 페이지는 사용자에게 오류 발생 사실을 알려주며 동시에 웹 사이트의 기본 디자인 및 브랜드를 유지할 수 있게 도와준다.

<!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>404 오류 화면</h2>
    </div>
    <div>
        <p>오류 화면 입니다.</p>
    </div>
    <hr class="my-4">
</div> <!-- /container -->
</body>
</html>

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

1. 예외 발생 흐름

컨트롤러에서 예외가 발생하면 그 예외는 인터셉터, 서블릿, 필터를 거쳐서 최종적으로 WAS(웹 애플리케이션 서버)까지 전파된다.

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

2. 오류 페이지 요청

WAS는 예외를 처리할 오류 페이지의 경로를 찾아 내부에서 해당 경로로 요청을 다시 한다. 이때 필터, 서블릿, 인터셉터, 컨트롤러가 모두 다시 호출되며, 결과적으로 오류 페이지의 View가 반환된다.

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

3.DispatcherType

필터는 이런 경우를 위해서 dispatcherTypes 옵션을 제공한다.

@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));
        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=REQUEST 이다. 이렇듯 서블릿 스펙은 실제 사용자가 요청한 것인지, 서버가 내부에서 오류 페이지를 요청하는 것인지 'DispatcherType' 으로 구분할 수 있는 방법을 제공한다.

REQUEST : 클라이언트 요청
ERROR : 오류 요청
FORWARD : 서블릿에서 다른 서블릿이나 JSP 호출 - RequestDispatcher.forward(request, response);
ASYNC : 서블릿 비동기 호출

필터와 DispatcherType

필터는 요청과 응답을 가로채서 원하는 작업을 수행할 수 있는 기능이다. 'DispatcherType'은 필터가 어떤 종류의 디스패처 요청에 반응해야 하는지 지정하는 열거형이다.

1. LogFiler - DispatcherType 로그 추가

@Slf4j
public class LogFilter implements Filter {
    ...
    @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);
        }
    }
    ...
}

2. WebConfig

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

이렇게 두 가지를 모두 넣으면 클라이언트 요청은 물론, 오류 페이지 요청에서도 필터가 호출된다. 아무것도 넣지 않으면 기본 값이 DispatcherType.REQUEST 이다. 즉, 클라이언트의 요청이 있는 경우에만 필터가 적용된다. 반대로 오류 페이지 요청 전용 필터를 적용하고 싶으면 DispatcherType.Error 만 지정하면 된다.

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

인터셉터 중복 호출 제거

1. Loginterceptor - DispatcherType 로그 추가

@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과 무관하게 항상 호출된다.

2. WebConfig

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

@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() {
        ...
    }
}

3. 전체 흐름

정상 요청 '/hello'

1. WAS(/hello, dispatcherType=REQUEST) -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러 -> view

/error-ex 오류 요청

필터는 DispatcherType 으로 중복 호출 제거 (dispatcherType=REQUEST)
인터셉터는 경로 정보로 중복 호출 제거(excludePathPatterns("/error-page/**))

1. WAS(/error-ex, dispathcerType=REQUEST) -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러
2. WAS <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러(예외발생)
3. WAS 오류 페이지 확인
4. WAS(/error-page/500, dispathcherType=ERROR) -> 필터(x) -> 서블릿 -> 인터셉터(x) -> 컨트롤러(/error-page/500) -> View

스프링 부트 - 오류 페이지 처리

1. 기본 제공 기능

스프링 부트는 기본적으로 오류 페이지 처리 기능을 제공한다.
오류 발생 시 '/error' 경로로 기본 오류 페이지를 출 한다.
'BasicErrorController' 라는 스프링 컨트롤러를 기본으로 제공해 해당 경로('/error')를 처리한다.

2. 뷰 선택 우선 순위

'BasicErrorController' 의 오류 페이지 선택 기준은 다음과 같다.

2.1 뷰 템플릿 - 예 : 'resource/templates/error/500.html'
2.2 정적 리소스 - 예 : 'resource/static/error/404.html'
2.3 적용 대상이 없을 때 기본 뷰 이름 - 'resource/templates/error.html'

3. 오류 정보 사용

'BalsicErrorController' 는 여러 오류 정보를 model에 담아 view에 전달한다. 뷰 템플릿은 이 값을 활용해서 정보들을 출력할 수 있다.

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

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

사용자에게 민감한 정보(오류원인)를 노출하는 것은 바람직 하지 않으므로, 사용자가 해당 정보를 읽으면 혼란만 더해지고, 보안상 문제가 될 수 있다.그래서 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.include-exception=true
server.error.include-message=on_param
server.error.include-stacktrace=on_param
server.error.include-binding-errors=on_param

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

never : 사용하지 않음
always : 항상 사용
on_param : 파라미터가 있을 때 사용

http://localhost:8090/error-ex?message=&errors=&trace=

on_param 은 파라미터가 있으면 해당 정보를 노출한다. 디버그 시 문제를 확인하기 위해 사용할 수 있다. 그런데 이 부분도 개발 서버에서 사용할 수 있지만, 운영 서버에서는 권장하지 않는다.

on_param 으로 설정하고 다음과 같이 HTTP 요청시 파라미터를 전달하면 해당 정보들이 model에 담겨서 뷰 템플릿에서 출력된다.

4. 스프링부트 오류 관련 옵션

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

출처 : 인프런 - 🔗 스프링 MVC 2 - 백엔드 개발 활용 기술by 우아한형제 김영한님