스프링부트로 인터셉트 활용하기

• InterCeptor란?
• Interceptor 활용하기

 

먼저, Interceptor가 무엇인지 알아야 합니다.

 

 

1. 인터셉터란?

컨트롤러와 핸들러를 호출하기 전과 후에 요청과 응답을 참조하거나 가공하는 역할을 합니다.

'낚아채다' 라는 의미로, 사용자 요청에 의해 서버에 들어온 Request 객체를 컨트롤러의 핸들러로 도달하기 

전에 낚아채서 개발자가 원하는 추가 작업을 한 후 핸들러로 보낼 수 있도록 돕습니다.

 

예로 로그인체크 혹은 권한 체크 등을 할 수 있습니다.

 

특정 컨트롤러 url에 매핑되어 인터센터를 지정할 수 있습니다. 또한, 장점으로는 여러 url에 컨트롤러 접근 이전에 전처리가 필요할 경우에 코드의 중복을 최소화할 수 있습니다.

 

 

2. 인터셉터 활용 예제

간단한 예시를 아래를 통해 보도록 하겠습니다.

git commit 가서 보기 

 

먼저, HandlerInterceptor를 상속받아 인터셉터 클래스를 커스튬합니다.

테스트를 위해 단순히 로그만 찍어 실행되는지만 확인하도록 하겠습니다.

import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;


@Slf4j
public class HandleInterceptor implements HandlerInterceptor{

  @Override
  public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
      throws Exception {
    log.info("preHandler");
    return true;
  }

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

  @Override
  public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
      Object handler, Exception ex) throws Exception {
    log.info("afterCompletion");
  }
}

 

 

 

WebMvcConfigurer를 상속하여 구현체를 만든 후 커스튬한 인터셉터를 Bean으로 등록합니다.

import com.sparta.myselectshop.HandleInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

  @Bean
  public HandleInterceptor handleInterceptor() {
    return new HandleInterceptor();
  }

  @Override
  public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(handleInterceptor()).addPathPatterns("/api/user/signup");
  }
}

 

 

 

addInterceptors() 메서드 내에 url 패턴과 일치하면 아래와 같이 출력되는 것을 볼 수 있습니다.

---

references : 

https://popo015.tistory.com/115

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