스프링 인터셉터(Spring Interceptor)

  서블릿 필터와 같이 스프링 인터셉터(Spring Interceptor) 또한 웹과 관련된 공통 관심 사항을 효과적으로 해결할 수 있는 기술이다.

  이번 글을 통해 '스프링 인터셉터의 개념'을 알아보고, '요청 로그 예제'와 '인증 체크 예제'를 통해서 사용 방법을 알아보도록 하자.

 

1. 개념 🌠

📘 1. 스프링 인터셉터 흐름

  스프링 인터셉터는 기본적으로 다음과 같은 흐름을 가진다.

HTTP 요청 → WAS → 필터 → 서블릿(Dispatcher Servlet) → 스프링 인터셉터 → 컨트롤러

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

📘 2. 스프링 인터셉터 제한

  서블릿 필터와 같이 로그인하지 않은 사용자의 접근과 같은 '적절하지 않은 요청'에 대하여 판단하고 거기에서 끝을 낼 수 있다.

(1) 로그인한 사용자인 경우
HTTP 요청 → WAS → 필터 → 서블릿 → 스프링 인터셉터 → 컨트롤러
(2) 로그인하지 않은 사용자인 경우
HTTP 요청 → WAS → 필터 → 서블릿 → 스프링 인터셉터

📘 3. 스프링 인터셉터 체인

  스프링 인터셉터는 체인으로 구성된다

HTTP 요청 → WAS → 필터 → 서블릿 → 인터셉터1 → 인터셉터2 → 컨트롤러

  그래서 여러 인터셉터를 적용할 수 있다. 예를 들어 로그를 남기는 인터셉터를 먼저 적용하고, 그리고 로그인 여부를 체크하는 인터셉터를 적용할 수 있다.

📘 4. 스프링 인터셉터 인터페이스

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

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

  서블릿 필터의 경우 doFilter()로만 로직을 처리할 수 있었는데, 인터셉터는 preHandle(컨트롤러 호출 전), postHandle(컨트롤러 호출 후), afterCompletion(요청 완료 이후)와 같이 여러 단계에서 로직을 수행할 수 있다.

• preHandle
  컨트롤러 호출 전에 호출된다. (정확히는 핸들러 어댑터가 호출되기 전에 호출된다.)
  preHandle의 응답값이 true이면 다음을 진행하고, false이면 진행하지 않는다. (false이면 1번 과정에서 끝이 난다.)
• postHandle
  컨트롤러 호출 후에 호출된다. (정확히는 핸들러 어댑터 호출 후에 호출된다.)
• afterCompletion 
  뷰가 랜더링 된 이후에 호출된다.

  또한, 'Object handler'를 이용하여 어떤 컨트롤러가 호출되는지 호출정보를 받을 수 있고, 'ModelAndView modelAndView'를 이용하여 어떤 내용들이 반환되는지 응답 정보도 받을 수 있다.

📘 5. 예외가 발생한 상황에서의 흐름

  예외가 발생한 경우 아래와 같이 진행된다.

• preHandle
  컨트롤러 호출 전에 호출된다.
• postHandle
  컨트롤러에서 예외가 발생하면 postHandle은 호출되지 않는다.
• afterCompletion
  항상 호출된다.
  예외가 발생하면 예외(ex)를 파라미터로 받아서 어떤 예외가 발생했는지 로그로 출력할 수 있다.
  예외와 무관하게 공통 처리를 하려면 postHandle이 아니라 afterCompletion을 사용해야 한다.

 

2. 요청 로그 예제 🌀

@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(); // HTTP 요청을 구분하기 위한 것
        request.setAttribute(LOG_ID, uuid);

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

        log.info("REQUEST [{}][{}][{}]", uuid, requestURI, handler);
        return true; // false인 경우 더 이상 진행되지 않는다.
    }

    @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);
        }
    }
}

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
    
        registry.addInterceptor(new LogInterceptor()) // 인터셉터 등록
                .order(1) // 호출순서 지정
                .addPathPatterns("/**") // 인터셉터를 적용할 URL 패턴 지정
                .excludePathPatterns("/css/**", "/*.ico", "/error"); // 인터셉터에서 제외할 패턴 지정
    }
}

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

  addInterceptor()를 이용해서 인터셉터를 등록하고, order()를 이용해서 호출 순서를 지정하고, addPathPatterns()를 이용해서 인터셉터를 적용할 URL 패턴을 지정하고, excludePathPatterns()를 지정해서 인터셉터에서 제외할 패턴을 지정하면 된다.

  실행시켜 보면 로그는 아래와 같이 나오게 된다.

2023-04-30T00:18:11.301+09:00 INFO 22272 --- [nio-8080-exec-1] com.interceptor.LogInterceptor : REQUEST [18844889-7f8f-4b7f-8848-1b04472c65bb][/][com.interceptor.MainController#index(Model)]
2023-04-30T00:18:11.314+09:00 INFO 22272 --- [nio-8080-exec-1] com.interceptor.LogInterceptor : postHandle [ModelAndView [view="home"; model={}]]
2023-04-30T00:18:11.665+09:00 INFO 22272 --- [nio-8080-exec-1] com.interceptor.LogInterceptor : RESPONSE [18844889-7f8f-4b7f-8848-1b04472c65bb][/]

 

3. 인증 체크 예제 🌏

@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();

        // 인증이 되지 않은 경우
        if(...) {
            log.info("미인증 사용자 요청");

            // 로그인으로 redirect
            response.sendRedirect("/login?redirectURL="+requestURI);
            return false;
        }

        return true;
    }
}

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
    
        registry.addInterceptor(new LogInterceptor()) 
                ...

        registry.addInterceptor(new LoginCheckInterceptor()) // 인터셉터 등록
                .order(2) // 호출순서 지정
                .addPathPatterns("/**") // 인터셉터를 적용할 URL 패턴 지정
                .excludePathPatterns("/", "/members/add", "/login", "/logout",
                        "/css/**", "/*.ico", "/error"); // 인터셉터에서 제외할 패턴 지정
    }
}

  '홈, 회원가입, 로그인, 리소스 조회, 오류'와 같은 부분은 로그인 체크 인터셉터를 적용하지 않도록 하였다. 

  그리고 로그인을 한 이후 다시 원래 페이지로 돌아오게 하기 위해서 redirectURL을 파라미터로 붙여주었다.

 

해당 글은 김영한 님의 '스프링 MVC 2편 - 백엔드 웹 개발 활용 기술'을 참고하였습니다.