[로그인] Spring Interceptor - 요청 로그

1. LogInterceptor class

---

• HandlerInterceptor를 구현

@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
        //사용할 handler가 HandlerMethod 처리 가능???
        if(handler instanceof HandlerMethod){
            //Handler(controller)의 method
            HandlerMethod hm = (HandlerMethod) handler; //호출한 컨트롤러 메서드의 모든 정보가 포함되어 있음.
        }
        log.info("REQUEST [{}][{}][{}]", uuid, requestURI, handler);

        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
       log.info("post Handle [{}]", modelAndView);
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        String requestURI = request.getRequestURI();
        String uuid = (String) request.getAttribute("LOG_ID");
        log.info("RESPONSE [{}][{}][{}]", uuid, requestURI, handler);
        if(ex != null){
            log.error("afterCompletion error!!", ex);
        }

    }
}

• String uuid = UUID.randomUUID().toString()
  
  • 요청 로그를 구분하기 위한 uuid 를 생성한다.
• request.setAttribute(LOG_ID, uuid)
  
  • 서블릿 필터의 경우 지역변수로 해결이 가능하지만, 
  • 스프링 인터셉터는 호출 시점이 완전히 분리되 있음.
  • 따라서 preHandle 에서 지정한 값을 postHandle , afterCompletion 에서 함께 사용하려면
  • 어딘가에 담아두어야 한다. 
  • LogInterceptor 도 싱글톤 처럼 사용되기 때문에 맴버변수를 사용하면 위험.
  •  따라서 request 에 담아두었다.
  • 이 값은 afterCompletion 에서 request.getAttribute(LOG_ID) 로 찾아서 사용
• return true
  
  • true 면 정상 호출이다. 다음 인터셉터나 컨트롤러가 호출된다.
  • false면 다음 인터셉터 & Controller 호출 안함.
• HandlerMethod
  • HandlerMethod는 @RequestMapping이 붙은 메소드의 정보를 추상화한 객체이다.
  • 따라서 handler가 @RequestMapping이 붙은 controller의 Method를 처리할 수 있는지 확인이 필요.
    • handler instanceOf HandlerMethod
  • 핸들러 정보는 어떤 핸들러 매핑을 사용하는가에 따라 달라진다.
  • @RequestMapping 사용하는 경우 Handler정보는 HandlerMethod로 넘어옴.
  • 정적 리소스를 사용하는 경우 Handler정보는 ResourceHttpRequestHandler로 넘어옴.

      //@RequestMapping 사용하는 경우 : HandlerMethod
        //정적 리소스 : ResourceHttpRequestHandler
        //사용할 handler가 HandlerMethod 처리 가능???
        if(handler instanceof HandlerMethod){
            //Handler(controller)의 method
            HandlerMethod hm = (HandlerMethod) handler; //호출한 컨트롤러 메서드의 모든 정보가 포함되어 있음.
        }

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

 

2. Interceptor 등록

---

• 기존 WebConfig가 WebMvcConfigurer를 구현하도록 하자.
• addInterceptors를 override하자.
• addInterceptors()를 통해 인터셉터 등록이 가능하다.

@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 LogInterceptor()) : 인터셉터를 등록한다.
• order(1) : 인터셉터의 호출 순서를 지정한다. 낮을 수록 먼저 호출된다.
• addPathPatterns("/**") : 인터셉터를 적용할 URL 패턴을 지정한다.
• excludePathPatterns("/css/**", "/*.ico", "/error") : 인터셉터에서 제외할 패턴을 지정한다.
• 필터와 비교해보면 인터셉터는 addPathPatterns , excludePathPatterns를 사용하여
• 매우 자세하게 URL 패턴을 지정할 수 있다.

 

3. Spring URL 경로

---

• Servlet이랑 많이 다름. 더욱 자세하게 설정 가능.
• https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/ springframework/web/util/pattern/PathPattern.html

 

 

4. GitHub : 210926 Spring Interceptor

---

GitHub - bsh6463/login