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

서블릿 예외 처리

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

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

Exception(예외)

자바 직접 실행

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

웹 애플리케이션

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

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 상태 코드 500
• Exception 의 경우 서버 내부에서 처리할 수 없는 오류가 발생한 것으로 생각해서 HTTP 상태 코드 500을 반환
• http://localhost:8080/no-page 으로 접속할 경우 톰캣이 기본으로 제공하는 404 오류 화면을 볼 수 있음

response.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()가 호출되었는지 확인
• 호출되었다면 설정한 오류 코드에 맞추어 기본 오류 페이지를 반환

오류 화면 제공

• 서블릿은 Exception (예외)가 발생해서 서블릿 밖으로 전달되거나 또는 response.sendError() 가 호출되었을 때 각각의 상황에 맞춘 오류 처리 기능을 제공
• 이 기능을 사용하면 친절한 오류 처리 화면을 준비해서 고객에게 보여줄 수 있음
• 과거에는 web.xml이라는 파일에 다음과 같이 오류 화면을 등록

<web-app>
    <error-page>
        <error-code>404</error-code>
        <location>/error-page/404.html</location>
    </error-page>
    <error-page>
        <error-code>500</error-code>
        <location>/error-page/500.html</location>
    </error-page>
    <error-page>
        <exception-type>java.lang.RuntimeException</exception-type>
        <location>/error-page/500.html</location>
    </error-page>
</web-app>

서블릿 오류 페이지 등록

@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, "/errorpage/500");
        factory.addErrorPages(errorPage404, errorPage500, errorPageEx);
    }
}

• response.sendError(404): errorPage404 호출
• response.sendError(500): errorPage500 호출
• RuntimeException 또는 그 자식 타입의 예외: errorPageEx 호출
• 500 예외가 서버 내부에서 발생한 오류라는 뜻을 포함하고 있기 때문에 여기서는 예외가 발생한 경우도 500 오류 화면으로 처리
• 오류 페이지는 예외를 다룰 때 해당 예외와 그 자식 타입의 오류를 함께 처리
  • 위의 경우 RuntimeException은 물론이고 RuntimeException의 자식도 함께 처리
• 오류가 발생했을 때 처리할 수 있는 컨트롤러가 필요
  • 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";
    }
}

오류 페이지 작동 원리

예외 발생 흐름

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

sendError 흐름

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

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

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

오류 페이지 요청 흐름

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에 추가해서 넘겨줌 필요하면 오류 페이지에서 이렇게 전달된 오류 정보를 사용 가능

ErrorPageController - 오류 출력

@Slf4j
@Controller
public class ErrorPageController {
  
    //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/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";
    }
  
    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 상태 코드

DispatcherType

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

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

• 오류가 발생하면 오류 페이지를 출력하기 위해 WAS 내부에서 다시 한번 호출이 발생
• 이때 필터, 서블릿, 인터셉터도 모두 다시 호출
• 그런데 로그인 인증 체크 같은 경우를 생각해보면, 이미 한번 필터나, 인터셉터에서 로그인 체크를 완료함
• 따라서 서버 내부에서 오류 페이지를 호출한다고 해서 해당 필터나 인터셉트가 한번 더 호출되는 것은 매우 비효율적

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

• 필터는 이런 경우를 위해서 dispatcherTypes라는 옵션을 제공
  • 고객이 처음 요청하면 dispatcherType=REQUEST
  • 서블릿 스펙은 실제 고객이 요청한 것인지, 서버가 내부에서 오류 페이지를 요청하는 것인지 DispatcherType으로 구분할 수 있는 방법을 제공

javax.servlet.DispatcherType

public enum DispatcherType {
    FORWARD,
    INCLUDE,
    REQUEST,
    ASYNC,
    ERROR
}

DispatcherType

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

필터와 DispatcherType

LogFilter - DispatcherType 로그 추가

@Slf4j
public class LogFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        log.info("log filter init");
    }
  
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        HttpServletRequest httpRequest = (HttpServletRequest) request;
        String requestURI = httpRequest.getRequestURI();
      
        String uuid = UUID.randomUUID().toString();
        try {
            log.info("REQUEST [{}][{}][{}]", uuid, request.getDispatcherType(), requestURI);
            chain.doFilter(request, response);
        } catch (Exception e) {
            throw e;
        } finally {
            log.info("RESPONSE [{}][{}][{}]", uuid, request.getDispatcherType(), requestURI);
        }
    }
  
    @Override
    public void destroy() {
        log.info("log filter destroy");
    }
}

로그를 출력하는 부분에 request.getDispatcherType()을 추가

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 즉 클라이언트의 요청이 있는 경우에만 필터가 적용

인터셉터 중복 호출 제거

LogInterceptor - DispatcherType 로그 추가

@Slf4j
public class LogInterceptor implements HandlerInterceptor {
  
    public static final String LOG_ID = "logId";
  
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
      
        String requestURI = request.getRequestURI();
      
        String uuid = UUID.randomUUID().toString();
        request.setAttribute(LOG_ID, uuid);
      
        log.info("REQUEST [{}][{}][{}][{}]", uuid, request.getDispatcherType(), requestURI, handler);
        return true;
    }
  
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        log.info("postHandle [{}]", modelAndView);
    }
  
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        String requestURI = request.getRequestURI();
        String logId = (String)request.getAttribute(LOG_ID);
        log.info("RESPONSE [{}][{}][{}]", logId, request.getDispatcherType(), requestURI);
        if (ex != null) {
            log.error("afterCompletion error!!", ex);
        }
    }
}

• 필터의 경우, 필터를 등록할 때 어떤 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/**" //오류 페이지 경로
                          );
    }
}

• 여기에서 /error-page/**를 제거하면 error-page/500 같은 내부 호출의 경우에도 인터셉터가 호출됨

전체 흐름 정리 /hello 정상 요청

WAS(/hello, dispatchType=REQUEST) -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러 -> View

/error-ex 오류 요청

• 필터는 DispatchType 으로 중복 호출 제거 ( dispatchType=REQUEST )
• 인터셉터는 경로 정보로 중복 호출 제거( excludePathPatterns("/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
  

스프링 부트 - 오류 페이지

스프링 부트는 예외 처리 페이지를 만드는 기능을 모두 기본으로 제공

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

    참고 ErrorMvcAutoConfiguration 이라는 클래스가 오류 페이지를 자동으로 등록하는 역할

이제 오류가 발생했을 때 오류 페이지로 /error를 기본 요청. 스프링 부트가 자동 등록한 BasicErrorController는 이 경로를 기본으로 받음

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

뷰 선택 우선순위 BasicErrorController의 처리 순서

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

해당 경로 위치에 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`)

오류 관련 내부 정보들을 고객에게 노출하는 것은 좋지 않음 고객이 해당 정보를 읽어도 혼란만 더해지고, 보안상 문제가 될 수도 있음 그래서 BasicErrorController 오류 컨트롤러에서 다음 오류 정보를 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 포함 여부

application.properties

server.error.include-exception=true
server.error.include-message=on_param
server.error.include-stacktrace=on_param
server.error.include-binding-errors=on_param

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

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

on_param은 파라미터가 있으면 해당 정보를 노출. 디버그 시 문제를 확인하기 위해 사용할 수 있음. 그런데 이 부분도 개발 서버에서 사용할 수 있지만, 운영 서버에서는 권장하지 않음 on_param으로 설정하고 다음과 같이 HTTP 요청시 파라미터를 전달하면 해당 정보들이 model에 담겨서 뷰 템플릿에서 출력된다. message=&errors=&trace=

스프링 부트 오류 관련 옵션

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

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