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

이 글은 인프런 김영한님의 Spring 강의를 바탕으로 개인적인 정리를 위해 작성한 글입니다.

---

서블릿 예외 처리

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

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

 

Exception(예외)

자바 직접 실행

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

 

웹 애플리케이션

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

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

결국 톰캣 같은 WAS 까지 예외가 전달된다.

WAS 에 예외가 전돨되면 WAS(톰캣 등)에서 기본적으로 제공하는 오류 페이지를 보여준다.(스프링부트가 기본적으로 제공하는 whitelabel 페이지를 말하는 것이 아님)

 

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

오류가 발생했을 때 HttpServletResponse 가 제공하는 sendError 라는 메서드를 사용해도 된다. 이것을 호출 한다고 당장 예외가 발생하는 것은 아니지만, 서블릿 컨테이너에게 오류가 발생했다는 점을 전달할 수 있다.

이 메서드를 사용하면 HTTP 상태 코드와 오류 메시지도 추가할 수 있다.

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

@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() 가 호출되었는지 확인한다. 그리고 호출 되었다면 설정한 오류 코드에 맞추어 기본 오류 페이지를 보여준다.

 

 

오류 화면 제공

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

이 기능을 사용하면 친절한 오류 처리 화면을 준비해서 고객에게 보여줄 수 있다. 과거에는 web.xml 이라는 파일에 다음과 같이 오류 화면을 등록했다.

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

 

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

@Component
public class WebServerCustomizer implements WebServerFactoryCustomizer<ConfigurableWebServerFactory> {
    @Override
    public void customize(ConfigurableWebServerFactory factory) {
        ErrorPage errorPage404 = new ErrorPage(HttpStatus.NOT_FOUND, "/error-page/404"); //errorPage404 호출
        ErrorPage errorPage500 = new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR, "/error-page/500"); //errorPage500 호출
        ErrorPage errorPageEx = new ErrorPage(RuntimeException.class, "/error-page/500"); //RuntimeException 또는 그 자식 타입의 예외 -> errorPage500 호출

        factory.addErrorPages(errorPage404, errorPage500, errorPageEx); //위에서 설정한 오류페이지 등록
    }
}

오류 페이지는 예외를 다룰 때 해당 예외와 그 자식 타입의 오류를 함께 처리한다. 예를 들어서 위의 경우 RuntimeException 은 물론이고 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";
    }
}

 

오류 페이지 작동 원리

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

 

예외 발생 흐름

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

 

sendError 흐름

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

WAS는 해당 예외를 처리하는 오류 페이지 정보를 확인한다.
→new ErrorPage(RuntimeException.class, "/error-page/500")

예를 들어서 RuntimeException 예외가 WAS까지 전달되면, WAS는 오류 페이지 정보를 확인한다.

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

 

오류 페이지 요청 흐름

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

 

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

1. WAS(여기까지 전파) <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러(예외발생)
2. WAS (/error-page/500 다시 요청) -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러(/error-page/ -> View

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

 

정리하면 다음과 같다.

-예외가 발생해서 WAS까지 전파된다.

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

 

오류 정보 추가

WAS는 오류 페이지를 단순히 다시 요청만 하는 것이 아니라, 오류 정보를 `request` 의 `attribute` 에 추가해서 넘 겨준다.
필요하면 오류 페이지에서 이렇게 전달된 오류 정보를 사용할 수 있다.

@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"; //클라이언트 요청 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"; //HTTP 상태 코드

    @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: ex= {}", 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(여기까지 전파) <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러(예외발생)

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

오류가 발생하면 오류 페이지를 출력하기 위해 WAS 내부에서 다시 한번 호출이 발생한다. 이때 필터, 서블릿, 인터셉터도 모두 다시 호출된다.

 

그런데 로그인 인증 체크 같은 경우를 생각해보면, 이미 한번 필터나, 인터셉터에서 로그인 체크를 완료했다. 따라서 서버 내부에서 오류 페이지를 호출한다고 해서 해당 필터나 인터셉터가 한번 더 호출되는 것은 매우 비효율적이다. 

 

결국 클라이언트로부터 발생한 정상 요청인지, 아니면 오류 페이지를 출력하기 위한 내부 요청인지 구분할 수 있어야 한다. 서블릿은 이런 문제를 해결하기 위해 DispatcherType이라는 추가 정보를 제공한다.

 

DispatcherType

필터는 dispatcherTypes라는 옵션을 제공한다. 

위에 오류 정보 추가 부분에서 아래와 같은 dispatchType 로그를 출력하는 코드가 있었다.

log.info("dispatchType={}", request.getDispatcherType())

출력해보면 오류 페이지에서 dispatchType=ERROR로 나오는 것을 확인할 수 있다. 고객이 처음 요청하면 dispatcherType=REQUEST 이다.

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

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

• REQUEST: 클라이언트로부터 직접 받은 요청을 처리할 때 사용된다. 일반적으로 웹 브라우저나 다른 클라이언트로부터 서블릿이 직접 호출될 때의 요청 유형이다.
• FORWARD: 한 서블릿 또는 JSP에서 다른 자원(서블릿, JSP, HTML 파일 등)으로 요청을 전달할 때 사용된다. RequestDispatcher.forward() 메소드를 통해 요청이 전달된다.
• INCLUDE: 한 서블릿 또는 JSP에서 다른 자원의 출력을 현재 응답에 포함시킬 때 사용된다. RequestDispatcher.include() 메소드를 통해 요청이 처리된다.
• ERROR: 오류 페이지를 처리할 때 사용된다. 서블릿이나 JSP 실행 중에 오류가 발생했을 때, 웹 애플리케이션의 정의된 오류 페이지로 자동으로 요청이 전달된다.
• ASYNC: 비동기 처리 방식에서 사용된다. 서블릿 3.0 스펙 이상에서 지원되며, ServletRequest.startAsync()를 호출하여 시작된 비동기 작업을 처리할 때 이 유형이 사용된다.

 

@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 이다. 즉 클라이언트의 요청이 있는 경우에만 필터가 적용된다. 특별히 오류 페이지 경로도 필터를 적용할 것이 아니면, 기본 값을 그대로 사용하면 된다.

 

인터셉터

@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 를 사용해서 빼주면 된다.

 

정리

/hello 정상 요청

WAS(/hello, dispatchType=REQUEST) -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러 -> View

 

/error-ex 오류 요청

→필터는 DispatchType 으로 중복 호출 제거 ( dispatchType=REQUEST)

→인터셉터는 경로 정보로 중복 호출 제거( excludePathPatterns("/error-page/**") )

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

 

스프링 부트 오류 페이지

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

WebServerCustomizer를 만들고, 예외 종류에 따라서 ErrorPage를 추가하고, 예외 처리용 컨트롤러 ErrorPageController를 만듬

 

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

• ErrorPage를 자동으로 등록한다. 이때 /error 라는 경로로 기본 오류 페이지를 설정한다.
• new ErrorPage("/error"), 상태코드와 예외를 설정하지 않으면 기본 오류 페이지로 사용된다.
• 서블릿 밖으로 예외가 발생하거나, response.sendError(...) 가 호출되면 모든 오류는 /error 를 호출하게 된다.

 

스프링 부트에서 예외가 발생하거나 response.sendError() 메서드가 호출되어 HTTP 오류 응답이 생성되면, 내부적으로 /error URL로 이동하여 오류 처리를 진행한다. 스프링 부트는 /error 경로를 처리하는 기본 오류 컨트롤러인 BasicErrorController를 자동으로 등록한다.

 

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

 

스프링 부트는 개발자가 쉽게 오류 페이지를 처리할 수 있도록 자동 구성과 기본적인 메커니즘을 제공한다. 이는 오류 처리에 관련된 복잡한 설정을 대폭 간소화해 준다. 스프링 부트의 오류 처리 과정을 좀 더 자세히 살펴보자.

기본 오류 페이지 등록

스프링 부트는 내부적으로 /error 경로에 대한 기본 오류 페이지를 자동으로 등록한다. 이는 개발자가 별도로 ErrorPage를 등록하지 않아도, 애플리케이션에서 발생하는 모든 오류를 처리할 수 있는 기본적인 설정을 제공한다는 의미이다. 기본 오류 페이지는 상태 코드와 특정 예외 유형에 따라 다르게 동작할 수 있도록 설계되어 있다.

BasicErrorController

스프링 부트는 BasicErrorController라는 컨트롤러를 자동으로 등록하여 /error 경로로 오는 요청을 처리한다. 이 컨트롤러는 HTTP 요청의 헤더를 확인하여 요청이 HTML 페이지를 원하는지, 아니면 JSON 형태의 오류 메시지를 원하는지 판단하고, 적절한 형식의 응답을 반환한다. 따라서 개발자는 특별한 설정 없이도 다양한 클라이언트의 요구에 맞는 오류 응답을 제공할 수 있다.

자동 구성을 통한 오류 페이지 등록

ErrorMvcAutoConfiguration 클래스는 스프링 부트의 자동 구성 중 하나로, 애플리케이션의 오류 페이지 설정을 자동으로 처리한다. 이 구성 클래스는 ErrorPage 등록, BasicErrorController 설정 등 오류 처리와 관련된 다양한 부분을 자동으로 구성한다. 개발자는 이 기능을 통해 오류 처리를 위한 별도의 구성 작업 없이, 바로 오류 처리 로직을 개발하는 데 집중할 수 있다.

오류 처리의 이점

스프링 부트의 이러한 접근 방식은 오류 처리를 위한 복잡한 설정 과정 없이도, 애플리케이션 내에서 발생하는 다양한 오류 상황을 효과적으로 관리할 수 있게 해준다. 또한, 애플리케이션의 오류 페이지를 쉽게 커스터마이즈할 수 있도록 지원하며, 오류 발생 시 사용자에게 보다 친절한 메시지와 정보를 제공할 수 있게 해준다. 이는 애플리케이션의 사용성과 안정성을 높이는 데 중요한 역할을 한다.

 

오류가 발생했을 때 오류 페이지로 /error 를 기본 요청한다. 스프링 부트가 자동 등록한 BasicErrorController 는 이 경로를 기본으로 받는다.

스프링 부트로 오류처리는 만약에 오류가 발생하면 /error url로 이동하고, 해당 컨트롤러는 이미 구현되어 있기 때문에, 오류 페이지만 만들면 된다.

 

 

개발자는 오류 페이지만 등록

BasicErrorController 는 기본적인 로직이 모두 개발되어 있다.
개발자는 오류 페이지 화면만 BasicErrorController 가 제공하는 룰과 우선순위에 따라서 등록하면 된다. 정적 HTML이면 정적 리소스, 뷰 템플릿을 사용해서 동적으로 오류 화면을 만들고 싶으면 뷰 템플릿 경로에 오류 페이지 파 일을 만들어서 넣어두기만 하면 된다.

 

뷰 선택 우선순위

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 상태 코드 이름의 뷰 파일을 넣어두면 된다.
뷰 템플릿이 정적 리소스보다 우선순위가 높고, 404, 500처럼 구체적인 것이 5xx처럼 덜 구체적인 것 보다 우선순위가 높다.
5xx, 4xx 라고 하면 500대, 400대 오류를 처리해준다.

 

스프링 부트 오류 관련 옵션

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