예외 처리와 오류 페이지

slee2·2022년 2월 18일

Spring exception

(인프런)스프링 MVC 2편

목록 보기

38/43

프로젝트 생성

생략

서블릿 예외 처리 - 시작

서블릿 예외처리는 2가지 방법이 있다.

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

Exception(예외)

자바 직접 실행
main() 메서드를 넘어서 예외가 던져지면, 예외 정보를 남기고 해당 쓰레드는 종료된다.

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

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

톰캣 같은 WAS까지 예외가 전달된다.
그럼 WAS에서는 어떻게 처리할까?

정확한 테스트를 위해서 스프링 부트가 제공하는 기본 예외 페이지를 꺼야한다.
application.properties

server.error.whitelabel.enabled=false

이와 같이 WAS는 Exception의 경우 서버 내부에서 처리할 수 없는 오류가 발생한 것으로 생각해서 상태코드 500을 반환한다.

해당하는 웹 페이지가 없을때는 404 에러를 보낸다.

이와 같이 처리하면 404 에러, 500 에러 처럼 원하는 오류 코드를 전송할 수 있다.
response.sendError()를 호출하면 response 내부에는 오류가 발생했다는 상태를 저장해둔다. 그리고 서블릿 컨테이너는 고객에게 응답 전에 response에 sendError()가 호출되었는지 확인한다.

Exception - 무조건 500 에러
snedError() - 원하는 에러코드

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

서블릿이 제공하는 오류 화면 기능을 사용해보자.

옛날에는 이렇게 했다.

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

지금은 스프링 부트를 통해서 서블릿 컨테이너를 실행하기 때문에, 스프링 부트가 제공하는 기능을 사용해서 오류 페이지를 등록하면 된다.

서블릿 예외 처리 - 오류 페이지 작동 원리

서블릿은 Exception(예외)가 발생해서 서블릿 밖으로 전달되거나 또는 response.sendError()가 호출되었을때 설정된 오류 페이지를 찾는다.

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

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

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

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

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

정리하면
1. 예외가 발생하면 WAS까지 전파된다.
2. WAS는 오류 페이지 경로를 찾아서 내부에서 오류 페이지를 호출한다. 이때 오류 페이지 경로로 필터, 서블릿, 인터셉터, 컨트롤러가 모두 다시 호출된다.

에러 정보 얻기

위는 RequestDispatcher의 상수이다. request에서 getAttribute로 얻어올 수 있다.

error-ex

error-404

error-500

서블릿 예외 처리 - 필터

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

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

그렇기 때문에 클라이언트에서 발생한 정상 요청인지,
오류 페이지를 출력하기 위한 내부 요청한지 구분하기 위해
DispatcherType라는 추가 정보를 제공한다.

위 예시를 보면
dispatchType=ERROR로 나온 것을 확인할 수 있다.

고객이 처음 요청할때는
dispatchType=REQUEST이다.

이렇듯 서블릿 스텍은 실제 고객이 요청한 것인지, 서버가 내부에서 오류 페이지를 요청한 것인지 DispatcherType으로 구분할 수 있는 방법을 제공한다.

javax.servlet.DispatcherType

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

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

이 DispatcherType을 확인하기 위해 이전 강의에서 했던 Filter를 다시 가져왔다.

이전 예제에서 dispatcherType출력을 추가한다.

그리고 WebConfig에 추가해준다.

처음에는 REQUEST를 날렸으나 Exception이 발생하고 난 뒤에 ERROR도 다시 받는 것을 확인할 수 있다.

filterRegistrationBean.setDispatcherTypes(DispatcherType.REQUEST, DIspatcherType.ERROR);
이렇게 두 가지를 모두 넣으면 클라이언트 요청과 오류 페이지 요청에서 필터가 호출된다.

디폴트 값은 REQUEST이다. 즉, 클라이언트의 요청이 있는 경우에만 필터가 적용된다. 특별히 오류 페이지 경로도 필터를 적용할 것이 아니면, 기본 값을 그대로 사용하면 된다.

오류 페이지 요청 전용 필터를 적용하고 싶으면 ERROR만 넣으면 된다.

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

인터셉터의 경우 /error-page/**를 추가함으로써 오류 페이지를 접근할때는 인터셉터가 호출되지 않는다.
여기서 만약 /error-page/**를 지우게 되면,

이렇게 두번 호출된다.

전체 흐름

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

/error-ex 오류 요청
1. WAS(/error-ex, dispatchType=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.sendErro(...)가 호출되면 만든 오류는 /error를 호출하게 된다.

BasicErrorController라는 스프링 컨트롤러를 자동으로 등록한다.

ErrorPage에서 등록한 /error를 매핑해서 처리하는 컨트롤러다.

주의
스프링 부트가 제공하는 기본 오류 메커니즘을 사용하기 위해 WebServerCustomizer에 있는 @Component를 주석 처리해야 한다.

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

BasicErrorController는 기본적인 로직이 모두 개발되어 있다.
개발자는 오류 페이지 화면만 BasicErrorController가 제공하는 룰과 우선순위에 따라서 등록하면 된다.

뷰 선택 우선순위

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

resource/templates/error.html

뷰 템플릿이 정적 리소스보다 우선순위가 높고, 404, 500 처럼 구체적인 것이 4xx, 5xx 처럼 덜 구체적인 것보다 우선순위가 높다.

BasicErrorController가 제공하는 기본 정보들

BasicErrorController에서 이러한 정보들을 뿌려준다.
그런데 이런 중요한 정보들을 고객들에게 알려주는 것은 좋은 방법이 아니다.
그렇기 때문에 웬만한건 기본적으로 막아져 있어서 null이 많은 것을 볼 수 있다.

이 정보들을 설정에서 보여지도록 할 수 있다.
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, always, on_param
안함, 항상함, 파라미터 있을때만 함
3가지로 설정할 수 있다.
파라미터의 경우 /error-ex?message=&errors= 와 같이 파라미터 넣을때 ㅇㅇ

실무에서는 이것들을 노출하면 안된다.
사용자에게 이쁜 오류 화면과 고객이 이해할 수 있는 간단한 오류 메시지를 뷰여주고 오류는 서버에 로그로 남겨서 로그를 확인해야 한다.

스프링 부트 오류 관련 옵션

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

확장 하고싶으면
ErrorController 인터페이스를 상속받아서 구현하거나, BasicErrorController 상속받아서 기능을 추가하면 된다.
그런데 그럴일이 있을까...?

결국에 핵심은