Exception(1) - 예외 처리,오류 페이지

이정원·2024년 11월 25일

1.서블릿 예외 처리

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

Exception:서블릿 코드 내에서 발생하는 특정 예외(예: NullPointerException, IOException 등)를 직접 처리하거나 컨테이너에서 처리하도록 설정할 수 있다.
response.sendError(HTTP 상태 코드, 오류 메시지):클라이언트에 특정 HTTP 상태 코드와 메시지를 반환하여 오류를 알리는 방식이다.

1-1.자바

처음 자바 가상 머신(Java Virtual Machine, JVM)이 main() 메서드를 호출하여 Thread가 할당되고 실행된다. 만약 main함수 안에서 예외가 처리되지 않으면, 예외는 더이상 갈곳이 없어 JVM에게 전달되고 예외를 로그로 기록한 뒤, 해당 Thread가 종료된다.

자바 예외 발생 컨트롤러

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

Exception 의 경우 서버 내부에서 처리할 수 없는 오류가 발생한 것으로 생각해서 HTTP 상태 코드 500을 반환한다.

클라이언트가 요청한 리소스를 찾을수 없을때, 404 오류를 반환한다.

1-2.웹 어플리케이션

웹 애플리케이션은 사용자 요청별로 별도의 쓰레드가 할당되고, 서블릿 컨테이너 안에서 실행된다. 만약 예외를 예측하고 처리하는 try-catch에서 예외를 처리하지 못하고 서블릿 밖으로 예외가 나가게 된다면 오류가 WAS까지 전파된다.

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

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

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

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

response.sendError() 를 호출하면 response 내부에는 오류가 발생했다는 상태를 저장해둔다.그리고 서블릿 컨테이너는 고객에게 응답 전에 response에 sendError()가 호출되었는지 확인한다. 호출되었다면 설정한 오류 코드에 맞추어 기본 오류 페이지를 보여준다.

response 예외 처리 순서

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

2.예외 클래스

2-1. 컴파일 타임 예외(CompiletimeException)

컴파일 타임에 발생할 수 있는 예외로, Java 컴파일러가 예외 처리를 강제한다. Checked Exception의 대표적인 예로, 반드시 throws 선언이나 try-catch 블록으로 처리해야 컴파일이 성공한다.

하위 클래스

IOException: 입출력 작업 중 오류가 발생할 때(네트워크 연결 문제, 파일 읽기/쓰기 실패)
InterruptedException: 스레드가 실행 중 인터럽트를 받을 때(다른 스레드가 인터럽트를 호출)
SQLException: 데이터베이스 작업 중 오류가 발생할 때(잘못된 SQL 쿼리 실행)

2-2. 런타임 예외 (RuntimeException)

프로그램 실행 중에 발생할 수 있는 예외를 나타내며, 컴파일 타임이 아닌 런타임에서 주로 발견된다. Unchecked Exception으로 분류되며, throws 키워드로 선언하거나 try-catch 블록으로 처리하지 않아도 된다.

하위 클래스

NullPointerException: null 값을 참조하려고 할 때 발생
ArrayIndexOutOfBoundsException: 배열의 유효 범위를 벗어난 인덱스를 참조할 때
IllegalArgumentException: 메서드에 잘못된 인수를 전달했을 때
ArithmeticException: 0으로 나누는 등의 수학적 오류가 있을 때
ClassCastException: 잘못된 객체 캐스팅이 발생했을때

3.스프링 부트 오류 페이지

에러 페이지 이동 클래스

public class WebServerCustomizer implements WebServerFactoryCustomizer<ConfigurableWebServerFactory> {
    @Override
    public void customize(ConfigurableWebServerFactory factory) {
  
        ErrorPage errorPage404 = new ErrorPage(HttpStatus.NOT_FOUND, "/error-page/400");
        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);

    }
}

해당 클래스는 등록한 에러가 발생시 WAS(Web Application Server)가 해당 path로 요청을 리디렉션하거나 포워딩하도록 설정한다.

오류 페이지는 예외를 다룰 때 해당 예외와 그 자식 타입의 오류를 함께 처리한다. 예를 들어서 위의 경우 RuntimeException 은 물론이고 RuntimeException 의 자식도 함께 처리한다.

오류가 발생했을 때 처리할 수 있는 컨트롤러가 필요하다. 예를 들어서 RuntimeException 예외가 발생하면 errorPageEx에서 지정한 /error-page/500이 호출된다.
에러 페이지 컨트롤러

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

오류 페이지 작동 원리
RuntimeException 예외가 WAS까지 전달되면, WAS는 설정한 오류 페이지 경로를 확인하여 /error-page/500이 지정되어 있다면 WAS는 오류 페이지를 출력하기 위해 /error-page/500를 다시 요청한다.

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

# WAS의 예외 처리
2. WAS(/error-page/500) 다시 요청 -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러(/error-page/500) -> View

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

오류 정보 추가

3-1. Filter

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

RequestDispatcher 상수 목록

    public static final String ERROR_EXCEPTION ="javax.servlet.error.exception";
    public static final String ERROR_EXCEPTION_TYPE ="javax.servlet.error.exception_type";
    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";

Java Servlet API에서 제공하는 RequestDispatcher의 상수 목록으로, 서블릿에서 에러 페이지로 요청을 포워딩할 때 에러와 관련된 정보를 전달하기 위해 사용되는 속성들이다.

request에서 전달받은 오류 정보를 출력해보자.

private void printErrorInfo(HttpServletRequest request) {
        log.info("ERROR_EXCEPTION: ex=", request.getAttribute(RequestDispatcher.ERROR_EXCEPTION));
        log.info("ERROR_EXCEPTION_TYPE: {}", request.getAttribute(RequestDispatcher.ERROR_EXCEPTION_TYPE));
        log.info("ERROR_MESSAGE: {}", request.getAttribute(RequestDispatcher.ERROR_MESSAGE));
        // ERROR_EXCEPTION이 Spring에서 감싼 경우 NestedServletException으로 반환
        log.info("ERROR_REQUEST_URI: {}", request.getAttribute(RequestDispatcher.ERROR_REQUEST_URI));
        log.info("ERROR_SERVLET_NAME: {}", request.getAttribute(RequestDispatcher.ERROR_SERVLET_NAME));
        log.info("ERROR_STATUS_CODE: {}", request.getAttribute(RequestDispatcher.ERROR_STATUS_CODE));
        log.info("DISPATCH_TYPE: {}", request.getDispatcherType());
    }

RuntimeException 호출시

WAS에서 오류가 발생하면 오류 페이지를 출력하기 위해 내부적으로 다시 한 번 요청이 발생한다. 이 과정에서 필터(Filter), 서블릿(Servlet), 인터셉터(Interceptor)도 모두 다시 호출된다. 그러나 로그인 인증과 같은 작업을 이미 한 번 수행한 상태에서 오류 페이지를 출력하기 위해 동일한 필터나 인터셉터 로직이 다시 실행되는 것은 비효율적이다. 이러한 문제를 해결하기 위해 서블릿은 요청의 유형을 구분할 수 있는 DispatcherType이라는 추가 정보를 제공한다.

고객이 처음 요청하면 dispatcherType=REQUEST이다. 아래와 같이 오류 페이지를 요청할수 있게 enum 클래스로 구분하였다.

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

필터에서 테스트 해보자.

LogFilter

@Slf4j
public class LogFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) {
        log.info("LogFilter initialized");
    }

    @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; // 예외를 다시 던져서 WAS로 전달
        } finally {
            log.info("RESPONSE [{}][{}][{}]", uuid, request.getDispatcherType(), requestURI);
        }
    }

    @Override
    public void destroy() {
        log.info("LogFilter destroyed");
    }
}

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

setDispatcherTypes 설정을 통해 타입이 REQUEST,ERROR에 대해서만 필터가 실행된다.

첫번째 호출

클라이언트가 /error-ex 경로를 요청한 상황, DispatcherType이 REQUEST로 표시되며, 이는 클라이언트의 직접적인 요청임을 의미한다.

chain.doFilter로 전달한 후 컨트롤러에서 exception이 발생하여 catch와 finally로 RESPONSE가 찍힌다. throw e로 WAS까지 올라간 후 다시 요청을 시도한다.

두번째 호출

WAS에서 등록된 경로를 확인하여 /error-page/500으로 요청을 보낸다. 이때 DispatcherType을 Error로 보낸다.

세번째 호출

do.chain이 다 끝났기 때문에 finally에서 RESPONSE가 출력된다.

filterRegistrationBean.setDispatcherTypes을 따로 설정하지 않으면 REQUEST가 Default이다.

3-2. Interceptor

인터셉터는 DispatcherTypes을 통해 구별하지 않는 대신 강력한 excludePathPatterns을 통해 특정 요청 경로를 제외하여 효율을 증가시킨다.(오류 페이지 요청을 위한 로직 재 수행 방지)

@Override
    public void addInterceptors(InterceptorRegistry registry){
        registry.addInterceptor(new LogInterceptor())
                .order(1)
                .addPathPatterns("/**")
                .excludePathPatterns("/css/**","*.ico","/error","/error-page/**");
    }

excludePathPatterns에서 /error-page/** 를 제거하면 error-page/500 같은 내부 호출의 경우에도 인터셉터가 호출된다.

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

4.오류 페이지

지금까지 오류 페이지를 등록하기 위해 WebServerCustomizer,예외 처리 컨트롤러인 ErrorPageController를 만들었다.

스프링 부트는 기본으로 /error라는 경로로 기본 오류 페이지를 설정한다. 이를 매핑하는 BasicErrorController라는 컨트롤러를 자동으로 등록한다. 개발자는 규칙과 우선순위에 따라서 등록하면 된다.

resources/templates/error/에 4xx.html,404.html,500.html을 등록하였다.

4-1.뷰 선택 우선순위

BasicErrorController 의 처리 순서

1. 뷰 템플릿

resources/templates/error/500.html
resources/templates/error/5xx.html

2. 정적 리소스

resources/static/error/400.html
resources/static/error/404.html
resources/static/error/4xx.html

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

resources/templates/error.html

해당 경로 위치에 HTTP 상태 코드 이름의 뷰 파일을 넣어두면 된다.

BasicErrorController 컨트롤러는 다양한 정보를 model에 담아서 뷰에 전달한다. 뷰 템플릿은 이 값을 활용해서 출력할 수 있다.
500.html에 다음 정보를 추가했다.

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