1. 서블릿의 예외 처리와 오류 페이지

1-1. 예외 처리

스프링이 아닌 순수 서블릿 컨테이너의 예외 처리 방식에 대해 알아보자. 서블릿은 다음 2가지 방식으로 예외 처리를 지원한다.

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

   그렇다면 웹 애플리케이션의 경우에는 어떨까? 웹 애플리케이션은 사용자 요청에 따라 별도의 쓰레드가 할당되고 이들은 서블릿 컨테이너 안에서 실행된다.

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

   컨트롤러에서 예외가 발생했는데, 애플리케이션 내에서 예외를 잡지 못하고 서블릿 밖으로까지 예외가 던져지면, 결국 WAS까지 예외가 전달된다.

2. response.sendError(HTTP 상태 코드, 오류 메시지)
   오류가 발생했을 때 HttpServletResponse가 제공하는 sendError 메소드를 사용해도 된다. sendError 메소드를 호출한다고 해서 당장 예외가 발생하는 것은 아니지만, 서블릿 컨테이너에게 오류가 발생했다는 점을 알릴 수 있다. 그리고 이 메소드를 사용하면 http 상태 코드와 오류 메시지도 설정할 수 있다.

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

   컨트롤러에서 response.sendError 호출하면 response 내부에는 오류가 발생했다는 상태를 저장해둔다. 그리고 서블릿 컨테이너는 고객에게 응답하기 전에 response에 sendError()가 호출됐는지 확인한다. 그리고 호출됐다면 설정한 오류 코드에 맞추어 기본 오류 페이지를 보여준다. 아래 예제를 보면 서블릿 컨테이너가 기본으로 제공하는 오류 화면이 보여지는 것을 확인할 수 있다.

예제

우선 스프링부트에서 기본으로 제공하는 오류 페이지(White Label)를 끄기 위해 application.properties 파일에 다음과 같은 코드를 추가해야 한다.

server.error.whitelabel.enabled=false

컨트롤러

@Controller
public class ServletExController {

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

    //404 오류 발생
    @GetMapping("/error-404")
    public void error404(HttpServletResponse response) throws IOException {
        response.sendError(404, "404 오류 발생");
    }

    //500 오류 발생
    @GetMapping("/error-500")
    public void error500(HttpServletResponse response) throws IOException {
        response.sendError(500, "500 오류 발생");
    }
}

http://localhost:8080/error-ex 실행 결과

http://localhost:8080/error-404 실행 결과

http://localhost:8080/error-500 실행 결과

실행 흐름

• http://localhost:8080/error-ex 요청 -> 흐름이 컨트롤러까지 넘어가고, 컨트롤러에서 예외 발생 -> 예외가 넘어가면서 WAS까지 예외 전파 -> 기본 오류 페이지가 보여진다.

• http://localhost:8080/error-404, http://localhost:8080/error-500 요청 -> 흐름이 컨트롤러까지 넘어가고, 컨트롤러에서 response.sendError() 호출 -> 흐름이 WAS까지 넘어가면서 WAS에서 response.sendError() 호출 여부를 확인하고, 기본 오류 페이지가 보여진다.

1-2. 오류 페이지

ServletExController - 컨트롤러

@Controller
public class ServletExController {

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

    @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, "500 오류 발생");
    }
}

WebServerCustomizer - 예외 페이지 등록

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

ErrorPageController - 컨트롤러

@Controller
public class ErrorPageController {

    @RequestMapping("/error-page/404")
    public String errorPage404(HttpServletRequest request, HttpServletResponse response) {
        return "error-page/404";
    }

    @RequestMapping("/error-page/500")
    public String errorPage500(HttpServletRequest request, HttpServletResponse response) {
        return "error-page/500";
    }
}

실행 흐름

• http://localhost:8080/error-ex 를 호출한 경우, ServletExController 컨트롤러가 호출되면서 예외가 발생한다.

• 예외 처리를 하지 않았으므로 예외가 WAS까지 넘어간다.

• WAS는 오류 페이지 정보(WebServerCustomizer)를 참고하여 "/error-page/500" 경로로 다시 요청을 보낸다.

• 요청으로 인해 ErrorPageController 컨트롤러가 호출되고 해당 컨트롤러에서 에러에 맞는 요청 페이지(error-page/500.html)를 호출한다.

1-3. 서블릿 예외 처리와 필터/인터셉터

컨트롤러에서의 예외 발생과 오류 페이지 요청 흐름은 다음과 같다.

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

즉 오류가 발생하고 오류 페이지를 출력하기 위해 WAS 내부에서 호출이 한 번 더 발생한다. 그리고 이때 필터와 인터셉터도 다시 호출된다. 그런데 이미 첫 번째 요청에서 필터와 인터셉터를 거친 후이기 때문에 두 번째 호출은 불필요하다. 따라서 클라이언트로부터 발생한 요청(첫 번째 요청)인지, 오류 페이지 출력을 위한 서버 내부에서 발생한 요청(두 번째 요청)인지 구분하여 필터와 인터셉터를 호출하도록 설정해야 한다. 서블릿은 이를 위해 DispatcherType이라는 추가 정보를 제공한다.

DispatcherType

• REQUEST : 클라이언트 요청

• ERROR : 오류 요청

• FORWARD : 서블릿에서 다른 서블릿이나 JSP를 호출할 때
  (RequestDispatcher.forward(request, response);)

• INCLUDE : 서블릿에서 다른 서블릿이나 JSP의 결과를 포함할 때
  (RequestDispatcher.include(request, response);)

• ASYNC : 서블릿 비동기 호출

1-3-1. 필터

@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.ERROR 두 가지를 모두 지정하면 클라이언트 요청과 오류 페이지 요청 두 경우 모두 필터가 호출된다. 아무것도 지정하지 않으면 기본 값이 DispatcherType.REQUEST이다. 따라서 클라이언트 요청의 경우에만 필터를 적용하고자 한자면, 기본 값을 그대로 사용하면 된다. 그리고 오류 페이지 요청 전용 필터를 적용하고 싶으면 DispatcherType.ERROR만 지정하면 된다.

1-3-2. 인터셉터

필터의 경우, 필터를 등록할 때 어떤 DispatcherType인 경우에 필터를 호출할지 지정할 수 있었다. 그런데 인터셉터는 서블릿이 제공하는 기능이 아니라 스프링이 제공하는 기능이다. 따라서 DispatcherType과 무관하게 항상 호출된다.

대신 인터셉터는 다음과 같이 요청 경로에 따라서 인터셉터를 추가하거나 제외하기 쉽기 때문에 이를 사용하여 오류 페이지 경로를 excludePathPatterns를 사용해서 제외시켜주면 된다.

@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/**" //오류 페이지 경로);
	}
}

---

2. 스프링부트의 예외 처리와 오류 페이지

스프링부트 없이 순수한 서블릿만으로는 다음과 같이 오류 페이지를 제공하기 위한 복잡한 과정을 거쳤다.

• 오류 페이지 정보를 나타내는 WebServerCustomizer 생성

• 예외 종류에 따라 ErrorPage를 만들어 추가

• 예외 처리용 컨트롤러 ErrorPageController 생성

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

• 스프링부트는 ErrorPage를 자동 생성한다. 이때 "/error"라는 경로를 기본 오류 페이지로 설정(new ErrorPage("/error");한다. 즉 서블릿 밖으로 예외가 던져지거나, response.sendError()가 호출되면 모든 오류는 "/error"를 호출하게 된다.

• 스프링부트는 BasicErrorController라는 컨트롤러를 자동으로 빈으로 등록한다. 이 컨트롤러는 ErrorPage로 등록한 "/error"를 매핑해서 처리하는 컨트롤러이다.

• 따라서 개발자는 ErrorPage를 만들어 추가하거나, 예외 페이지를 위한 컨트롤러를 만들지 않아도 된다. 오류 페이지만 BasicErrorController가 제공하는 룰에 맞춰서 등록하면 된다. 정적 html이면 정적 리소스, 뷰 템플릿을 사용해서 동적인 오류 화면을 만들고 싶으면 뷰 템플릿 경로에 오류 페이지 화면을 넣어두면 된다.

BasicErrorController의 뷰 선택 우선순위

BasicErrorController의 뷰 선택 우선순위는 다음과 같다. 뷰 템플릿이 정적 리소스보다 우선순위가 높고, 400, 500처럼 구체적인 것이 4xx, 5xx처럼 덜 구체적인 것보다 우선순위가 높다.

1. 뷰 템플릿

   • resource/templates/error/500.html
   • resource/templates/error/5xx.html

2. 정적 리소스

   • resources/static/error/400.html
   • resources/static/error/404.html
   • resources/static/error/4xx.html

3. 적용 대상이 없을 때

   • resources/templates/error.html

BasicErrorController가 제공하는 기본 정보

BasicErrorController 컨트롤러는 다음 정보들을 model에 담아서 view에 전달한다. 따라서 뷰 템플릿에서 이 값들을 활용해서 오류 페이지에 출력할 수 있다.

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

그러나 오류 관련 내부 정보들은 고객에게 노출하지 않는 것이 좋다. 그래서 BasicErrorController에서 오류 정보들을 model에 포함할지의 여부를 application.properties에 다음과 같이 설정할 수 있다.

//exception 포함 여부(true/false)
server.error.include-exception=false

//message 포함 여부(never/always/on_param)
server.error.include-message=never 

//trace 포함 여부(never/always/on_param)
server.error.include-stacktrace=never 

//errors 포함 여부(never/always/on_param)
server.error.include-binding-errors=never 

never는 사용하지 않음, always는 항상 사용함, on_param은 파라미터가 있을 때만 사용한다는 것을 뜻한다. 예를 들어 on_param으로 설정하고 http 요청시 message=&errors=&trace=와 같이 파라미터를 전달하면, 해당 정보들이 model에 담겨서 뷰로 전달되고, 뷰 템플릿에서는 이를 활용하여 오류 페이지에 해당 정보를 출력할 수 있다.

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