Spring/Spring MVC

스프링 MVC - 예외 처리

taey 2024. 10. 2. 02:05

서블릿 예외 처리

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

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

Exception (예외)

자바 직접 실행

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

 

웹 애플리케이션

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

WAS <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러(예외 발생)

 

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

오류가 발생했을 때 HttpServletResponse가 제공하는 sendError라는 메서드를 사용, 서블릿 컨테이너에게 오류가 발생했음을 전달할 수 있다. 이 메서드를 사용하면 HTTP 상태 코드와 오류 메시지도 추가할 수 있다.

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

 

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, "/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) : errorPage404 호출
  • response.sendError(500) : errorPage500 호출
  • RuntimeException 또는 그 자식 타입의 예외 : errorPageEx 호출

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

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

 

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

 

위의 코드를 사용할 경우 return 값이 /templates의 html이므로 오류 처리 view가 필요하다.

 

오류 페이지 작동 원리

예외 발생 흐름

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

 

sendError 흐름

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

 

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

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

 

 

오류 페이지 요청 흐름

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

 

 

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

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

 

오류 정보 추가

WAS는 오류 페이지를 다시 요청하는 것뿐만 아니라, 오류 정보를 request의 attribute에 추가해서 넘겨준다.

 

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 상태 코드
스프링 부트 3.0 이상을 사용한다면 javax 대신에 jakarta를 사용해야 한다.

 

서블릿 예외 처리 - 필터

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

 

DispatcherType

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

 

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

 

filterRegistrationBean.setDispatcherTypes(DispatcherType.REQUEST, DispatcherType.ERROR);

두 가지를 모두 넣으면 클라이언트 요청, 오류 페이지 요청 모두 필터가 호출된다. 아무것도 넣지 않으면 기본값은 DispatcherType.REQUEST이다.

 

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

인터셉터는 서블릿이 제공하는 기능이 아닌, 스프링이 제공하는 기능이다. 따라서 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, dispatcherType=REQUEST) -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러
2. WAS(여기까지 전파) <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러(예외 발생)
3. WAS 오류 페이지 확인
4. WAS(/error-page/500, dispatchType=ERROR) -> 필터(x) -> 서블릿 -> 인터셉터(x) -> 컨트롤러(/error-page/500) -> View

 

스프링 부트 - 오류 페이지

지금까지 예외 처리 페이지를 만들기 위해 복잡한 과정을 거쳤다.

  • WebServerCustomizer를 만들기
  • 예외 종류에 따라서 ErrorPage를 추가하기
  • 예외 처리용 컨트롤러 ErrorPageController를 만듬

 

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

  • ErrorPage를 자동으로 등록한다. 이때 /error라는 경로로 기본 오류 페이지를 설정한다.
    • new ErrorPage("/error"), 상태코드와 예외를 설정하지 않으면 기본 오류 페이지로 사용된다.
    • 서블릿 밖으로 예외가 발생하거나, response.sendError()가 호출되면 모든 오류는 /error를 호출하게 된다.
  • BasicErrorController라는 스프링 컨트롤러를 자동으로 등록한다.
    • ErrorPage에서 등록한 /error를 매핑해서 처리하는 컨트롤러다.

 

참고
ErrorMvcAutoCongifuration이라는 클래스가 오류 페이지를 자동으로 등록하는 역할을 한다.

 

 

개발자는 오류 페이지만 등록

BasicErrorController는 기본적인 로직이 모두 개발되어 있다. 개발자는 오류 페이지 화면만 BasicErrorController가 제공하는 룰과 우선 순위에 따라서 등록하면 된다. 정적 HTML이면 정적 리소스, 뷰 템플릿을 사용해서 동적으로 오류 화면을 만들고 싶으면 뷰 템플릿 경로에 오류 페이지 파일을 만들어서 넣어두기만 하면 된다.

 

뷰 선택 우선 순위

BasicErrorController의 처리 순서

 

  1. 뷰 템플릿
  2. 정적 리소스 ( static, public )
  3. 적용 대상이 없을 때 뷰 이름 ( error )

구체적인 것(404, 500)이 덜 구체적인 것(5xx)보다 우선 순위가 높음

4xx, 5xx라고 하면 400대, 500대 오류를 처리해준다.

 

 

BsicErrorController가 제공하는 기본 정보들

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

 

오류 정보를 클라이언트에게 노출시키는 것은 좋지 않다. 오류 컨트롤러에서 다음 오류 정보를 model에 포함할지 여부를 선택할 수 있다.

 

application.properties

  • server.error.include-exception=false : exception 포함 여부(true, false)
  • server.error.include-message=never : message 포함 여부
  • server.error.include-stacktrace=never : trace 포함 여부
  • server.error.include-binding-errors=never : errors 포함 여부

기본 값이 never인 부분은 다음 3가지 옵션을 사용할 수 있다.

  • never : 사용하지 않음
  • always : 항상 사용
  • on_param : 파라미터가 있을 때 사용

 

스프링 부트 오류 관련 옵션

  • server.error.whitelabel.enabled=true : 오류 처리 화면을 못 찾을 시, 스프링 whitelabel 오류 페이지 적용
  • server.error.path=/error : 오류 페이지 경로, 스프링이 자동 등록하는 서블릿 글로벌 오류 페이지 경로와 BasicErrorController 오류 컨트롤러 경로에 함께 사용된다.

 

확장 포인트

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

'Spring > Spring MVC' 카테고리의 다른 글

스프링 MVC - 스프링 타입 컨버터, 포맷터  (3) 2024.10.03
스프링 MVC - API 예외 처리  (3) 2024.10.03
스프링 MVC - 스프링 인터셉터  (2) 2024.10.02
스프링 MVC - 서블릿 필터  (1) 2024.10.01
스프링 MVC - Bean Validation  (2) 2024.10.01

'Spring/Spring MVC'의 다른글

  • 현재글스프링 MVC - 예외 처리

관련글

티스토리툴바