8. 예외 처리와 오류 페이지

예외에 대해 알고 싶다면 이 글들을 읽어보자

• 자바 예외 이해
• 스프링과 문제 해결 - 예외 처리, 반복

---

8.1 서블릿 예외 처리 - 시작

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

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

8.1.1 Exception(예외)

자바 직접 실행

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

웹 애플리케이션

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

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

결국 톰캣 같은 WAS 까지 예외가 전달된다. WAS는 예외가 올라오면 어떻게 처리해야 할까? (스프링 부트가 제공하는 기본 예외 페이지는 꺼두자.)

application.properties

server.error.whitelabel.enabled=false

컨트롤러에서 예외 발생

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

실행 결과
tomcat(WAS)이 기본으로 제공하는 오류 화면을 볼 수 있다.

HTTP Status 500 – Internal Server Error

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

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

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

response.sendError 추가

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

실행 결과

HTTP Status 404 – Bad Request
HTTP Status 500 – Internal Server Error

서블릿 컨테이너가 제공하는 오류 화면은 사용자가 보기에 불편하다.

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

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

서블릿은 Exception (예외)가 발생해서 서블릿 밖으로 전달되거나 또는 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/Ex");
    	factory.addErrorPages(errorPage404, errorPage500, errorPageEx);
  	}
}

• response.sendError(404) : errorPage404 호출
• response.sendError(500) : errorPage500 호출
• RuntimeException 또는 그 자식 타입의 예외 : errorPageEx 호출

오류를 처리할 컨트롤러

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

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

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

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

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

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

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

8.4 서블릿 예외 처리 - 필터

필터에 대해 알고 싶다면 이 글을 읽자

예외 처리에 따른 필터와 인터셉터 그리고 서블릿이 제공하는 DispatchType 이해하기

오류가 발생하면 오류 페이지를 출력하기 위해 WAS 내부에서 다시 한번 호출이 발생한다.

• 이때 필터, 서블릿, 인터셉터도 모두 다시 호출된다. 그런데 로그인 인증 체크 같은 경우를 생각해보면, 이미 한번 필터나, 인터셉터에서 로그인 체크를 완료했다. 따라서 서버 내부에서 오류 페이지를 호출한다고 해서 해당 필터나 인터셉트가 한번 더 호출되는 것은 매우 비효율적이다.
• 결국 클라이언트로부터 발생한 정상 요청인지, 아니면 오류 페이지를 출력하기 위한 내부 요청인지 구분할 수 있어야 한다. 서블릿은 이런 문제를 해결하기 위해 DispatcherType 이라는 추가 정보를 제공한다.

DispatcherType

필터는 이런 경우를 위해서 dispatcherTypes 라는 옵션을 제공한다.

HttpServletRequest 로 들어온 요청(request)들 중 고객이 처음 요청하면 dispatcherType=REQUEST 이다. 또한 오류 페이지를 요청하기 위한 내부 요청은 dispatcherType=ERROR 이다.

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

필터와 DispatcherType

필터에 filterRegistrationBean.setDispatcherTypes() 안에 아무것도 넣지 않으면 기본값이 Dispatcher.REQUEST 이다. 즉 클라이언트의 요청이 있는 경우에만 필터가 적용된다. 특별히 오류 페이지 경로도 필터를 적용할 것이 아니면, 기본 값을 그대로 사용하면 된다.

8.5 서블릿 예외 처리 - 인터셉터

인터셉터에 대해 알고 싶다면 이 글을 읽자

인터셉터 중복 호출 제거

필터의 경우 어떤 DispatcherType 인 경우에 필터를 적용할 지 선택할 수 있다. 하지만 인터셉터는 서블릿이 제공하는 기능이 아니라 스프링이 제공하는 기능이다. 따라서 DispatcherType 과 무관하게 항상 호출된다.

인터셉터는 다음과 같이 요청 경로에 따라서 추가하거나 제외하기 쉽게 되어 있기 때문에, 이러한 설정을 사용해서 오류 페이지 경로를 excludePathPatterns 를 사용해서 빼주면 된다.

@Override
 public void addInterceptors(InterceptorRegistry registry) {
      registry.addInterceptor(new LogInterceptor())
              .order(1)
              .addPathPatterns("/**")
              .excludePathPatterns(
                      "/css/**", "/*.ico"
                      , "/error", "/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

8.6 스프링 부트 - 오류 페이지

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

• ErrorPage 를 자동으로 등록한다. 이때 /error 라는 경로로 기본 오류 페이지를 설정한다.

  • new ErrorPage("/error") , 상태 코드와 예외를 설정하지 않으면 기본 오류 페이지로 사용된다.

  • 서블릿 밖으로 예외가 발생하거나, response.sendError(...) 가 호출되면 모든 오류는 /error 를 호출하게 된다.

• BasicErrorController 라는 스프링 컨트롤러를 자동으로 등록한다.

  • ErrorPage 에서 등록한 /error 를 매핑해서 처리하는 컨트롤러다.

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

BasicErrorController가 제공하는 기본 정보들

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

* timestamp: Fri Feb 05 00:00:00 KST 2021
* status: 400
* error: Bad Request
* exception: org.springframework.validation.BindException
* trace: 예외 trace
* message: Validation failed for object='data'. Error count: 1
* errors: Errors(BindingResult)
* path: 클라이언트 요청 경로 (`/hello`)

확장 포인트

에러 공통 처리 컨트롤러의 기능을 변경하고 싶으면 ErrorController 인스턴스 구현하거나 BasicErrorController 를 상속 받아서 기능을 추가하면 된다.

---

References: 김영한 - [스프링 MVC 2편 - 백엔드 웹 개발 활용 기술]