[Spring] 예외 처리와 오류 페이지

기술 스택

JDK 17
Gradle
Spring Boot 3.3.5
Thymeleaf

1. 서블릿 예외 처리 - 시작

스프링이 아닌 순수 서블릿 컨테이너는 두가지 방식으로 예외 처리를 지원한다.

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

Exception (예외)

1. 자바 직접 실행

자바의 메인 메서드를 직접 실행하는 경우 main이라는 이름의 쓰레드가 실행된다.

실행 도중에 예외를 잡지 못하고 처음 실행한 main( ) 메서드를 넘어서 예외가 던져지면, 예외 정보를 남기고 해당 쓰레드는 종료된다.

2. 웹 어플리케이션

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

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

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

먼저 스프링 부트가 제공하는 기본 예외 페이지가 있는데 먼저 꺼두도록 하겠다.

application.properties

server.error.whitelabel.enabled=false

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

서블릿이 제공하는 오류 화면 기능을 사용해보겠다. 서블릿은 Exception이 발생해서 서블릿 밖으로 전달되거나 또는 response.sendError( )가 호출 되었을 때 각각에 상황에 맞춘 오류 처리 기능을 제공한다.

과거에는 web.xml이라는 파일에 오류화면을 등록했으나 지금은 스프링 부트를 통해서 서블릿 컨테이너가 실행하기 때문에, 스프링 부트가 제공하는 기능을 사용해서 서블릿 오류 페이지를 등록하면 된다.

패키지 최상단에 클래스를 만들어서 작성해보자.

WebServerCustomizer.java

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

@Component
public class WebServerCustomizer implements WebServerFactoryCustomizer<ConfigurableServletWebServerFactory> {
    
    @Override
    public void customize(ConfigurableServletWebServerFactory factory) {

        // 상태코드
        ErrorPage errorPage404 = new ErrorPage(HttpStatus.NOT_FOUND, "/error-page/404");
        ErrorPage errorPage500 = new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR, "/error-page/500");

        // exception 발생했을 때
        ErrorPage errorPageEx = new ErrorPage(RuntimeException.class, "/error-page/500");

        factory.addErrorPages(errorPage404, errorPage500, errorPageEx);
    }
}

이렇게 한다면 response.send(404)가 호출되면 errorPage404가 호출되고, response.send(500)이 호출되면 errorPage500이 호출 되며, RumtimeException 부터 자식 타입의 예외까지 errorPageEx를 호출하게 된다.

이제 해당 오류를 처리할 컨트롤러와 view 파일을 만들어 보겠다.

ErrorPageController.java

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

@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";
    }
    // 이하 생략..
 }

/templates/error-page/404.html

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

실행해보면 다음과 같은 화면이 뜨면서 정상 작동하는 것을 볼 수 있다.

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

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

예외 발생 흐름
- 컨트롤러 (예외 발생) -> 인터셉터 -> 서블릿 -> 필터 -> WAS
sendError 흐름
- 컨트롤러 -> 인터셉터 -> 서블릿 -> 필터 -> WAS (sendError 호출 기록 확인 )

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

오류 페이지 요청 흐름

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

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

정리하자면 예외가 발생하면 WAS로 전파된다. 그리고 WAS는 내부에서 오류페이지를 다시 호출한다. 이때 오루페이지 경로로 필터, 서블릿, 인터셉터, 컨트롤러가 모두 다시 호출된다.

4. 서블릿 예외 처리 - 필터

위에서 설명한 것과 같이 오류 페이지를 호출한다고 해서 해당 필터가 호출되는 것은 매우 비효율 적이다. 그래서 클라이언트로 부터 발생한 정상 요청인지, 아니면 오류 페이지를 출력하기 위한 내부 요청인지 구분할 수 있어야 한다.

DispatcherType

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

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

고객이 처음 요청하면 dispatcherType=REQUEST이다. 오류 요청은 ERROR이다.

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

필터와 DispatcherType

Logfilter.java

import jakarta.servlet.*;
import jakarta.servlet.http.HttpServletRequest;
import lombok.extern.slf4j.Slf4j;
import java.io.IOException;
import java.util.UUID;

@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) {
            log.info("exception :{}", e.getMessage());
            throw e;
        }
        finally {
            log.info("RESPONSE [{}][{}][{}]", uuid, request.getDispatcherType(),
                    requestURI);
        }
    }
    // 이하 생략
 }

WebConfig.java

@Configuration
public class WebConfig implements WebMvcConfigurer {
	@Bean
    public FilterRegistrationBean<Filter> 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이다.

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

인터셉터 중복 호출 제거

LogInterceptor.java

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

앞서 필터의 경우에는 DispathcerType인 경우에 필터를 적용할 지 선택할 수 있었다.

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

WebConfig.java

import hello.exception.interceptor.LogInterceptor;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@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 과 다른 강력한 excludePathPatterns 가 있다.
    }
 }

'Spring Framework' 카테고리의 다른 글

[Spring] API 예외 처리 (1)	2024.11.15
[Spring] Bean Validation (검증) - 2 (0)	2024.11.04
[Spring] Bean Validation (검증) - 1 (4)	2024.10.31
[Spring] 스프링 메시지, 국제화 (1)	2024.10.29
[Spring] Argument Resolver 란? (0)	2024.10.24

기술 스택

1. 서블릿 예외 처리 - 시작

Exception (예외)

1. 자바 직접 실행

2. 웹 어플리케이션

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

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

4. 서블릿 예외 처리 - 필터

DispatcherType

필터와 DispatcherType

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

인터셉터 중복 호출 제거

'Spring Framework' 카테고리의 다른 글

티스토리툴바