[ Spring ] 예외 처리와 오류 페이지 - Servlet Exception Handling(오류 페이지 작동 원리)

---

오늘부터 예외 처리와 오류 페이지 적용 및 작동 원리에 대해 포스팅을 진행해 보겠습니다.

 

예외를 처리하거나 핸들링하는 방법은 실무에서는 꼭 필요한 챕터입니다.

그래서 서블릿부터 시작해서 API 예외 처리하는 방법까지 이어서 진행해 보겠습니다.

 

---

프로젝트 생성

 

포스팅에서 사용되는 프로젝트는 Spring boot로 진행되며 Dependencies 목록은 다음과 같습니다.

 

plugins {
    id 'org.springframework.boot' version '2.5.1'
    id 'io.spring.dependency-management' version '1.0.11.RELEASE'
    id 'java'
}

group = 'hello'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '11'

configurations {
    compileOnly {
	    extendsFrom annotationProcessor
	}
}

repositories {
	mavenCentral()
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
    implementation 'org.springframework.boot:spring-boot-starter-validation'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    compileOnly 'org.projectlombok:lombok'
    annotationProcessor 'org.projectlombok:lombok'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

test {
	useJUnitPlatform()
}

---

서블릿 예외 처리 - 시작

 

스프링에서 처리하는 방법을 알기 전에 알고 넘어가야 하는 부분이 있습니다.

먼저 스프링이 아닌 순수 서블릿 컨테이너는 예외를 어떻게 처리하는지 알아봅시다.

 

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

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

---

[ Exception(예외) ]

 

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

 

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

WAS(여기까지 전파) <- Filter <- Servlet <- Interceptor <- Controller(Exception)

 

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

WAS는 예외가 올라오면 어떻게 처리해야 할까??

 

테스트를 해봅니다.

 

먼저 스프링 부트가 제공하는 기본 예외 페이지가 있는데 false 설정해줍니다.

(뒤에서 다시 설명하겠다.)

 

•  application.properties 

server.error.whitelabel.enabled=false

 

• ServletExController - 서블릿 예외 컨트롤러 

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

@Slf4j
@Controller
public class ServletExController {

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

 

실행해 보면 다음처럼 tomcat이 기본으로 제공하는 오류 화면을 볼 수 있습니다.

 

HTTP Status 500 – Internal Server Error

 

웹 브라우저에서 개발자 모드로 확인해 보면 HTTP 상태 코드가 500으로 보입니다.

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

 

여기서 만약 아무 사이트나 호출하면

HTTP Status 404 – Not Found

 

톰캣이 기본으로 제공하는 404 오류 화면을 볼 수 있습니다.

 

다음은 두 번째 예외 방식인 response.sendError(HTTP 상태 코드, 오류 메시지) 코드를 추가해 보겠습니다.

 

---

 

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

 

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

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

 

• ServletExController - 추가

@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 흐름

Controller(response.sendError()) -> Interceptor -> Servlet -> Filter -> WAS(sendError 호출 기록 확인)

 

response.sendError()를 호출하면 response 내부에는 오류가 발생했다는 상태를 저장해 둡니다.

그리고 서블릿 컨테이너는 고객에게 응답 전에 response에 sendError()가 호출되었는지 확인합니다.

만약 호출되었다면 설정한 오류 코드에 맞추어 기본 오류 페이지를 보여줍니다.

 

HTTP Status 404 – Not Found
HTTP Status 500 – Internal Server Error

 

정리해 보면 서블릿 컨테이너가 제공하는 기본 예외 처리 화면은 사용자가 보기에 불편합니다.

의미 있는 오류 화면을 제공하기 위해 서블릿이 제공하는 오류 화면 기능을 사용해 봅시다.

 

---

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

 

서블릿 컨테이너가 제공하는 기본 예외 처리 화면은 고객 친화적이지 않습니다.

서블릿이 제공하는 오류 화면 기능을 사용해 봅시다.

 

서블릿은 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>

 

이번 포스팅은 Spring Boot를 통해서 서블릿 컨테이너를 실행하기 때문에,

Spring Boot가 제공하는 기능을 사용해서 서블릿 오류 페이지를 등록하면 됩니다.

 

• 서블릿 오류 페이지 등록

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, "/errorpage/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);
     }
}

• response.sendError(404) : errorPage404 호출

• response.sendError(500) : errorPage500 호출

• RuntimeException 또는 그 자식 타입의 예외 : errorpageEx 호출

 

500 예외가 서버 내부에서 발생한 오류라는 뜻을 포함하고 있기 때문에 여기서는 예외가 발생한 경우도 500 오류 화면으로 처리했습니다.

 

오류 페이지는 예외를 다룰 때 해당 예외와 그 자식 타입의 오류를 함께 처리합니다.

예를 들어서 위의 경우 RuntimeException은 물론이고 RuntimeException의 자식도 함께 처리합니다.

 

오류가 발생했을 때 처리할 수 있는 컨트롤러가 필요합니다. 

예를 들어서 RuntimeException 예외가 발생하면 errorPageEx에서 지정한 /error-page/500이 호출됩니다.

 

• ErrorPageController - 생성

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

@Slf4j
@Controller
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

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

 

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

 

해당 코드를 추가하셔서 실행해 보시면 설정한 오류 페이지가 정상 노출되는 것을 확인할 수 있습니다.

( 포스팅 글의 HTML 이미지는 생략하겠습니다. )

 

---

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

 

지금까지 오류 페이지를 생성해서 적용을 시켰습니다.

그렇다면 작동 원리는 어떻게 될까요??

 

서블릿은 Exception(예외)가 발생해서 서블릿 밖으로 전달되거나 또는 response.sendError()가 호출되었을 때

설정된 오류 페이지를 찾습니다.

 

• 예외 발생 흐름

Controller(예외발생) -> Interceptor -> Servlet -> Filter -> WAS(여기까지 전파)

 

• sendError 흐름

Controller(response.sendError()) -> Interceptor -> Servlet -> Filter -> WAS(sendError 호출 기록 확인)

 

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

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

 

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

 

확인해 보니 RuntimeException의 오류 페이지로 /error-page/500이 지정되어 있습니다. 

WAS는 오류 페이지를 출력하기 위해 /error-page/500를 다시 요청합니다.

 

• 오류 페이지 요청 흐름

WAS '/error-page/500' 다시 요청 -> Filter -> Serlvet -> Interceptor -> Controller(/error-page/500) -> View

 

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

1. WAS(여기까지 전파) <- Filter <- Serlvet <- Interceptor <- Controller(예외 발생)


2. WAS '/error-page/500' 다시 요청 -> Filter -> Serlvet -> Interceptor -> Controller(/error-page/500) -> View

 

중요한 점은 웹 프라우저(클라이언트)는 서버 내부에서 이런 일이 일어나는지 전혀 모른다는 점입니다.

오직 서버 내부에서 오류 페이지를 찾기 위해 추가적인 호출을 합니다.

 

정리해 보면 다음과 같습니다.

 

1. 예외가 발생해서 WAS까지 전파된다.
2. WAS는 오류 페이지 경로를 찾아서 내부에서 오류 페이지를 호출한다. 
3. 이때 오류 페이지 경로로 필터, 서블릿, 인터셉터, 컨트롤러가 모두 다시 호출된다.

 

( 필터와 인터셉터가 다시 호출되는 부분은 다음 포스팅에서 다루겠습니다. )

---

[ 오류 정보 추가 ]

WAS는 오류 페이지를 단순히 다시 요청만 하는 것이 아니라,

오류 정보를 request의 attribute에 추가해서 넘겨줍니다.

 

필요하면 오류 페이지에서 이렇게 전달된 오류 정보를 사용할 수 있습니다.

 

• ErrorPageController - 오류 출력

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

@Slf4j
@Controller
public class ErrorPageController {

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

}

 

// request.attribute에 서버가 담아준 정보

javax.servlet.error.exception : 예외
javax.servlet.error.exception_type : 예외 타입
javax.servlet.error.message : 오류 메시지
javax.servlet.error.request_uri : 클라이언트 요청 URI
javax.servlet.error.servlet_name : 오류가 발생한 서블릿 이름
javax.servlet.error.status_code : HTTP 상태 코드

---

마치며

오늘은 서블릿의 오류 페이지 작동 원리에 대해 알아봤습니다.

다음 포스팅은 예외 처리에 따른 필터와 인터셉터부터 진행해 보겠습니다.

 

위 포스팅은 김영한님의 Spring MVC 2편 - 백엔드 웹 개발 활용  강의를 참고했습니다

스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 강의 - 인프런