[스프링MVC2편] 섹션 8. 예외 처리와 오류 페이지 - 서블릿 예외처리

1. 프로젝트 생성

 

우선, 스프링이 아닌 순수 서블릿 컨테이너는 어떻게 예외 처리를 하는지 알아보자!

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

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

 

2. Exception(예외)

개요

자바 직접 실행

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

 

웹 애플리케이션

• 웹 애플리케이션은 사용자 요청별로 별도의 쓰레드가 할당되고, 서블릿 컨테이너 안에서 실행됨
• 애플리케이션에서 예외가 발생했는데, 예외를 잡지 못하고 서블릿 밖까지 예외가 전달된다면...?

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

• 결국 톰캣같은 WAS까지 예외가 전달된다.
•  WAS는 예외가 올라오면 어떻게 처리할지 아래 실습에서 확인해 보자!

 

실습

application.properties

• 스프링 부트가 제공하는 기본 예외 페이지는 잠시 꺼두자.

server.error.whitelabel.enabled=false

 

ServletExController

package me.progfrog.exception.sevlet;

import jakarta.servlet.http.HttpServletResponse;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

import java.io.IOException;

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

 

실행해 보면, 톰캣이 기본으로 제공하는 오류 화면을 볼 수 있다.

 

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

개요

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

sendError 흐름

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

• response.sendError()를 호출하면 response 내부에는 오류가 발생했다는 상태를 저장해 둠
• 서블릿 컨테이너는 클라이언트 응답 전에 response에 sendError()가 호출되었는지 확인해서, 설정한 오류 코드에 맞춰 기본 오류 페이지를 보여줌!
• 스프링 부트가 제공하는 기능을 사용해서, 서블릿 오류 페이지를 등록할 수도 있음!
• 오류 페이지는 예외를 다를 때 해당 예외와 그 자식 타입의 오류를 함께 처리

 

실습 1 - 오류 화면 미제공

ServletExController

package me.progfrog.exception.sevlet;

import jakarta.servlet.http.HttpServletResponse;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

import java.io.IOException;

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

 

실습 2 - 오류 화면 제공

WebServerCustomizer

package me.progfrog.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);
    }
}

 

ErrorPageController

오류를 처리할 컨트롤러 필요

package me.progfrog.exception.sevlet;

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

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

 

오류 처리 View

/templates/error-page/404.html (비슷하게 500.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>

 

설정한 오류 페이지가 정상 노출되는 것을 확인할 수 있다.

 

4. 오류 페이지 작동 원리

개요

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

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

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

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

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

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

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

• 결과적으로, 예외 발생과 오류 페이지 요청 흐름은 다음과 같다.

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

• 중요한 점은 웹 브라우저(클라이언트)는 서버 내부에서 이런 일이 일어나는지 전혀 모른다는 점이다!
• 오직 서버 내부에서 오류 페이지를 찾기 위해 추가적인 호출을 한다.
• 정리하면 다음과 같다.
  • 1. 예외가 발생해서 WAS까지 전파된다.
  • 2. WAS는 오류 페이지 경로를 찾아서 내부에서 오류 페이지를 호출한다. 이때 오류 페이지 경로로 필터, 서블릿, 인터셉터, 컨트롤러가 모두 다시 호출된다.
• 그런데, 로그인 인증 체크 같은 경우를 생각해보면, 이미 필터나 인터셉터에서 로그인 체크를 모두 완료했다.
• 따라서 서버 내부에서 오류 페이지를 호출한다고 해서 해당 필터나 인터셉터가 한번 더 호출되는 것은 매우 비효율적이다.
• 결국 클라이언트로부터 발생한 정상 요청인지, 아니면 오류 페이지를 출력하기 위한 내부 요청인지 구분할 수 있어야 한다.
• 서블릿은 이런 문제를 해결하기 위해 DispatcherType이라는 추가 정보를 제공하며 다음 글에서 확인해보자~!~!~!

[스프링MVC2편] 섹션 8. 예외 처리와 오류 페이지 - 2

 

실습

• WAS는 오류 페이지를 단순히 다시 요청만 하는 것이 아니라, 오류 정보를 request의 attribute에 추가해서 넘겨준다.
• 필요하면 오류 페이지에서 전달된 오류 정보를 사용할 수 있다.
• Servlet, JPA의 패키지 네임스페이스가 javax.*에서 jakarta.*로 변경되었기 때문에 요점의 주의해서 실습 진행!

ErrorPageController

package me.progfrog.exception.sevlet;

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

@Controller
@Slf4j
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: ex=", 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());
    }
}

// 예외
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";

// 클라이언트 요청 URI
public static final String ERROR_REQUEST_URI = "jakarta.servlet.error.request_uri";

// 오류가 발생한 서블릿 이름
public static final String ERROR_SERVLET_NAME = "jakarta.servlet.error.servlet_name";

// HTTP 상태 코드
public static final String ERROR_STATUS_CODE = "jakarta.servlet.error.status_code";