서블릿 예외처리

업데이트: January 19, 2022

서블릿 예외처리

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

Exception

자바 직접 실행

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

웹 애플리케이션

사용자 요청별로 별도의 쓰레드가 할당디고, 서블릿 컨테이너 안에서 실행된다.
예외가 발생하고 try ~catch로 예외를 잡아서 처리하면 아무런 문제가 없다.
예외를 못잡고 서블릿 밖으로 까지 예외가 전달되면 톰캣 같은 WAS까지 예외가 전달된다.
- HTTP 상태코드 500을 반환한다.

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

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

오류가 발생했을때 호출한다고 당장 예외가 발생하는 것은 아니지만, 서블릿 컨테이너에게 오류가 발생했다는 점을 전달할 수 있다.

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

sendError 흐름

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

response.sendError()를 호출하면 response 내부에는 오류가 발생했다는 상태를 저장해둔다. 그리고 서블릿컨테이너는 고객에게 응답전에 response에 sendError()가 호출되었는지 확인한다. 그리고 호출되었다면 설정한 오류코드에 맞추어 기본 오류페이지를 보여준다.

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

서블릿은 오류가 호출되었을때 각각에 상황에 맞춘 오류 처리 기능을 제공한다.

import org.springframework.boot.web.server.ConfigurableWebServerFactory;
import org.springframework.boot.web.server.ErrorPage;
import org.springframework.boot.web.server.WebServerFactoryCustomizer;
import org.springframework.http.HttpStatus;

public class WebServerCustomizer implements WebServerFactoryCustomizer<ConfigurableWebServerFactory> {
    @Override
    public void customize(ConfigurableWebServerFactory factory) {

        ErrorPage errorPage404 = new ErrorPage(HttpStatus.NOT_FOUND, "/error-page/400");
        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 호출

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

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

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

예외가 발생하면 WAS 까지 전파된다.

WAS는 오류 페이지 경로를 찾아서 내부에서 오류 페이지를 호출한다. 이떄 오류 페이지 경로로 필터, 서블릿, 인터셉터, 컨트롤러가 모두 다시 호출된다.

오류 정보 추가

WAS는 오류 페이지를 단순히 다시 요청하는 것만이 아니라, 오류 정보를 request의 attribute에 추가해서 넘겨준다. 필요하면 오류 페이지에서 이렇게 전달된 오류 정보를 사용할 수 있다.

@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("404");
        printErrorInfo(request);
        return "error-page/404";
    }

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

    private void printErrorInfo(HttpServletRequest request){

        log.info("ERROR_EXCEPTION : {}", request.getAttribute(ERROR_EXCEPTION));
        log.info("ERROR_EXCEPTION_TYPE : {}", request.getAttribute(ERROR_EXCEPTION_TYPE));
        log.info("ERROR_MESSAGE : {}", request.getAttribute(ERROR_MESSAGE));
        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());

    }
}

서블릿 예외 처리 - 필터

오류가 발생하면 오류페이지를 출력하기 위해 WAS 내부에서 다시 한번 호출한다. 이떄 필터, 서블릿 인터셉터도 모두 다시 호출되는데 이럴경우 한번 호출된 필터나 인터셉터가 한번더 호출되는 것은 매이 비효율 적이다.
결국 클라이언트로부터 발생한 정상 요청인지, 오류 페이지를 출력하기 위한 내부 요청인지 구분할 수 있어야 하고 서블릿은 이런 문제를 해결하기 위해 Dispatchertype이라는 추가 정보를 제공한다.

DispatcherType

고객이 처음 요청하면 dispatcherType=REQUEST 이다.
REQUEST: 클라이언트요청
ERROR: 오류요청
FORWARD: MVC에서배웠던서블릿에서다른서블릿이나 JSP를호출할때 RequestDispatcher.forward(request, response);
INCLUDE: 서블릿에서다른서블릿이나 JSP의결과를포함할때 RequestDispatcher.include(request, response);
ASYNC: 서블릿비동기호출
디폴트는 REQUEST로 필터가 필요한 경우 추가해준다.

import hello.exception.filter.LogFilter;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import javax.servlet.DispatcherType;
import javax.servlet.Filter;

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Bean
    public FilterRegistrationBean logFilter() {
        FilterRegistrationBean<Filter> filterFilterRegistrationBean = new FilterRegistrationBean<>();
        filterFilterRegistrationBean.setFilter(new LogFilter());
        filterFilterRegistrationBean.setOrder(1);
        filterFilterRegistrationBean.addUrlPatterns("/*");
        filterFilterRegistrationBean.setDispatcherTypes(DispatcherType.REQUEST, DispatcherType.ERROR);
        return filterFilterRegistrationBean;
    }
}

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

서블릿 예외 처리 - 예외처리

필터의 경우에는 어떤 DispatcherType인 경우 적용할지 선택할 수 있지만 인터셉터는 스프링 기술로 항상 호출된다.
인터셉터는 요청 경로에 따라서 추가하거나 제외하기 위해서는 excludePathPatterns 사용해서 빼주면 된다.

정상 요청

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

error 오류 요청

필터는 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

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.UUID;

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


@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/**");// 에러페이지 
    }
}

스프링 부트-오류 페이지

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

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

뷰 선택 우선순위

템플릿
- 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
적용대상이 없을때 뷰 이름
- resources/templates/error.html

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

Twitter Facebook LinkedIn

신주용

서블릿 예외처리

서블릿 예외처리

Exception

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

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

오류 정보 추가

서블릿 예외 처리 - 필터

DispatcherType

서블릿 예외 처리 - 예외처리

스프링 부트-오류 페이지

공유하기

댓글남기기

참고

OAuth 2.0 정리

System Structure & Program Execution 1

System Structure & Program Execution 1

Introduction to Operating Systems