[스프링 MVC 2] 예외 처리와 오류 페이지

스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 대시보드 - 인프런 | 강의 (inflearn.com)

스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 - 인프런 | 강의

서블릿 예외 처리 방법

① Exception

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

② response.sendError(HTTP 상태 코드, 오류 메시지): 상태 코드와 오류 메시지 설정 가능

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

 

기본 에러 페이지 없으면 상태코드와 함께 메시지 출력

① ServletExController: 예외를 발생 시키는 컨트롤러

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

② WebServerCustomizer: 예외 발생 시, 어떤 URL로 요청을 보낼 지 설정

@Component
public class WebServerCustomizer implements WebServerFactoryCustomizer<ConfigurableWebServerFactory> {
    @Override
    public void customize(ConfigurableWebServerFactory factory) {
        ErrorPage errorPage404 = new ErrorPage(NOT_FOUND, "/error-page/404");
        ErrorPage errorPage500 = new ErrorPage(INTERNAL_SERVER_ERROR, "/error-page/500");
        ErrorPage errorPageEx = new ErrorPage(RuntimeException.class, "/error-page/500");
 
        factory.addErrorPages(errorPage404, errorPage500, errorPageEx);
    }
}

③ ErrorPageController: 예외 처리 화면을 띄워주는 컨트롤러

@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()가 호출되었을 때

설정된 오류 페이지를 찾음

 

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

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

 

WAS는 오류 페이지 출력을 위해 /error-page/500으로 요청

 

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

1. 예외가 발생해서 WAS까지 전파됨

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

 

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

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

 

※ 웹 브라우저 (클라이언트)는 서버 내부에서 이런 일이 일어나는지 전혀 모름

 

오류 정보를 request의 attribute에 추가해서 넘겨주면 오류 페이지에서 전달된 오류 정보 사용 가능

//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";
 
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());
}

 

결과

ERROR_EXCEPTION_TYPE: class java.lang.RuntimeException
ERROR_MESSAGE: Request processing failed; nested exception is java.lang.RuntimeException: 예외 발생!
ERROR_REQUEST_URI: /error-ex
ERROR_SERVLET_NAME: dispatcherServlet
ERROR_STATUS_CODE: 500
dispatchType: ERROR

 

서블릿 예외 처리 - 필터

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

클라이언트로 부터 발생한 정상 요청인지, 오류 페이지를 출력하기 위한 내부 요청인지 구분해야 함

 

DispatcherType

① REQUEST : 클라이언트 요청

② ERROR : 오류 요청

③ FORWARD : MVC에서 배웠던 서블릿에서 다른 서블릿이나 JSP를 호출할 때

RequestDispatcher.forward(request, response);

④ INCLUDE : 서블릿에서 다른 서블릿이나 JSP의 결과를 포함할 때

RequestDispatcher.include(request, response);

⑤ ASYNC : 서블릿 비동기 호출

 

필터 등록: DispatcherTypes에 따라서 Filter 호출 여부 결정됨

@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.ERROR, DispatcherType.REQUEST);
    return filterRegistrationBean;
    }
}

 

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

인터셉터는 dispatcherType 지정 불가
excludePathPatterns에서 에러 페이지를 제외시킴

@Override
public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(new LogInterceptor())
            .order(1)
            .addPathPatterns("/**")
            .excludePathPatterns("/css/**", "*.ico", "/error", "/error-page/**");
}

 

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

 

 

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

기본 오류 페이지 경로: /error

스프링 부트가 자동으로 BasicErrorController 등록 (기본적인 로직 모두 개발되어 있음)

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

 

뷰 선택 우선순위

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

 

• 해당 경로 위치에 HTTP 상태 코드 이름의 뷰 파일을 넣어두면 됨.
• 뷰 템플릿 > 리소스 / 구체적인 것 (404, 500) > 덜 구체적인 것 (5xx)
• 5xx, 4xx 라고 하면 500대, 400대 오류를 처리해줌

 

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)

 

기능 확장

ErrorController 또는 BasicErrorController 상속 받아서 구현 / 기능 추가