김영한 님의 '스프링 MVC 2편 - 백엔드 웹 개발 핵심 기술'을 듣고 적은 글입니다.
애플리케이션 여러 로직에서 공통으로 관심이 있는 것을 공통 관심사라고 한다.
이런 공통 관심사는 스프링의 AOP로도 해결할 수 있지만, 웹과 관련된 공통 관심사는 서블릿 필터 또는 스프링 인터셉터를 사용하는 것이 좋다. 웹과 관련된 공통관심사를 처리할 때는 HTTP의 헤더나 URL의 정보들이 필요한데, 서블릿 필터나 스프링 인터셉터는 HttpServletRequest를 제공한다.
서블릿 필터
필터는 서블릿이 지원하는 수문장이다.
필터 흐름
HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 컨트롤러
필터를 적용하면 필터가 호출된 다음에 서블릿이 호출된다. 그래서 모든 고객의 요청 로그를 남기는 요구사항이 있다면 필터를 참고하면 된다. 필터는 특정 URL 패턴에 적용할 수 있다. /*이라고 하면 모든 요청에 필터가 적용된다.
스프링을 사용하는 경우 여기서 말하는 서블리은 스프링의 디스패처 서블릿으로 생각하면 된다.
필터 제한
HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 컨트롤러
HTTP 요청 -> WAS -> 필터(적절하지 않은 요청이라 판단, 서블릿 호출X)
필터에서 적절하지 않은 요청이라 생각하면 거기에서 끝낼 수 있다.
그렇기에 로그인 여부 판단에 적합하다.
필터 체인
HTTP 요청 -> WAS -> 필터1 -> 필터2 -> 필터3 -> 서블릿 -> 컨트롤러
필터는 체인으로 구성되기에 중간에 필터를 자유롭게 추가할 수 있다.
필터 인터페이스
public interface Filter {
public default void init(FilterConfig filterConfig) throws ServletException{}
public void doFilter(ServletRequest request, ServletResponse response,FilterChain chain) throws IOException, ServletException;
public default void destroy() {}
}필터 인터페이스를 구현하고 등록하면 서블릿 컨테이너가 필터를 싱글톤 객체로 생성하고 관리한다. (싱글톤 주의!)
init(): 필터 초기화 메서드, 서블릿 컨테이너가 생성될 때 호출doFilter(): 고객의 요청이 올 때마다 해당 메서드 호출. 필터 로직 구현destroy(): 필터 종료 메서드, 서블릿 컨테이너가 종료될때 호출
요청 로그
package hello.login.web.filter;
import lombok.extern.slf4j.Slf4j;
import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.util.UUID;
@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 {
log.info("log filter doFilter");
HttpServletRequest httpRequest = (HttpServletRequest) request; //HttpServletRequest의 부모가 ServletRequest임. 다운캐스팅 해줌
String requestURI = httpRequest.getRequestURI();
String uuid = UUID.randomUUID().toString(); //요청 구분하기 위해 uuid 사용함. 성능 최적화 위해서 사용.
try{
log.info("REQUEST [{}][{}]", uuid, requestURI); //로그 찍고
chain.doFilter(request, response);// 다음 서블릿 호출. 이 로직을 사용하지 않으면 다음 단계로 진행 안됨.
}catch(Exception e) {
throw e;
} finally{
log.info("RESPONSE [{}][{}]", uuid, requestURI);
}
}
@Override
public void destroy() {
log.info("log filter destroy");
}
}
implements Filter: 필터를 사용하기 위해서는 필터 인터페이스 구현 필요doFilter(...): HTTP요청이 오면 호출.ServletRequest는 HTTP 요청이 아닌 경우까지 고려해 만들어진 인터페이스이다. HTTP를 사용하면HttpServletRequest로 다운 캐스팅해주면 된다.UUID: HTTP 요청을 구분하기 위해 요청당 임의의uuid를 만들어준다.chain.doFilter(request,response): 다음 필터가 있으면 호출하고 필터가 없으면 서블릿 호출. 이 로직이 없으면 다음 단계로 진행되지 않음.
package hello.login;
import hello.login.web.filter.LogFilter;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import javax.servlet.Filter;
@Configuration
public class WebConfig {
@Bean
public FilterRegistrationBean logFilter() {
FilterRegistrationBean<Filter> filterRegistrationBean = new
FilterRegistrationBean<>();
filterRegistrationBean.setFilter(new LogFilter());
filterRegistrationBean.setOrder(1);
filterRegistrationBean.addUrlPatterns("/*");
return filterRegistrationBean;
}
}필터를 등록하기 위한 방법에는 여러가지가 있지만, 스프링부트를 사용한다면 FilterRegistrationBean을 사용해 등록하면 된다.
setFilter(new LogFilter()): 등록할 필터 지정setOrder(1): 필터는 체인으로 동작하기에 순서 필요. 숫자가 작을수록 먼저 동작addUrlPatterns("/*"): 필터 적용할 때 URL 패턴 지정. 한번에 여러 패턴 지정 가능./*의 경우 모든 요청에 해당 필터가 적용
스프링 인터셉터
스프링 인터셉터도 서블릿 필터와 같이 웹 관련 공통 관심 사항을 효과적으로 해결할 수 있는 기술이다. 서블릿 필터가 서블릿이 제공하는 기술이라면 스프링 인터셉터는 스프링 MVC가 제공하는 기술이다. 둘다 웹과 관련된 공통 관심 사항을 처리하지만 적용되는 순서와 범위, 사용방법이 다르다.
스프링 인터셉터 흐름
HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 스프링 인터셉터 -> 컨트롤러
스프링 인터셉터는 디스패처 서블릿과 컨트롤러 사이에서 컨트롤러 호출 직전에 호출된다. 스프링 인터셉터는 스프링 MVC가 제공하는 기능이기에 결국 디스패처 서블릿 이후 등장하게 된다. 스프링 인터셉터에도 URL 패턴을 적용할 수 있는데 서블릿 URL 패턴과 다르고 매우 정밀하게 설정할 수 있다.
스프링 인터셉터 제한
HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 스프링 인터셉터 -> 컨트롤러
HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 스프링 인터셉터(적절하지 않은 요청이라 판단, 컨트롤러 호출X)
인터셉터에서 적절하지 않은 요청이라고 판단하면 끝낼 수 있다.
스프링 인터셉터 체인
HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 인터셉터1 -> 인터셉터2 -> 컨트롤러
스프링 인터셉터도 체인으로 구성되며 중간에 인터셉터를 자유롭게 추가할 수 있다.
스프링 인터셉터 인터페이스
public interface HandlerInterceptor {
default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {}
default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception {}
default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {}
}서블릿 필터의 경우 단순하게 doFilter() 하나만 제공된다. 인터셉터는 컨트롤러 호출 전(preHandle), 호출 후(postHandle), 요청 완료 이후(afterCompletion)와 같이 단계적으로 잘 세분화되어 있다.
서블릿 필터의 경우 request, response만 제공했지만 인터셉터는 어떤 컨트롤러(handler)가 호출되는지 호출 정보도 받을 수 있다. 그리고 어떤 modelAndView가 반환되는지 응답 정보도 받을 수 있다.
호출 흐름
preHandle: 컨트롤러 호출 전 호출(핸들러 어댑터 호출 전 호출)
응답 값이true이면 다음으로 진행하고,false이면 진행하지 않음.false인 경우 나머지 인터셉터는 물론 핸들러 어댑터도 호출되지 않음postHandle: 컨트롤러 호출 후 호출(핸들러 어댑터 호출 후 호출)afterCompletion: 뷰가 렌더링된 이후 호출
예외 상황
preHandle: 컨트롤러 호출 전 호출postHandle: 컨트롤러에서 예외 발생 시postHandle호출 안됨afterCompletion: 항상 호출. 예외를 파라미터로 받아 어떤 예외가 발생했는지 로그로 출력 가능
예외와 무관하게 공통 처리를 위해서는 afterCompletion을 사용하는게 적절하다.
요청 로그
package hello.login.web.interceptor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.method.HandlerMethod;
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 {
private 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);
//@RequestMapping : HandlerMethod
//정적 리소수 : ResourceHttpRequestHandler
if(handler instanceof HandlerMethod){
HandlerMethod hm = (HandlerMethod) handler; //호출할 컨트롤러 메서드의 모든 정보 포함
}
log.info("REQUEST [{}][{}][{}]", LOG_ID, 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, requestURI, handler);
if(ex != null){
log.error("afterCompletion error!!", ex);
}
}
}
UUID: 요청 로그를 구분하기 위한uuid생성request.setAttribute(LOG_ID, uuid):
서블릿 필터의 경우 지역변수로 해결 가능하지만 스프링 인터셉터는 호출 시점이 완전히 분리되어 있다. 따라서preHandl에서 지정한 값을postHandle,afterCompletion에서 함께 사용하려면 어딘가에 담아두어야 한다.LogInterceptor도 싱글톤처럼 사용되기에 멤버변수를 사용하면 위험하다. 따라서request에 담아두었다.return true:true이면 정상호출 한다.
종료로그를 afterCompletion에서 실행한 이유는 예외가 발생할 경우 postHandle이 호출되지 않기 때문이다.
HandlerMethod
핸들러 정보는 어떤 핸들러 매핑을 사용하는가에 따라 달라진다. 스프링을 사용하면 일반적으로 @Controller, @RequestMapping을 활용한 핸들러 매핑을 사용하는데, 이 경우 핸들러 정보로 HandlerMethod가 넘어온다.
등록
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new LogInterceptor())
.order(1)
.addPathPatterns("/**")
.excludePathPatterns("/css/**", "/*.ico", "/error");
}
//...
}인터셉터와 필터가 중복되지 않도록 필터를 등록하기 위해 이전 logFilter()의 @Bean은 주석처리 한다.
WebMvcConfigurer가 제공하는 addInterceptors()를 사용해서 인터셉터를 등록할 수 있다.
registry.addInterceptor(new LogInterceptor()): 인터셉터 등록.order(): 인터셉터 호출순서 지정. 낮을수록 먼저 호출addPathPatterns("/**"): 인터셉터를 적용할 URL 패턴 지정excludePathPatterns(...): 인터셉터에서 제외할 패턴 지정
