스프링 인터셉터(Interceptor)

스프링 인터셉터

자바 표준스펙이 제공하는 서블릿 필터처럼 웹과 관련된 공통 관심사항을 효과적으로 해결할 수 있는 기술입니다.

 

인터셉터 특징

• 인터셉터는 서블릿 필터의 흐름과 비슷한 흐름을 가져갑니다.

필터 : HTTP Request ▶︎ WAS ▶︎ 필터 ▶︎ 서블릿( 프론트 컨트롤러, 디스패쳐 서블릿 ) ▶︎ 컨트롤러  
인터셉터 : HTTP Request ▶︎ WAS ▶︎ 서블릿 ▶︎ 스프링 인터셉터 ▶︎ 컨트롤러

• 스프링 인터셉터에도 URL 패턴을 적용할 수 있는데, 서블릿 URL 패턴과 다르고, 매우 정밀하게 설정할 수 있습니다.
• 인터셉터 또한 체인으로 구성되어 중간에 인터셉터를 자유롭게 추가 가능 (ex)로그 요청 인터셉터 -> 로그인 처리 인터셉터)

서블릿 필터 vs 스프링 인터셉터  

• 필터는 서블릿에 요청이 전달되기 전과 후에 부가작업을 처리합니다.
• 인터셉터는 서블릿에 요청이 전달되고 나서 서블릿이 컨트롤러를 호출하기 전과 호출하고 난 후에 요청에 대한 부가작업을 처리합니다.

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

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

public interface HandlerInterceptor {

   default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
         throws Exception {

      return true;
   }

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

}

스프링 인터셉터 요청 흐름

preHandle()

• 컨트롤러(핸들러) 호출 전에 호출됩니다. (엄밀히 말하면 핸들러 어댑터 호출 전)
• preHandle()의 리턴값이 true이면 다음으로 진행, false면 더 이상 진행하지 않습니다.

postHandle()

• 컨트롤러(핸들러) 호출 후에 호출됩니다. ( 엄밀히 말하면 핸들러 어댑터 호출 후)
• 컨트롤러에서 예외 발생 시에는 실행되지 않고 afterCompletion으로 넘어갑니다.
• 파라미터로 ModelAndView가 넘어오기 때문에 모델이나 뷰에 추가작업을 할 수 있습니다.

afterCompletion()

• 뷰가 렌더링 된 이후 호출됩니다.
• 항상 호출되기 때문에 Exception을 파라미터로 받아 컨트롤러에서 어떤 Exception이 발생했는지 로그로 출력할 수도 있고, Exception을 처리하는데 사용됩니다.

 

스프링 인터셉터 적용하는 방법

•  WebMvcConfigurer 인터페이스를 구현한 클래스 내부에서 addInterceptors(InterceptorRegistry registry)를 Override합니다.
• 이 때 registry의 메소드를 통해 인터셉트를 추가, 적용순서, 적용 URL 패턴, 예외 URL 패턴을 지정할 수 있습니다.

registry.addInteceptor(추가할 인터셉터)
        .order(적용 순서)
        .addPatterns("적용할 URL 패턴")
        .excludePathPatterns("적용하지 않을 예외 URL 패턴")

 

로그요청에 대한 인터셉터

@Slf4j
public class LogInterceptor implements HandlerInterceptor {

• HandlerInterceptor 인터페이스 구현

public static final String LOG_ID = "logId";

@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
        throws Exception
{
    log.info("------------------------------");
    String requestURI = request.getRequestURI();
    String uuid = UUID.randomUUID().toString();
    request.setAttribute(LOG_ID,uuid);

    if (handler instanceof HandlerMethod)
    {
        HandlerMethod hm = (HandlerMethod) handler;
        Method method = hm.getMethod();
        log.info("Method {}",method);
    }

    log.info("REQUEST [{}][{}][{}]", uuid, 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);

    // 컨트롤러로부터 예외 넘겨 받았을 경우
    if (ex != null) {
        log.error("afterCompletion error!!", ex);
    }

    log.info("------------------------------");
}

 

preHandle()

@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
        throws Exception
{
    log.info("------------------------------");
    String requestURI = request.getRequestURI();
    String uuid = UUID.randomUUID().toString();
    request.setAttribute(LOG_ID,uuid);

    if (handler instanceof HandlerMethod)
    {
        HandlerMethod hm = (HandlerMethod) handler;
        Method method = hm.getMethod();
        log.info("handler {}, Method {}",handler,method);
    }

    log.info("REQUEST [{}][{}][{}]", uuid, requestURI, handler);
    return true;
}

• 필터에서는 지역변수로 해결이 가능하지만, 인터셉터는 호출 시점이 완전히 분리되어 있기 때문에, preHandle에서 지정한 값을 postHandle, afterCompletion에서 함께 사용하려면 어딘가에 담아두어야 합니다. LogInterceptror도 싱글톤처럼 사용되기 때문에 멤버 변수를 사용하면 위험하기 때문에 request에 담아두었습니다.
• HandlerMethod : 스프링에서 @Controller나 @RequestMapping을 활용한 핸들러 매핑을 주로 사용하는데 이 경우 핸들러 정보로 HandlerMethod가 넘어옵니다.
• ResourceHttpRequestHandler :  @Controller가 아닌 정적 리소스가 호출되는 경우 ResourceHttpRequestHandler가 핸들러 정보로 넘어옵니다.

인터셉터 적용

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

 

로그인 인증 체크 인터셉터

public class LoginCheckInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        HttpSession session = request.getSession(false);
        if(session==null || session.getAttribute(SessionConst.LOGIN_MEMBER) == null)
        {
            response.sendRedirect("/login?redirectURL" + request.getRequestURI());
            return false;
        }
        return true;
    }
}

preHandle에서 세션을 통해 세션을 얻어 세션이 아예 존재하지 않거나 로그인 멤버에 대한 세션이 없으면 리다이렉션

+ redirectURL을 쿼리파라미터로 넘겨 로그인 이후 처음에 요청한 페이지로 이동하도록 설정

• true : 컨트롤러 호출
• false:  컨트롤러 호출하지 않고 종료

인터셉터 적용

@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("/","/login","/logout","/members/add","/css/**","/*.ico","/error");
}

 

<정리>

1. 서블릿 필터와 스프링 인터셉터는 웹과 관련된 공통 관심사를 해결하는데 효과적입니다.
2. 개발자 입장에서는 스프링 인터셉터가 필터보다 훨씬 편리하므로 스프링 인터셉터를 쓰는 것을 선호합시다.

<참고자료>

https://blog.naver.com/PostView.naver?blogId=sosow0212&logNo=222869514885&navType=by 

[Spring] 서블릿 필터 & 스프링 인터셉터

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-2/dashboard

스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 - 인프런 | 강의