[Spring] 스프링 인터셉터(Spring Interceptor)

안녕하세요 이번 포스팅은 스프링 인터셉터에 대해서 알아보겠습니다.

 

 

스프링 인터셉터(Spring Interceptor) 소개

스프링 인터셉터도 서블릿 필터와 같이 웹과 관련된 공통 관심 사항을 효과적으로 해결할 수 있는 기술입니다. 서블릿 필터가 서블릿이 제공하는 기술이라면, 스프링 인터셉터는 스프링 MVC가 제공하는 기술입니다. 둘 다 웹과 관련된 공통 관심 사항을 처리하지만, 적용되는 순서와 범위, 그리고 사용방법이 다릅니다.

 

 

1. 스프링 인터셉터는 디스패쳐 서블릿과 컨트롤러 사이에서 컨트롤러 호출 직전에 호출됩니다.

2. 스프링 인터셉터는 스프링 MVC가 제공하는 기능이기 때문에 결국 디스패처 서블릿 이후에 등장하게 됩니다 스프링 MVC의 시작점이 디스패처 서블릿이라고 생각해보면 이해가 됩니다.

3. 스프링 인터셉터에도 URL 패턴을 적용할 수 있는데, 서블릿 URL 패턴과는 다르고 매우 정밀하게 설정할 수 있습니다.

 

 

인터셉터에서 적절하지 않은 요청이라고 판단하면 거기에서 끝을 낼 수도 있습니다. 그래서 로그인 여부를 체크하기에 딱 좋습니다.

 

 

스프링 인터셉터는 체인으로 구성되는데 중간에 인터셉터를 자유롭게 추가할 수 있습니다. 예를 들어서 로그를 남기는 인터셉터를 먼저 적용하고 그다음에 로그인 여부를 체크하는 인터셉터를 만들 수 있습니다.

 

지금까지 내용을 보면 서블릿 필터와 호출되는 순서만 다르고 제공하는 기능은 비슷해 보입니다. 앞으로 설명하겠지만 스프링 인터셉터는 서블릿 필터보다 편리하고 더 정교하고 다양한 기능을 지원합니다.

 

스프링 인터셉터 인터페이스

스프링 인터셉터를 사용하려면 HandlerInterceptor 인터페이스를 구현하면 됩니다.

 

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

1. 서블릿 필터의 경우 단순하게 doFilter() 하나만 제공됩니다. 인터셉터는 컨트롤러 호출 전 preHandle, 호출 후 postHandle, 요청 완료 이후 afterCompletion와 같이 단계적으로 잘 세분화되어있습니다.

 

2. 서블릿 필터의 경우 단순히 request, response만 제공했지만 인터셉터는 어떤 컨트롤러(handler)가 호출되는지 호출 정보도 받을 수 있습니다. 그리고 어떤 modelAndView가 반환되는지 응답 정보도 받을 수 있습니다.

 

 

정상 흐름

1.preHandle : 컨트롤러 호출 전에 호출됩니다. 더 정확히는 핸들러 어댑터 호출 전에 호출됩니다.

- preHandle의 응답 값이 true이면 다음으로 진행하고, false이면 더는 진행하지 않습니다. false인 경우 나머지 인터셉터는 물론이고 핸들러 어댑터도 호출되지 않습니다. 그림에서 1번에서 끝이 나버립니다.

 

2.postHandle : 컨트롤러 호출 후에 호출됩니다. 더 정확히는 핸들러 어댑터 호출 후에 호출됩니다.

 

3. afterCompletion : 뷰가 렌더링 된 이후에 호출됩니다.

 

스프링 인터셉터 예외 상황

 

 

예외가 발생 시

1. preHandle : 컨트롤러 호출 전에 호출됩니다.

2. postHandle : 컨트롤러에서 예외가 발생하면 postHandle은 호출되지 않습니다.

3. afterCompletion : afterCompletion은 항상 호출됩니다. 이 경우 예외를 파라미터로 받아서 어떤 예외가 발생했는지 로그로 출력할 수 있습니다.

- 예외가 발생하면 postHandle()는 호출되지 않으므로 예외와 무관하게 공통 처리를 하려면 afterCompletion()을 사용해야 합니다.

 

 

정리

인터셉터는 스프링 MVC 구조에 특화된 필터 기능을 제공한다고 이해하면 됩니다. 스프링 MVC를 사용하고, 특별히 필터를 꼭 사용해야 하는 상황이 아니라면 인터셉터를 사용하는 것이 더 편리합니다.

 

 

LogInterceptor - 요청 로그 인터셉터

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 {
     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);
         
         //@RequestMapping: HandlerMethod
         //정적 리소스: ResourceHttpRequestHandler
         if (handler instanceof HandlerMethod) {
             HandlerMethod hm = (HandlerMethod) handler; //호출할 컨트롤러 메서드의 모든 정보가 포함되어 있다.
         }
         
         log.info("REQUEST [{}][{}][{}]", uuid, requestURI, handler);
         
         return true; //false 진행X
     }
     
     @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);
         
         if (ex != null) {
         	log.error("afterCompletion error!!", ex);
         }
     }
}​

 

1. String uuid = UUID.randomUUD(). toString()

- 요청 로그를 구분하기 위한 uui를 생성합니다.

 

2. request.setAttribute(LOG_ID, uuid)

- 서블릿 필터의 경우 지역변수로 해결이 가능하지만, 스프링 인터셉터는 호출 시점이 완전히 분리되어 있습니다. 따라서 preHandle에서 지정한 값을 postHandle , afterCompletion에서 함께 사용하려면 어딘가에 담아두어야 합니다. LogInterceptor 도 싱글톤 처럼 사용되기 때문에 맴버변수를 사용하면 위험합니다. 따라서 request 에 담아두었습니다. 이 값은 afterCompletion 에서 request.getAttribute(LOG_ID)로 찾아서 사용합니다.

 

3. return true

- true면 정상 호출이고 다음 인터셉터나 컨트롤러가 호출됩니다.

 

if (handler instanceof HandlerMethod) {
     HandlerMethod hm = (HandlerMethod) handler; //호출할 컨트롤러 메서드의 모든 정보가 포함되어 있다.
}

 

HandlerMethod

핸들러 정보는 어떤 핸들러 매핑을 사용하는가에 따라 달라집니다. 스프링을 사용하면 일반적으로 @Controller , @RequestMapping을 활용한 핸들러 매핑을 사용하는데, 이 경우 핸들러 정보로 HandlerMethod 가 넘어옵니다

 

ResourceHttpRequestHandler

@Controller 가 아니라 /resources/static 와 같은 정적 리소스가 호출되는 경우 ResourceHttpRequestHandler 가 핸들러 정보로 넘어오기 때문에 타입에 따라서 처리가 필요합니다.

 

postHandle, afterCompletion

종료 로그를 postHandle이 아니라 afterCompletion에서 실행한 이유는, 예외가 발생한 경우 postHandle가 호출되지 않기 때문입니다. afterCompletion은 예외가 발생해도 호출되는 것을 보장합니다.

 

WebConfig - 인터셉터 등록

 

@Configuration
public class WebConfig implements WebMvcConfigurer {

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

 

WebMvcConfigurer가 제공하는 addInterceptors()를 사용해서 인터셉터를 등록할 수 있습니다.

 

1. registry.addInterceptor(new LogInterceptor()) : 인터셉터를 등록합니다.

2. order(1) : 인터셉터의 호출 순서를 지정합니다. 낮을수록 먼저 호출됩니다.

3. addPathPatterns("/**") : 인터셉터를 적용할 URL 패턴을 지정합니다.

4. excludePathPatterns("/css/**", "/*. ico", "/error") : 인터셉터에서 제외할 패턴을 지정합니다.

 

필터와 비교해보면 인터셉터는 addPathPatterns, excludePathPatterns로 매우 정밀하게 URL 패턴을 지정할 수 있습니다.

 

실행 로그

 

REQUEST [6234a913-f24f-461f-a9e1-85f153b3c8b2][/members/add]
[hello.login.web.member.MemberController#addForm(Member)]
postHandle [ModelAndView [view="members/addMemberForm"; 
model={member=Member(id=null, loginId=null, name=null, password=null), 
org.springframework.validation.BindingResult.member=org.springframework.validat
ion.BeanPropertyBindingResult: 0 errors}]]
RESPONSE [6234a913-f24f-461f-a9e1-85f153b3c8b2][/members/add]

 

 

스프링 인터셉터 - 인증 체크

 

서블릿 필터에서 사용했던 인증 체크 기능을 스프링 인터셉터로 개발해보겠습니다.

 

LoginCheckInterceptor

import hello.login.web.SessionConst;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

@Slf4j
public class LoginCheckInterceptor implements HandlerInterceptor {
     @Override
     public boolean preHandle(HttpServletRequest request, HttpServletResponse 
    response, Object handler) throws Exception {
         String requestURI = request.getRequestURI();
         log.info("인증 체크 인터셉터 실행 {}", requestURI);
         HttpSession session = request.getSession(false);
         
         if (session == null || session.getAttribute(SessionConst.LOGIN_MEMBER) == null) {
             log.info("미인증 사용자 요청");
             //로그인으로 redirect
             response.sendRedirect("/login?redirectURL=" + requestURI);
             
             return false;
         }
         return true;
     }
}

서블릿 필터와 비교해서 코드가 매우 간결합니다. 인증이라는 것은 컨트롤러 호출 전에만 호출되면 됩니다. 따라서 preHandle만 구현하면 됩니다.

 

순서 주의, 세밀한 설정 가능

 

@Configuration
public class WebConfig implements WebMvcConfigurer {
     @Override
     public void addInterceptors(InterceptorRegistry registry) {
         registry.addInterceptor(new LogInterceptor())
             .order(1)
             .addPathPatterns("/**")
             .excludePathPatterns("/css/**", "/*.ico", "/error");
             
         registry.addInterceptor(new LoginCheckInterceptor())
             .order(2)
             .addPathPatterns("/**")
             .excludePathPatterns(
             "/", "/members/add", "/login", "/logout",
             "/css/**", "/*.ico", "/error");
     }
     //...
}

인터셉터를 적용하거나 하지 않을 부분은 addPathPatterns와 excludePathPatterns에 작성하면 됩니다. 기본적으로 모든 경로에 해당 인터셉터를 적용하되 /**, /, /members/add, /login, /css/**, /error와 같은 부분은 로그인 체크 인터셉터를 적용하지 않습니다.

 

정리

서블릿 필터와 스프링 인터셉터는 웹과 관련된 공통 관심사를 해결하기 위한 기술입니다. 서블릿 필터와 비교해서 스프링 인터셉터가 개발자 입장에서 훨씬 편리하다는 것을 코드로 이해했을 것입니다. 특별한 문제가 없다면 인터셉터를 사용하는 것이 좋습니다.