서블릿 예외처리의 시작
우리는 처음부터 스프링에 관한 예외처리를 알기 전 '순수 서블릿 컨테이너'는 예외를 어떻게 처리하는지부터 알ㅇ보자! 👍🤔
<예외처리의 2가지 방식>
서블릿은 다음 2가지 방식으로 예외처리를 지원.
1. Exception (예외)
2. response.sendError(HTTP 상태 코드, 오류 메시지)
1. Exception (예외)
✨ 자바 직접 실행
자바에 메인 메서드를 직접 실행하는 경우 main 이라는 이름의 쓰레드가 실행된다.
이 때 실행 도중 예외를 잡지 못하고 처음 실행한 main() 메서드를 넘어서 예외가 던져지면,
=> "예외 정보"를 남기고 해당 쓰레드는 종료된다
✨웹 애플리케이션
웹 애플리케이션은 사용자 요청별로 별도의 쓰레드가 할당되고, 서블릿 컨테이너 안에서 실행된다.
- 애플리케이션에서 예외가 발생했는데, 어디선가 try ~ catch로 예외를 잡아서 처리하면 아무런 문제가 없다.
- But 만약에 애플리케이션에서 예외를 잡지 못하고, 서블릿 밖으로 까지 예외가 전달되면
어떻게 동작할까?
곧 WAS 까지 예외가 전달된다... 😢🤦♀️🤦♀️🤦♀️
(이러면 안된다...)
+) application.properties 는 꺼두자 (스프링에서 제공하는 기본 예외 페이지)
server.error.whitelabel.enabled=falㄴe
실제로 해보니 tomcat에서 '기본 제공' 되는 오류화면이 뜬다. => 500에러
Exception의 경우라...
- F12로 보니, 웹 브라우저는 ' 서버 내부에서 처리할 수 없는 오류로군🤔' 이라 생각해 500 에러를 띄웠다.- 곧, '서버 내부'에서 예외를 처리하지 못한다면 WAS 는 반환할 Response가 없다는 뜻이다.
2. response.sendError(HTTP 상태 코드, 오류 메시지)
-
HttpServletResponse가 제공하는sendError라는 메서드를 사용해도 된다. -
또한 사용하면 'HTTP 상태코드' , '오류메시지'도 추가 (ㅇ)
-
예외를 처리하지 않고, WAS까지 던져버린다,,, 이것은
좋지 못한 방법이다. 그래서 서블릿 response 객체엔 이런 방법이 있다. =>sendError() -
response.sendError(HTTP 상태 코드, 오류 메시지)
이것을 호출한다고 당장 예외가 발생하는 것은 아니지만,
'서블릿 컨테이너' 에게 오류가 발생했다는 점(상태코드, 오류 메시지)을 전달할 수 있다.👍
[코드]
sendError()호출되면, response 내부에 '오류가 발생했다' 라는상태를 저장함- '서블릿 컨테이너'는 고객에게 응답 전에
response에sendError()가 호출되었는지 확인한다.- 그리고
호출되었다면, 설정한 오류 코드에 맞추어 '기본 오류 페이지'를 보여준다.
그런데 저런 기본 오류 화면만 보여주면 고객이 쉽게 오류를 알 수 있을까? 🤔🤷♂️
서블릿 예외 처리 - 오류 화면 제공
서블릿이 제공하는 오류 화면 기능을 사용해보자.
서블릿은 ¹
Exception(예외)가 발생해서 서블릿 밖으로 전달되거나 또는 ²response.sendError()가 호출 되었을 때 ... 각각의 상황에 맞춘 오류 처리 기능을 제공한다.😁
=> 이 기능을 통해서 고객 친화적인 오류화면을 보여줄 수 있다.
지금은 스프링 부트를 통해서 서블릿 컨테이너를 실행하기 때문에,
그래서 서블릿에서는 아래와 같은 방법으로 에러가 발생했을 때, 다시 '호출할 URL을 지정'할 수 있다👍👍
response.sendError(404): errorPage404 호출response.sendError(500): errorPage500 호출RuntimeException또는 그 자식 타입의 예외: errorPageEx 호출
-> 오류 페이지는 예외를 다룰 때해당 예외와 그 자식 타입의 오류를 함께 처리한다
[주의]
그 후 이 오류를 처리할 '컨트롤러'를 만들어 줘야 한다.
+) 물론 html에서 View 만들어주는 것은 당연한거임...
[흐름]
RuntimeException예외가 WAS까지 전달되면, WAS는 오류 페이지 정보를 확인한다.- 확인해보니
RuntimeException의 오류 페이지로/error-page/500이 지정되어 있다. - WAS는 오류 페이지를 출력하기 위해
/error-page/500를 다시 요청한다.
서블릿 예외처리 - 오류 페이지 작동 원리
그렇다면 오류 페이지 요청 흐름을 봐보자!!
오류 페이지 요청 흐름
예외 발생과 오류 페이지 요청 흐름
[전제] 예외가 WAS까지 전달.
1. 예외가 발생해서 WAS까지 전파된다.
2. WAS는 오류 페이지 경로를 찾아서 내부에서 오류 페이지를 호출한다.
-> 이때 오류 페이지 경로로 필터, 서블릿, 인터셉터, 컨트롤러가 모두 다시 호출된다.😂....
중요한 점은 '웹 브라우저(클라이언트)는' 서버 내부에서 이런 일이 일어나는지 전혀 모른다😎 (쉿!)
오직 서.버. 내.부.에서 '오류 페이지'를 찾기 위해 추가적인 호출을 한다.
+) 오류 정보 추가
- WAS는 오류 페이지를 단순히 다시 요청만 하는 것이 아니라, 오류 정보를
request의attribute에 '추가'해서 넘겨준다.
=> 필요하면 오류 페이지에서 이렇게 전달된 오류 정보를 사용할 수 있다.
참고 : ErrorPageController
서블릿 예외 처리 - 필터와 인터셉터
목표
예외 처리에 따른 '필터'와 '인터셉터' 그리고 서블릿이 제공하는 DispatchType 이해하기
1) 필터
근데 이상하다...
🤔 예외 발생과 오류 페이지 요청 흐름
- 우리는 오류가 발생하면 오류 페이지를 출력하기 위해 WAS 내부에서 다시 한 번 호출이 발생!
-> 그런데 로그인 인증 체크 같은 경우를 생각해보면, 이미 한 번 필터나, 인터셉터에서로그인 체크를 완료했다
=> 따라서 서버 내부에서 오류 페이지를 호출한다고 해서 '필터', '인터셉터', 서블릿 모두!!!! 다시 호출하는건...🤷♂️(너무 비효율적)- [목표]
클라이언트로 부터 발생한 '정상 요청'인지, 아니면 오류 페이지를 출력하기 위한 '내부 요청'인지 구분할 수 있어야 한다.
Dispatcher Type
필터는 위의 문제를 해결하기 위해 DispatchType 이라는 추가 정보를 제공한다.
종류
REQUEST: 클라이언트 요청ERROR: 오류 요청FORWARD: MVC에서 배웠던 서블릿에서 다른 서블릿이나 JSP를 호출할 때
RequestDispatcher.forward(request, response);INCLUDE: 서블릿에서 다른 서블릿이나 JSP의 결과를 포함할 때
->RequestDispatcher.include(request, response);ASYNC: 서블릿 비동기 호출
서블릿 스펙은 ¹ '실제 고객이 요청'한 것인지 or ²서버가 내부에서 '오류 페이지를 요청'하는 것인지 구분이 가능하다.
[LogFilter] 추가
@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");
}
}[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;
}
}-
고객이 처음 요청하면?
-dispatcherType=REQUEST이다 -
그리고 출력해보면 오류 페이지에서
-dispatchType=ERROR -
원래 기본은
filterRegistrationBean.setDispatcherTypes()이면 DispatcherType.REQUEST 이 디폴트로 되어 있다... -
특별히 오류 페이지 경로도 필터를 적용할 것이 아니면, 걍,,,,기본 값을 그대로 사용하면 된다.
그래서 사실은 오류페이지 요청에는 필터가 실행되지 않았다. 기본값은 REQUEST 하나 밖에 없어서 그렇다.
2) 인터셉터
인터셉터 중복 호출 제거
-> 얘는 따로 처리해주지 않는 이상 항상 호출해준다...🤦♀️
[LogInterceptor] 생성
@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 과 무관하게 항상 호출된다.
WebConfig 에 @Bean 주석 및 추가
//인터셉터
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new LogInterceptor())
.order(1)
.addPathPatterns("/**")
.excludePathPatterns(
"/css/**", "/*.ico"
, "/error", "/error-page/**" //오류 페이지 경로
);
}- 대신에 인터셉터는 다음과 같이 요청 경로에 따라서 추가하거나 제외하기 쉽게 되어 있기 때문에
-> 이러한 설정을 사용해서 오류 페이지 경로를excludePathPatterns를 사용해서 빼주면 된다. /error-page/**를 제거하면error-page/500같은 내부 호출의 경우에도 인터셉터가 호출된다.
전체 흐름 정리
if) /hello 정상 요청
if) /error-ex 오류 요청
- 필터는
DispatchType으로 중복 호출 제거
-> 굳! ( dispatchType=REQUEST )
-> (주의) 따로 오류처리 추가만 안하면 중복은 안된다! - 인터셉터는 경로 정보로 중복 호출 제거
-> 굳!(excludePathPatterns("/error-page/**"))
스프링 부트 - 오류 페이지
예외처리를 만들기 위해 우리는 WebServerCustomizer,ErrorPage, ErroController를 따로 만들어야 했다.
사실 번거롭게 만들지 않아도 스프링 부트는 이런 과정을 모두 기본으로 제공한다.
어떻게?
-
/error/오류코드.html을 기본 오류페이지 경로로 인식
-
스프링 부트에서
BasicErrorController라는 컨트롤러를 자동으로 등록한다.
➡ 기본 경로(/error/오류코드.html)를 매핑한다.
-
스프링 부트의
ErrorMvcAutoConfiguration라는 클래스가 사용할 오류페이지를 WAS에 등록한다.
➡ 이제 서블릿 예외나response.sendError(...)가 호출되면 모든 오류를/error/... URL을 호출한다. -
그리고 더 xxx.html은 더 세세한 것이 우선순위가 높다.
개발자는 어떻게 오류페이지를 고려하는가?
이제 오류페이지를 만들려고 WebServerCustomizer를 설정하고, 컨트롤러를 만들필요가 없다.
스프링부트를 이용해서 /error/...경로에 404.html 같은 에러페이지를 만들면 자동으로 등록된다.
더 발전해서 이런거까지도 있다.[추천하지 x]
- BasicErrorController 컨트롤러는 다음 정보를 model에 담아서 뷰에 전달한다. 뷰 템플릿은 이 값을 활용해서 출력할 수 있다.
우리는 고객들에게 알쓸잘딱! 해야한다...😁👍
- 내부정보를 노출하지 말자
- 아래와 같이 오류정보를 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포함 여부
기본 값이 이렇게 3가지 있다.
never: 사용하지 않음always:항상 사용on_param: 파라미터가 있을 때 사용
권고
사실 위에서 말한 이런 것도 추천하지 않는다...
제일 좋은 것은 사용자에게 '이쁜 오류 화면'과 고객이 이해할 수 있는 간단한 오류 메시지를 보여주고
오류는 서버에 로그로남겨서 로그로 확인해야 한다.🐛🐛
스프링 부트 오류 관련 옵션
server.error.whitelabel.enabled=true
- 오류 처리 화면을 못 찾을 시, 스프링 whitelabel 오류 페이지 적용 (기본 오류화면)server.error.path=/error:
- 오류 페이지 경로,
-> 걍 안 건들이면 자동으로 error 임.
