서블릿으로 예외 처리하기

스프링이 아닌 순수 서블릿 컨테이너는 예외를 어떻게 처리하는지 알아보겠습니다.

그래야 스프링 개발 중에 문제가 발생했을 경우 어디를 수정해야 할지 알 수 있기 때문입니다.

 

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

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

 

서블릿에서 예외 처리하는 방식

Exception(예외)

• 자바 직접 실행

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

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

 

• 웹 애플리케이션

웹 애플리케이션은 사용자 요청별로 별도의 스레드가 할당되고, 서블릿 컨테이너 안에서 실행됩니다.

애플리케이션에서 예외가 발생했는데, 어디선가 try ~ catch로 예외를 잡아서 처리하면 아무런 문제가 발생하지 않습니다.

만약에 애플리케이션에서 예외를 잡지 못하고 서블릿 밖인 톰캣 같은 WAS까지 예외가 전달될 때 무엇이 발생하는지 확인해보겠습니다.

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

 

• application.properties

스프링 부트가 제공하는 기본 예외 페이지를 비활성화합니다.

server.error.whitelabel.enabled=false

• ServletExController

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

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

 

http://localhost:8080/ ->

http://localhost:8080/error-ex ->

 

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

오류가 발생했을 때 HttpServletResponse가 제공하는 sendError라는 메서드를 사용해도 됩니다.

이것을 호출한다고 당장 예외가 발생하는 것은 아니지만, 서블릿 컨테이너에게 오류가 발생했다는 점을 전달할 수 있습니다.

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

 

• response.sendError(HTTP 상태 코드)
• response.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);
}

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

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

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

 

 

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

서블릿 컨테이너가 제공하는 기본 예외 처리 화면은 고객 친화적이지 않다. 서블릿이 제공하는 오류 화면 기능을 사용해보겠습니다

스프링 부트가 제공하는 기능을 사용해서 서블릿 오류 페이지를 등록하면 됩니다.

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

    }
}

• response.sendError(404) : error-page/404 호출
• response.sendError(500) : error-page/500 호출
• RuntimeException 또는 그 자식 타입의 예외: error-page/500 호출

 

다음의 에러 페이지를 추가해줍니다.

• resource/templates/error-page/404.html
• resource/templates/error-page/500.html

 

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

예를 들어서 RuntimeException 예외가 발생하면 errorPageEx 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";
	}
}

 

 

다음과 같은 URL로 테스트해보면 설정한 오류 페이지가 정상 노출되는 것을 확인할 수 있습니다.

• http://localhost:8080/error-ex
• http://localhost:8080/error-404
• http://localhost:8080/error-500

 

서블릿 오류 페이지 작동 원리

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

 

오류 페이지 요청 흐름

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

 

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

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

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

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

 

정리하면 다음과 같다.

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

 

오류 정보 사용하기

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";
 
@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 상태 코드