프로젝트 생성
전체적인 구조를 한번 보고간다.
서블릿 컨테이너(Servlet Container) 란?
서블릿들을 위한 상자(Container) 입니다.
velog.io
스프링 컨테이너와 서블릿 컨테이너 - 인프런 | 질문 & 답변
안녕하세요! 강의를 든던중 궁금한 점이 있어서 이렇게 질문 남깁니다. 스프링 컨테이너는 서블릿 컨테이너의 한 종류라고 인식을 해도 되는걸가요? - 질문 & 답변 | 인프런...
www.inflearn.com
서블릿 예외 처리
스프링이 아닌 순수 서블릿 컨테이너는 예외를 어떻게 처리하는지 알아보자.
서블릿은 다음 2가지 방식으로 예외 처리를 지원한다
- Exception (예외) (우리가 보는 일반적인 예외, ex ) 널포인트예외 등등
- response.sendError(HTTP 상태 코드, 오류 메시지) response에 있는 sendError()메소드를 이용해서
Exception (예외)
자바 직접 실행 (자바의 기본적인 메커니즘)
자바의 메인 메서드를 직접 실행하는 경우 main 이라는 이름의 쓰레드가 실행된다.
실행 도중에 예외를 잡지 못하고 처음 실행한 main() 메서드를 넘어서 예외가 던져지면,
예외 정보를 남기고 해당 쓰레드는 종료된다.
웹 애플리케이션
웹 애플리케이션은 사용자 요청별로 별도의 쓰레드가 할당되고, 서블릿 컨테이너 안에서 실행된다.
애플리케이션에서 예외가 발생했는데, 어디선가 try ~ catch로 예외를 잡아서 처리하면 아무런 문제가 없다
그런데 만약에 애플리케이션에서 예외를 잡지 못하고, 서블릿 밖으로 까지 예외가 전달되면 어떻게 동작할까?
컨트롤러에서 예외가 발생한다고 하면
결국 톰캣 같은 WAS 까지 예외가 전달된다.
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을 반환한다.
(500 = Internal Server Error)
예외나 에러 발생시 해당 예외,에러에 맞는 오류페이지(Error Page) 를 찾는다.
이번에는 아무사이트나 호출해보자.
톰캣이 기본으로 제공하는 404 오류 화면을 볼 수 있다. (예외발생)
WAS에 예외가 전달되면 500으로 처리되야하는데
404인 이유는 뒤에서 배울 ExceptionHandler중
스프링 부트 기본 제공 ExceptionHandler인 DefaultHandlerExceptionResolver 때문이다.
https://keeeeeepgoing.tistory.com/217
오류(Error)와 예외(Exception) 구분하기
https://toneyparky.tistory.com/40
Java의 Error와 Exception 그리고 예외처리 전략
우아한테크코스(이하 우테코) 레벨 1 복습을 위한 글입니다. 자바는 오류가 발생하거나 발생할 여지가 있는 여러 상황에 대한 예외를 만들어두었습니다. 우리에게 익숙한 IllegalArgumentException을
toneyparky.tistory.com
response.sendError(HTTP 상태 코드, 오류 메시지)
오류(에러)가 발생했을 때 HttpServletResponse가 제공하는 sendError라는 메서드를 사용해도 된다.
이것을 호출한다고 당장 예외가 발생하는 것은 아니지만, 서블릿 컨테이너에게 오류가 발생했다는 점을 전달할 수 있다.
이 메서드를 사용하면 HTTP 상태 코드와 오류 메시지도 추가할 수 있다.
response.sendError(HTTP 상태 코드)
response.sendError(HTTP 상태 코드, 오류 메시지)
ServletExController - response.sendError() 추가
@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, "500 오류!");
}
response.sendError() 흐름
response.sendError() 를 호출하면 response 내부에는 오류가 발생했다는 상태를 저장해둔다.
그리고 서블릿 컨테이너(was안에있음)는 고객에게 응답 전에 response 에 sendError() 가 호출되었는지 확인한다.
그리고 호출되었다면 설정한 오류 코드에 맞추어 기본 오류 페이지를 보여준다.
실행해보면 다음처럼 서블릿 컨테이너가 기본으로 제공하는 오류 화면을 볼 수 있다.
정리
서블릿 컨테이너가 제공하는 기본 예외 처리 화면은 사용자가 보기에 불편하다.
의미 있는 오류 화면을 제공해보자.
서블릿 예외 처리 - 오류 화면 제공
서블릿 컨테이너가 제공하는 기본 예외 처리 화면은 고객 친화적이지 않다.
서블릿이 제공하는 오류 화면 기능을 사용해보자.
서블릿은 Exception (예외)가 발생해서 서블릿 밖으로 전달되거나
또는 response.sendError()가 호출 되었을 때 각각의 상황에 맞춘 오류 처리 기능을 제공한다.
이 기능을 사용하면 친절한 오류 처리 화면을 준비해서 고객에게 보여줄 수 있다.
지금은 스프링 부트를 통해서 서블릿 컨테이너를 실행하기 때문에,
스프링 부트가 제공하는 기능을 사용해서 서블릿 오류 페이지를 등록하면 된다
서블릿 오류 페이지 등록
@Component //스프링빈으로 등록시켜야한다.
public class WebServerCustomizer implements WebServerFactoryCustomizer<ConfigurableWebServerFactory> {
@Override
public void customize(ConfigurableWebServerFactory factory) {
ErrorPage errorPage404 = new ErrorPage(HttpStatus.NOT_FOUND, "/error-page/404");//404에러가 났을경우 /error-page/400의 경로를 호출한다.( 서버주소 + /error-page/400의 URL을 요청한다는뜻)
ErrorPage errorPage500 = new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR, "/error-page/500");
ErrorPage errorPageEX = new ErrorPage(RuntimeException.class, "/error-page/500"); //RuntimeException가 발생했을경우에도 설정가능
factory.addErrorPages(errorPage404, errorPage500, errorPageEX); //에러페이지들을 등록한다.
}
}어떤 상태코드나, 에러가 발생했을때 내가 지정한 뷰를 보여주게끔 하려면
에러페이지 객체를 만들어 설정하고, 등록해준다.
500 예외가 서버 내부에서 발생한 오류라는 뜻을 포함하고 있기 때문에
여기서는 예외가 발생한 경우도 500 오류 화면으로 처리했다.
오류 페이지는 예외를 다룰 때 해당 예외와 그 자식 타입의 오류를 함께 처리한다.
예를 들어서 위의 경우 RuntimeException 은 물론이고 RuntimeException 의 자식도 함께 처리한다.
오류가 발생했을 때 처리할 수 있는 컨트롤러가 필요하다.
(에러페이지를 생성하면서 경로 지정할때 "/error-page/400"이런식으로 이동시킬 경로를 지정해주었으므로
서버주소 + "/error-page/400" 에 대한 요청이 왔을때 처리할 컨트롤러가 필요하다.)
예를 들어서 RuntimeException 예외가 발생하면 errorPageEx 에서 지정한 /error-page/500 이 호출된다.
정리
스프링 부트가 로딩 될 때 이러한 ErrorPage 정보를 생성해서 서블릿 컨테이너에 전달하게 되고
서블릿 컨테이너는 ErrorPage들을 가지고있는다.
그 후 컨트롤러에서 예외가 발생해서 was까지 왔는데 그 예외가 404 관련된 예외라고 해보자.
(우리가 위에서 에러페이지를만든)
그러면 was는 에러페이지들중 404 예외에 맞는걸 찾고 해당 path를 본후
path에 대한 요청을한다.(서버 주소 + PATH ==> localhost:8080/error-page/400 을 request한다.)(그러므로 다시 컨트롤러까지 들어가서 진행된다.)
오류를 처리할 컨트롤러
@Slf4j
@Controller
public class ErrorPageController {
//was가 에러페이지의 경로를 보고 다시 요청을했을때
//오류 화면을 보여주기 위한 컨트롤러
@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"; //해당 뷰 템플릿으로 이동
}
}
실행결과
예외를 발생시키는 SerlvetExController의 메소드들을 이용해서 에러페이지가 잘 보이는지 체크해보자.
@GetMapping("/error-ex")
public void errorEx() {
throw new RuntimeException("예외 발생!");
}
@GetMapping("/error-404")
public void error404(HttpServletResponse response) throws IOException {
response.sendError(404, "404 오류!");
}
서블릿 예외 처리 - 오류 페이지(Error Page) 작동 원리
1.서블릿은 Exception (예외)가 발생해서 서블릿 밖으로 전달되거나
2. response.sendError() 가 호출 되었을 때
설정된 오류 페이지를 찾는다.
예외 발생 흐름
sendError 흐름
WAS는 해당 예외를 처리하는 오류 페이지(Error Page) 정보를 확인한다
new ErrorPage(RuntimeException.class, "/error-page/500");예를 들어서 RuntimeException 예외가 WAS까지 전달되면, WAS는 오류 페이지 정보를 확인한다.
확인해보니 RuntimeException 의 오류 페이지로 /error-page/500 이 지정되어 있다.
WAS는 오류 페이지를 출력하기 위해 /error-page/500 를 다시 요청한다.
(http요청이 다시온것은 아니고 서버내부에서 요청이 다시온것처럼, 해당 path를 이용해서 다시 request한다.)
오류 페이지 요청 흐름
예외 발생과 오류 페이지 요청 흐름
중요한 점은 웹 브라우저(클라이언트)는 서버 내부에서 이런 일이 일어나는지 전혀 모른다는 점이다.
오직 서버 내부에서 오류 페이지를 찾기 위해 추가적인 호출을 한다.
정리하면 다음과 같다.
1. 예외가 발생해서 WAS까지 전파된다.
2. WAS는 오류 페이지 경로를 찾아서 내부에서 오류 페이지를 호출한다.
이때 오류 페이지 경로로 필터, 서블릿, 인터셉터, 컨트롤러가 모두 다시 호출된다.
필터와 인터셉터가 다시 호출되는 부분은 조금 뒤에 자세히 설명하겠다.
오류 정보가 추가되서 넘어온다.
WAS는 오류 페이지를 단순히 다시 요청만 하는 것이 아니라, 오류 정보를 request의 attribute 에 추가해서 넘겨준다.
필요하면 오류 페이지에서 이렇게 전달된 오류 정보를 사용할 수 있다.
ErrorPageController - 오류 출력
@Slf4j
@Controller
public class ErrorPageController {
//was가 에러페이지의 경로를 보고 다시 요청을했을때
//오류 화면을 보여주기 위한 컨트롤러
//request.attribute 에 어떤 에러 정보가 들어오는지 속성명이 RequestDispatcher 상수로 정의되어 있음
//여기서는 RequestDispatcher.ERROR_EXCEPTION 이런식으로 가져오지않고, 내용을 보여주기위해 전역변수로 선언해두었다.
public static final String ERROR_EXCEPTION = "jakarta.servlet.error.exception";
public static final String ERROR_EXCEPTION_TYPE = "jakarta.servlet.error.exception_type";
public static final String ERROR_MESSAGE = "jakarta.servlet.error.message";
public static final String ERROR_REQUEST_URI = "jakarta.servlet.error.request_uri";
public static final String ERROR_SERVLET_NAME = "jakarta.servlet.error.servlet_name";
public static final String ERROR_STATUS_CODE = "jakarta.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"; //해당 뷰 템플릿으로 이동
}
//request.attribute 에 들어가있는 정보를 출력해보자.
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("dispatcherType={}", request.getDispatcherType());
}
}
http://localhost:8080/error-ex 를 호출했을때 로그가 찍힌 결과
http://localhost:8080/error-404 를 호출했을때 로그가 찍힌 결과
response.sendError()는
response.sendError(404, "404 오류!");서블릿 컨테이너에 에러가있고 이런정보다 라고 알려주는것이지
예외를 발생시키는것이 아니므로 erorr_exception에 null이 나온다.
나중에 서블릿컨테이너(was안에있음)가 sendError()가 호출됬는지 체크하고,
내부 내용을 봐서 에러페이지를 찾는다. 그리고 에러페이지의 path를 호출하면서 에러정보를 response.attribute에 담아 같이 보내준다.
서블릿 예외 처리 - 필터
목표
예외 처리에 따른 필터와 인터셉터 그리고 서블릿이 제공하는 DispatchType 이해하기
(서블릿 == 디스패처 서블릿 )
오류가 발생하면 오류 페이지를 출력하기 위해 WAS 내부에서 다시 한번 호출이 발생한다.
이때 필터, 서블릿, 인터셉터도 모두 다시 호출된다.
그런데 로그인 인증 체크 같은 경우를 생각해보면, 이미 한번 필터나, 인터셉터에서 로그인 체크를 완료했다.
(기본적으로 클라이언트의 http요청에 의해 한번 필터,인터셉터를 지나가게 되고 , ( 이때 로그인체크를 완료)
컨트롤러에서 에러가 발생해서 다시 에러페이지경로로 요청(request)되는것이므로 한번 더 필터,인터셉터를 지나가게 된다.)
따라서 서버 내부에서 오류 페이지를 호출한다고 해서 해당 필터나 인터셉트가 한번 더 호출되는 것은 매우 비효율적이다.
결국 클라이언트로 부터 발생한 정상 요청인지, (일반적인 URL로 인한 http요청인지)
아니면 오류 페이지를 출력하기 위한 내부 요청인지 구분할 수 있어야한다.
(오류페이지 출력을 위해 was에서 다시요청들어오는것인지)
서블릿은 이런 문제를 해결하기 위해 DispatcherType 이라는 추가 정보를 제공한다
DispatcherType
필터는 이런 경우를 위해서 dispatcherTypes 라는 옵션을 제공한다.
WAS는 오류 페이지를 단순히 다시 요청만 하는 것이 아니라, 오류 정보를 request의 attribute 에 추가해서 넘겨준다.
라고 하면서 오류정보를 로그로 찍어보면서 마지막 줄에 다음 로그를 추가했다.
log.info("dispatcherType={}", request.getDispatcherType());그리고 출력해보면
오류 페이지에서 dispatchType=ERROR 로 나오는 것을 확인할 수 있다.
고객이 처음 요청하면 dispatcherType=REQUEST 이다.
이렇듯
서블릿 스펙은 실제 고객이 요청한 것인지, 서버가 내부에서 오류 페이지를 요청하는 것인지
DispatcherType 으로 구분할 수 있는 방법을 제공한다.
REQUEST : 클라이언트 요청
ERROR : 오류 요청
FORWARD : MVC에서 배웠던 서블릿에서 다른 서블릿이나 JSP를 호출할 때
RequestDispatcher.forward(request, response);
INCLUDE : 서블릿에서 다른 서블릿이나 JSP의 결과를 포함할 때 RequestDispatcher.include(request, response);
ASYNC : 서블릿 비동기 호출
필터와 DispatcherType
필터와 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() 을 추가하였다.
필터 등록
@Configuration
public class WebConfig implements WebMvcConfigurer { //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(클라이언트가 http요청할때), ERROR (was가 에러페이지를 띄우기위해 다시 컨트롤러를 호출할때)에 필터가 동작하게끔 설정했다.
//DispatcherType.REQUEST는 기본값이므로 안넣어도 적용된다.
return filterRegistrationBean;
}
}filterRegistrationBean.setDispatcherTypes(DispatcherType.ERROR);
//이 필터를 적용할 DispatcherType을 설정해준다. (여러개를 넣을수있다.)
// 지금설정은 Request(클라이언트가 http요청할때), ERROR (was가 에러페이지를 띄우기위해 다시 컨트롤러를 호출할때)에 필터가 동작하게끔 설정했다.
//DispatcherType.REQUEST는 기본값이므로 안넣어도 적용된다.이렇게 두 가지를 모두 넣으면 클라이언트 요청은 물론이고, 오류 페이지 요청에서도 필터가 호출된다.
아무것도 넣지 않으면 기본 값이 DispatcherType.REQUEST 이다.
즉 클라이언트의 요청이 있는 경우에만 필터가 적용된다.
특별히 오류 페이지 경로도 필터를 적용할 것이 아니면, 기본 값을 그대로 사용하면 된다.
물론 오류 페이지 요청 전용 필터를 적용하고 싶으면 DispatcherType.ERROR 만 지정하면 된다.
실행 결과
http://localhost:8080/error-ex 호출시
런타임 예외가 발생할것이고, was가 에러페이지에 있는 경로를 이용해 컨트롤러를 호출해줄것이다.
즉
1. http://localhost:8080/error-ex 호출했을때 로그가 찍힐것이고 (DispatcherType.REQUEST )
2. was가 에러페이지에 있는 경로를 이용해 컨트롤러를 호출해줄때 로그가 찍힐것이다. ( DispatcherType.ERROR)
http://localhost:8080/error-ex 호출했을때 LogFilter로 인해 request,response 로그가 찍힌것을 확인할 수 있다.
(위에서 filterRegistrationBean.setDispatcherTypes(DispatcherType.ERROR);로 설정해서
DispatcherType이 Error여도 필터가 동작하게 했다.)
컨트롤러의 로직이 끝나서, 필터도 마무리 동작을 하고,
그 이후 던져진 예외때문에 was에서 다시 에러페이지경로로 호출을 한것을 확인할 수 있다.
dispatcherType을 보면 ERROR임을 확인할 수 있다.
http://localhost:8080/error-500 호출시
error-500에 매핑된 메소드에서는
response.sendError()를 이용하기 때문에 실제로 예외가 발생하지않고, 해당 에러에대한 에러페이지를 확인해서
에러페이지의 경로를 호출한다. (로그에 예외에 대한 내용이 없는것을 확인할 수 있다.)
예외의 이동 흐름
@GetMapping("/error-ex")
public void errorEx() {
throw new RuntimeException("예외 발생!");
}컨트롤러에서 발생한 예외가 쭉쭉 위로 올라올것인데 서블릿을 지나 필터로 올라오다가
try {
log.info("REQUEST [{}][{}][{}]", uuid, request.getDispatcherType(), requestURI);
chain.doFilter(request, response);
} catch (Exception e) {
log.info("Exception = {} ", e.getMessage());
throw e;
} finally {
log.info("RESPONSE [{}][{}][{}]", uuid, request.getDispatcherType(), requestURI);
}LogFilter의 doFilter() 메소드 내부의 catch(Exception e)에서 잡히게된다.
그 이유는 try부분에서 doFilter()메소드로 인해 다음 필터가 실행될것이고, 다음 필터가 없다면 서블릿,컨트롤러가 실행될텐데 컨트롤러에서 동작을 진행중 예외가 발생하면 필터의 catch()가 동작하게 된다.
(컨트롤러에서 예외가 발생하지않으면 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러 -> 인터셉터 -> 서블릿 -> 필터
이런순서대로 진행된다 (재귀함수처럼 가장 나중에 호출된것이 가장먼저 끝나고, 그다음이 끝나고, 이런식으로)
로그로 확인가능
그다음 catch(Exception e) 내부를 보면 throw e; 로 그 예외를 던져주기 때문에
그 다음인 was까지 예외를 전달받을 수 있는것이다.
그다음 에러 페이지 경로를 호출하기 위해 필터를 거치고, 서블릿을 지나고, 인터셉터를 거치고, 컨트롤러로 가서 해당 경로에 대한 메소드를 호출해주고, 뷰를 보여줄것이다.
서블릿 예외 처리 - 인터셉터
인터셉터 중복 호출 제거 ( 위의 필터는 서블릿이 제공하는 DispatchType를 이용해서 해결했다.)
필터는 서블릿기술이고,
인터셉터는 스프링 기술이므로
인터셉터는 다른 방법이 필요하다.
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);
}
}
}인터셉터 등록
@Configuration
public class WebConfig implements WebMvcConfigurer { //implements WebMvcConfigurer는 인터셉터등록때문에 추가
@Override //인터셉터 등록은 addInterceptors() 메소드를 오버라이드하고 , InterceptorRegistry 에 인터셉터를 등록한다.
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new LogInterceptor())
.order(1)
.addPathPatterns("/**")
.excludePathPatterns("/css/**", "*.ico", "/error", "/error-page/**");
//인터셉터는 필터의 setDispatcherTypes 같이 인터셉터가 동작할 DispatcherType 를 설정할 수없다.
//하지만 excludePathPatterns()의 강력한 기능을 이용한다.
// "/error-page/**" 를 추가함으로서 "/error-page" 관련된 모든 URL 호출은 해당 인터셉터를 적용하지않게끔 설정할 수 있다.
}앞서 필터의 경우에는 필터를 등록할 때 어떤 DispatcherType 인 경우에 필터를 적용할 지 선택할 수 있었다.
그런데 인터셉터는 서블릿이 제공하는 기능이 아니라 스프링이 제공하는 기능이다.
따라서 DispatcherType 과 무관하게 항상 호출된다. (DispatcherType은 서블릿이 제공하는것이므로)
대신에 인터셉터는 다음과 같이 요청 경로에 따라서 추가하거나 제외하기 쉽게 되어 있기 때문에, 이
러한 설정을 사용해서 오류 페이지 경로를 excludePathPatterns 를 사용해서 빼주면 된다.
실행 결과
erro-page로 가는 모든 URL 호출에 대해 인터셉터 적용을 하지않도록 설정해서
로그 인터셉터가 동작하지않은것을 확인할 수 있다.
인터셉터가 호출되서 preHandle()로 인해 로그가 찍히고
그다음 인터셉터가 있다면 인터셉터로, 없다면 서블릿,컨트롤러로 이동한다.
컨트롤러에서 예외가 발생하면 그 이후의 postHandle()은 실행되지않고
afterCompletion()은 예외여부와 상관없이 실행되니까 afterCompletion()은 실행된다.
컨트롤러에서 예외가 발생하면 afterCompletion()로 예외가 전달될것이고 그래서 로그를 찍을 수 있다.
만약 erro-page로 가는 모든 URL 호출에 대해 인터셉터 적용하지않던 설정을 없애면
다음과 같이 에러페이지경로 호출(request)에 대해서도 로그 인터셉터가 적용된것을 확인할 수 있다.
전체 흐름 정리
/hello 정상 요청 (클라이언트의 정상적인 http 요청)
/error-ex 라는 정상요청에서 오류 발생 후 오류페이지 요청
filterRegistrationBean.setDispatcherTypes(DispatcherType.REQUEST);필터는 DispatchType 으로 중복 호출 제거 ( dispatchType=REQUEST )
dispatchType=REQUEST는 기본값으므로, 따로 코드를 추가하지않아도 된다.
.excludePathPatterns("/css/**", "*.ico", "/error", "/error-page/**");인터셉터는 경로 정보로 중복 호출 제거( excludePathPatterns("/error-page/**") )
/error-ex 라는 정상요청( dispatchType=REQUEST)을 받고 필터,서블릿,인터셉터를 거쳐 컨트롤러에서 메소드가 실행된다.
컨트롤러에서 예외가 발생하고 들어온 역순으로 예외가 올라온다.
was까지 예외가 올라와서 , was는 해당 예외에 대한 오류페이지를 확인하고
오류 페이지의 경로에 대한 요청(request)를 진행한다. 그때는 dispatchType=ERROR이다.
그때 필터와 인터셉터에서 각각 오류페이지에 대한 호출은 무시하도록 위의 코드처럼하면 적용되지않고 지나가게된다.
스프링 부트 - 오류 페이지1
지금까지 예외 처리 페이지를 만들기 위해서 다음과 같은 복잡한 과정을 거쳤다.
(스프링이 아닌 순수 서블릿 컨테이너는 예외를 어떻게 처리하는지 알아보기 위해.)
WebServerCustomizer 를 만들고 그안에서 예외 종류에 따라서 ErrorPage 를 추가하고
만든 에러페이지의 경로에 대한 request를 처리하기 위한 에러 페이지 처리용 컨트롤러 ErrorPageController를 만듬
(직접 만든 에러페이지 뷰(html)로 이동시켜줘야하므로)
스프링 부트는 이런 과정을 모두 기본으로 제공한다
ErrorPage 를 자동으로 등록한다. 이때 /error 라는 경로로 기본 오류 페이지를 설정한다.
new ErrorPage("/error")상태코드와 예외를 설정하지 않으면 기본 오류 페이지로 사용된다.
예외가 발생해서 was까지 예외가 올라왔는데 맞는 에러페이지가 없다면 기본 오류페이지를 보내준다.
서블릿 밖으로 예외가 발생하거나, response.sendError(...) 가 호출되면 모든 오류는 /error 를 요청(request)하게 된다.
( 예외에 대한 에러페이지를 등록해놓으면 그 에러페이지 경로를 요청요청(request)하고 보내주고,
아니라면 /error라는 기본 에러페이지 경로를 요청(request)하게된다.)
그리고 에러페이지 경로 요청(request)에 대한 처리를 해줄 컨트롤러가 필요한데,
BasicErrorController라는 스프링 컨트롤러를 자동으로 등록한다.
(기본 에러페이지 경로(/error)를 매핑해서 처리하는 컨트롤러다.)
정리!!!
기본적으로 서블릿 밖으로 예외가 발생하거나, response.sendError(...) 가 호출되는 모든 오류는
/error를 요청(request)하게된다. ( 따로 어떤 예외에 대해 에러페이지를 생성해주지않았다면 )
그리고 그 요청을 BasicErrorController가 받아서, 발생한 예외의 상태코드에 따라서 뷰를 보여준다.
만들어 놓은 뷰가 없다면 스프링부트 기본 에러 화면인 WhiteLabelErrorPage에 상태코드를 기록해서 뷰를 렌더링한다.
(그리고 이 동작이 내부적으로 다 구현되어 있기 때문에 별도의 코드 개발 없이 정해진 디렉토리 위치에
상태코드 이름만으로도 에러페이지에 대한 매칭이 가능한 것 ) ( ex ) resources/templates/error/400.html
참고
ErrorMvcAutoConfiguration 이라는 클래스가 오류 페이지를 자동으로 등록하는 역할을 한다.
개발자는 오류 페이지만 등록
이제 오류가 발생했을 때 오류 페이지로 /error 를 기본 요청한다.
스프링 부트가 자동 등록한 BasicErrorController 는 이 경로를 기본으로 받는다.
BasicErrorController 는 기본적인 로직이 모두 개발되어 있다.
@RequestMapping으로 매핑이 되어있다. ( 기본값은 /error) application.properties에서 설정을 바꾸면 기본 에러페이지의 경로를 수정할 수 있게끔 되어있다.
+ 엄청 다양한 기능들이 미리 만들어져있다 ( 사용하기만 하면됨) (내부에서 /error라는 url로 호출이 들어오면 , resources에서 templates/error 또는 static/error 경로로 가서 예외에 맞는 뷰 또는 정적리소스를 가져오는 메소드가 구현되어있고 만약 그런 뷰 또는 정적리소스가 없다면 기본페이지(WhiteLabelErrorPage)를 보여주는 메소드가 이미 만들어져있다.)
개발자는 오류 페이지 화면만 BasicErrorController 가 제공하는 룰과 우선순위에 따라서 등록하면 된다.
정적 HTML이면 정적 리소스, 뷰 템플릿을 사용해서 동적으로 오류 화면을 만들고 싶으면
뷰 템플릿 경로에 오류 페이지 파일을 만들어서 넣어두기만 하면 된다
뷰 선택 우선순위 ( BasicErrorController의 html 응답 처리 우선순위 )
해당 경로 위치에 HTTP 상태 코드 이름의 뷰 파일을 넣어두면 된다.
뷰 템플릿이 정적 리소스보다 우선순위가 높고, 404, 500처럼
구체적인 것이 5xx처럼 덜 구체적인 것 보다 우선순위가 높다.
5xx, 4xx 라고 하면 500대, 400대 오류를 처리해준다.
만약 html 이름이 4xx라면 400,401,402,403,404 등등
4로 시작하는 모든 HTTP response status code에 대한 오류페이지로 4xx로 보여준다.
그런데 4xx.html도 있고 404.html도 있을때
예외에 대한 HTTP response status code가 404일때는 404.html을 보여준다.
( 상태코드에 대한 각각의 html를 만들필요 없이 error.html 하나로 모든 예외에 대한 뷰를 보여줄수도 있나보다.)
그러면 뷰의 내용이 동적으로 수정되게 BasicErrorController의 핸들러메소드의 수정이 좀 필요할거같다.)
결과 확인
그것에 맞는 에러페이지 뷰를 렌더링한 결과이다. ( 뷰 선택 우선순위에 따라 뷰가 선택됨)
(해당 상태코드에 대한 html이 존재해서 뷰를 렌더링할 수 있었다. 없었다면 WhiteLabelErrorPage를 렌더링했을것이다.)
스프링부트가 제공하는 기능을 이용해서 오류페이지를 구성할때
추가한 파일은 그냥 오류페이지에 대한 html 파일들이 끝이였다!
(위에서 스프링부트가 제공하는것을 사용하지않고 직접 에러페이지 객체들을 생성하고, 등록하고, 에러페이지 경로의 request를 처리할 컨트롤러도 만들어야 했는데 스프링부트가 제공하는것들을 이용하면 아주 간단하다.)
해당 예외에 대한 상태코드.html이 없다고 BasicErrorController의 뷰 선택 우선순위대로 다 찾아봤는데 없다면
평소보는 화이트라벨에러 페이지를 보게 되거나
화이트라벨에러 페이지가 안나오게 설정했다면
톰캣의 기본 에러페이지를 보게될것이다.
++
예외페이지로 이동하는 호출에서 필터,인터셉터가 중복 실행 안되게끔 하는방법은 서블릿에서 적용했던것과 일치한다.
필터는 DisPatcherType을 체크하면되고,
인터셉터는 스프링부트의 기본 에러 페이지 경로인 /error에 대한 인터셉터 적용예외처리해주면된다.
스프링 부트 - 오류 페이지2
BasicErrorController가 제공하는 기본 정보들
BasicErrorController 컨트롤러는 다음 정보를 model에 담아서 뷰에 전달한다.
뷰 템플릿은 이 값을 활용해서 출력할 수 있다.
505.html 파일에 BasicErrorController가 모델에 담은 정보들을 뷰에서 출력해보자.
<ul>
<li>오류 정보</li>
<ul>
<li th:text="|timestamp: ${timestamp}|"></li>
<li th:text="|path: ${path}|"></li>
<li th:text="|status: ${status}|"></li>
<li th:text="|message: ${message}|"></li>
<li th:text="|error: ${error}|"></li>
<li th:text="|exception: ${exception}|"></li>
<li th:text="|errors: ${errors}|"></li>
<li th:text="|trace: ${trace}|"></li>
</ul>
</li>
</ul>
결과
RuntimeException이 발생해서 500 상태코드에 대한 뷰가 실행됬는데
exception이라던지 메시지라던지 일부정보가 null로 되어있다 왜일까?
그이유는
오류 관련 내부 정보들을 고객에게 노출하는 것은 좋지 않기 때문이다.
고객이 해당 정보를 읽어도 혼란만 더해지고, 보안상 문제가 될 수도 있다.
그래서 BasicErrorController 오류 컨트롤러에서 다음 오류 정보를 model 에 포함할지 여부 선택할 수 있다.
BasicErrorController가 제외한 오류 정보 model에 포함하게 설정하기
application.properties
server.error.include-exception=true
server.error.include-message=always
server.error.include-stacktrace=always
server.error.include-binding-errors=always이렇게 수정하고 다시 결과 확인
정보가 엄청많이 나온다.
기본설정값
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 포함 여부
이렇게 기본설정이 되어있으므로 아까 테스트할때 null로 나왔던것이다.
기본 값이 never 인 부분은
다음 3가지 옵션을 사용할 수 있다. never, always, on_param
- never : 사용하지 않음
- always :항상 사용
- on_param : 파라미터가 있을 때 사용
설정을 on_param으로 했을경우
server.error.include-exception=true
server.error.include-message=on_param
server.error.include-stacktrace=on_param
server.error.include-binding-errors=on_param파라미터가 없다면 아래와 같이 보이고
파라미터가 있다면 아래와 같이 보인다.
on_param 은 파라미터가 있으면 해당 정보를 노출한다.
디버그 시 문제를 확인하기 위해 사용할 수 있다.
그런데 이 부분도 개발 서버에서 사용할 수 있지만, 운영 서버에서는 권장하지 않는다.
(뷰에 보여줄 필요없이 로그로 찍으면 되니까)
on_param 으로 설정하고 다음과 같이 HTTP 요청시 파라미터를 전달하면
해당 정보들이 model 에 담겨서 뷰 템플릿에서 출력된다.
스프링 부트 오류 관련 옵션
application.properties
server.error.whitelabel.enabled=true(기본값이 true)
오류 처리 화면을 못 찾을 시, 스프링 whitelabel 오류 페이지 적용
(false로 설정되어있고, 오류 페이지도 못찾았다면 톰캣이 제공하는 기본 에러페이지를 보여준다.)
server.error.path=/error(기본값이 /error)
오류 페이지 경로 설정 :
스프링이 자동 등록하는 서블릿 글로벌 오류 페이지 경로와 BasicErrorController 오류 컨트롤러 경로에 함께 사용된다
(보통 기본값을 쓰니까 손댈일이 없다.)
확장 포인트
에러 공통 처리 컨트롤러의 기능을 변경하고 싶으면
ErrorController 인터페이스를 상속 받아서 구현하거나
BasicErrorController 상속 받아서 기능을 추가하면 된다.
정리
스프링 부트가 기본으로 제공하는 오류 페이지를 활용하면
오류 페이지와 관련된 대부분의 문제는 손쉽게 해결할 수 있다
'인프런 > 스프링 MVC 2편' 카테고리의 다른 글
| 17) API 예외 처리(2) (0) | 2023.02.10 |
|---|---|
| 16) API 예외 처리 (0) | 2023.02.09 |
| 14) 로그인 처리2 - 인터셉터 , ArgumentResolver 활용 (0) | 2023.02.08 |
| 13) 로그인 처리2 - 필터 (0) | 2023.02.08 |
| 12) 로그인처리 - 쿠키, 세션 (실전) (0) | 2023.02.08 |
댓글