[Spring Boot] Interceptor 활용

 

 

📌 개요

Spring MVC를 공부하면서 DispatcherServlet이 수행하는 전처리, 후처리 과정 중 Interceptor라는 기능이 있어 사용해보았다.

인터셉터는 횡단 관심사를 처리해주기 위해서 디스패처 서블릿이 수행하는 작업이다.

따라서 Interceptor는 Spring MVC, Dispatcher Servlet Container 내부에서 수행되는 작업이고 이와는 대조적으로 Filter는 서블릿 컨테이너 밖에서 수행되는 작업이다.

또한 Filter는 java에서 관리되는 클래스이지만 Interceptor는 Spring MVC에서 관리된다.

📌 본론

Interceptor는 HandlerInterceptor 인터페이스를 구현해서 만들 수 있다.

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은 디스패처 서블릿이 결정된 핸들러를 실행시키기 이전에 수행하는 작업이다.

여기서 핸들러라는 것은 우리가 Spring Boot로 만드는 Controller에 해당한다.

postHandle()

postHandle은 디스패처 서블릿이 실행한 핸들러가 수행된 후에 수행하는 작업이다.

즉, 우리가 만든 비즈니스 로직이 모두 실행된 이후에 실행되므로 HttpServletResponse를 매개변수로 가진다.

afterCompletion()

afterCompletion은 모든 요청이 마무리 되고 뷰가 렌더링된 이후에(뷰 템플릿을 사용한다면) 수행하는 작업이다.

가장 마지막에 수행되는 작업이며 이전에 핸들러를 매핑하는 과정에서 HandlerExecutionChain이 존재했을 경우에 preHandle의 리턴 값이 true 였다면 실행된다.

좀 까다로운 조건이 있다.

LoggingInterceptor

인터셉터를 통해 모든 컨트롤러에 대한 로깅 작업을 수행할 수 있다.

public class LoggingInterceptor implements HandlerInterceptor {

    private final static Logger logger = LoggerFactory.getLogger(LoggingInterceptor.class);

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

        String ip = request.getHeader("X-Forwarded-For");
        if (ip == null) ip = request.getRemoteAddr();
        logger.info("URL :" + request.getRequestURL());
        logger.info("METHOD : "+ request.getMethod());
        logger.info("QueryString : " + request.getQueryString());
        logger.info("Client : " + request.getRemoteAddr());

        return true;
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

        String ip = request.getHeader("X-Forwarded-For");
        if (ip == null) ip = request.getRemoteAddr();
        logger.info("URL :" + request.getRequestURL());
        logger.info("METHOD : "+ request.getMethod());
        logger.info("QueryString : " + request.getQueryString());
        logger.info("Client : " + request.getRemoteAddr());
        logger.info("Process Result : "+response.getStatus());
    }
}

해당 인터셉터는 preHandle과 afterCompletion을 오버라이딩하여 요청과 응답에 대한 로그 작업을 수행한다.

따라서 각 컨트롤러는 로그를 처리할 필요가 없어진다.

즉, 횡단 관심사를 간편하게 묶어낼 수 있다.

포인트 컷 문법을 사용하는 AOP가 복잡하고 어렵다면 간편하게 인터셉터를 통해서도 횡단 관심사를 묶어낼 수 있다.

WebConfiguration

@Configuration
public class WebConfiguration implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoggingInterceptor());
    }
}

마지막으로 인터셉터를 등록해주어야 한다.

WebMvcConfigurer를 구현하여 addInterceptor를 오버라이딩해서 사용한다.

여기서 어떤 컨트롤러에만 적용시키거나 제외시킬 수도 있다.

결과

쉽게 로그 작업을 수행할 수 있는 것을 볼 수 있다.!