Spring

Spring(스프링) - 서블릿 예외 처리 및 오류 페이지(필터, 인터셉터)

녁이 2023. 12. 29. 17:50
728x90
반응형

Servlet 예외 처리

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

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

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

Exception(예외)

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

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

그런데 만약에 애플리케이션에서 예외를 잡지 못하고, 서블릿 밖으로까지 예외가 전달되면 어떻게 동작할까?

 

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

결국 톰캣 같은 WAS 까지 예외가 전달된다. WAS는 예외가 올라오면 어떻게 처리해야 할까?

이를 코드로 확인해보자.

 

테스트를 위해

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

 

application.properties

server.error.whitelabel.enabled=false

 

 

ServletExController - 서블릿 예외 컨트롤러

@Slf4j
@Controller
public class ServletExController {

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

 

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

→ HTTP Status 500 – Internal Server Error

 

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

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

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

 

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, "/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 호출

 

해당 오류들을 처리할 컨트롤러

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

결국 변경한 오류 화면으로 나오게 된다.

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

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

 

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

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

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

→ 오류 페이지 경로로 필터, 서블릿, 인터셉터, 컨트롤러가 모두 다시 호출된다.

 

WAS는 오류 페이지를 단순히 호출만 하지 않고, 오류 정보를 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 상태 코드

서블릿 예외 처리 - 필터

오류가 발생하면 오류 페이지를 출력하기 위해 WAS 내부에서 다시 한번 호출이 발생한다. 이때 필터, 서블릿, 인터셉터도 모두 다시 호출된다.

서버 내부에서 오류 페이지를 호출한다고 해서 필터나 인터셉트가 한번 더 호출되는 것은 매우 비효율적이다.

결국 클라이언트로 부터 발생한 정상 요청인지, 아니면 오류 페이지를 출력하기 위한 내부 요청인지 구분할 수 있어야 한다. 서블릿은 이런 문제를 해결하기 위해 DispatcherType 이라는 추가 정보를 제공한다.

 

DispatcherType

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

request.getDispatcherType()

위의 코드를 오류 페이지가 호출될 때 로그로 찍어보면, dispatchType=ERROR 로 나오는 것을 확인할 수 있다.

고객이 처음 요청하면 dispatcherType=REQUEST 이다.

 

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

 

javax.servlet.DispatcherType

public enum DispatcherType {
 FORWARD,
 INCLUDE,
 REQUEST,
 ASYNC,
 ERROR
}
  • REQUEST : 클라이언트 요청
  • ERROR : 오류 요청
  • FORWARD : MVC에서 배웠던 서블릿에서 다른 서블릿이나 JSP를 호출할 때
    • RequestDispatcher.forward(request, response);
  • INCLUDE : 서블릿에서 다른 서블릿이나 JSP의 결과를 포함할 때
    • RequestDispatcher.include(request, response);
  • ASYNC : 서블릿 비동기 호출

 

그러면 DispatcherType 은 필터에 어떻게 적용할까?

코드로 살펴보자.

 

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() 에 두 가지를 모두 넣으면 클라이언트 요청은 물론이고, 오류 페이지 요청에서도 필터가 호출된다. 아무것도 넣지 않으면 기본 값이 DispatcherType.REQUEST 이다. 즉, 클라이언트의 요청이 있는 경우에만 필터가 적용된다. 특별히 오류 페이지 경로도 필터를 적용할 것이 아니면, 기본 값을 그대로 사용하면 된다.

 

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

인터셉터의 중복 호출을 제거하는 것 역시 위의 필터와 같은 DispatchType을 활용한 방식이다.

 

코드로 살펴보자.

@Configuration
public class WebConfig implements WebMvcConfigurer {
 
 @Override
 public void addInterceptors(InterceptorRegistry registry) {
 registry.addInterceptor(new LogInterceptor())
 .order(1)
 .addPathPatterns("/**")
 .excludePathPatterns(
 "/css/**", "/*.ico"
 , "/error", "/error-page/**" //오류 페이지 경로
 );
 
 }

인터셉터는 필터와 같이 setDispatcherTypes() 함수는 없지만, 더 강력한 기능인 excludePathPatterns가 있다.

오류 페이지 경로를 이에 추가해줌으로써, 인터셉터의 호출을 방지할 수 있다.

 

스프링 부트가 제공하는 오류 페이지

지금까지 예외 처리 페이지를 만들기 위해서 WebServerCustomizer 를 만들고, 예외 종류에 따라서 ErrorPage 를 추가하고, 예외 처리용 컨트롤러 ErrorPageController 를 만들었다..

이는 너무나 복잡한 과정이다...

 

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

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

→ new ErrorPage("/error")

상태코드와 예외를 설정하지 않으면 기본 오류 페이지로 사용된다.

또한,

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

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

 

그러면 개발자는 오류 페이지만 등록하면 되는 것이다!

개발자는 오류 페이지 화면만 BasicErrorController 가 제공하는 룰과 우선순위에 따라서 등록하면 된다.

 

뷰 선택 우선순위

  • 뷰 템플릿
    • resources/templates/error/500.html
    • resources/templates/error/5xx.html
  • 정적 리소스( static , public )
    • resources/static/error/400.html
    • resources/static/error/404.html
    • resources/static/error/4xx.html
  • 적용 대상이 없을 때 뷰 이름( error )
    • resources/templates/error.html

 

 

※참고

 

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

위와 같이 model에 담긴 정보들을 활용할 수 있다.

정리

스프링 부트가 기본으로 제공하는 오류 페이지를 활용하면 오류 페이지와 관련된 대부분의 문제는 손쉽게 해결할 수 있다.

이렇게 오류 페이지를 사용자에게 보여주는 것은 매우 쉬운 일이다.

그러나, 서버간의 통신일 때는 어떻게 할까? API 예외 처리는 어떻게 해결할까?

다음에 이에 대해 다뤄보겠다.

728x90
반응형

'Spring' 카테고리의 다른 글

Spring - API 예외 처리 (ExceptionHandler, ControllerAdvice)  (2) 2024.01.01
Spring - API 예외 처리 (HandlerExceptionResolver, ExceptionResolver ) 이론  (2) 2024.01.01
Spring 검증 - Bean Validation  (1) 2023.12.21
Spring 검증 - Validator  (0) 2023.12.19
Spring 검증 - BindingResult (FieldError, ObjectError, rejectValue, reject)  (1) 2023.12.18

'Spring'의 다른글

  • 현재글Spring(스프링) - 서블릿 예외 처리 및 오류 페이지(필터, 인터셉터)

관련글

댓글

티스토리툴바