Spring Interceptor

📖 Interceptor?

Spring에서 제공하는 AOP(Aspect Oriented Programming) 의 한 종류로, 컨트롤러 실행 전/후에 특정 기능을 수행할 수 있는 기능입니다. 주로 인증 단계를 처리 하거나, 로깅하는데 사용됩니다. -> 비즈니스 로직과 분리가 가능합니다.

HandlerInterceptor 인터페이스를 구현하고, preHandle(),postHandle(), afterCompletion() 메서드를 오버라이딩하여 컨트롤러 실행 전/후에 특정 작업을 수행할 수 있습니다.

Interceptor를 사용하려면 두가지 방법이 있습니다.

1. WebMvcConfigurer를 구현하여 addInterceptors() 메서드를 오버라이딩 하여 사용할 수 있습니다. 때에 따라 addPathPatterns() 를 사용하여 특정 URL에만 적용할 수도 있습니다.

2. @Interceptor를 사용하여 Bean으로 등록하는 방법이 있습니다.

---

🤔 사용해야 하는 이유는?

인터셉트를 사용하면 모든 요청에서 공통을 사용하는 로직을 Interceptor에서 처리할 수 있기 때문에 중복 코드를 제거할 수 있습니다. 또한 로깅, 인증, 권한 검사, 캐시 처리 등 많은 기능을 수행할 수 있습니다.

🤔 Filter vs Interceptor

이전에 공부한 Filter와 많이 유사하다고 느꼈습니다. Filter가 먼저 실행되고 Interceptor가 실행이 되는데 어떠한 차이점이 있는지 궁금하여 알아보았습니다.

	Filter	Interceptor
적용 범위	서블릿 컨테이너에서 처리되는 모든 요청에 대해 적용 가능	스프링의 DispathcherServlet이 처리하는 요청에 대해서만 적용 가능
처리 시점	요청 처리 전후로 전처리 후 후처리 가능	요청 처리 전에만 전처리 가능
적용 방법	web.xml에 등록하거나 @WebFilter 어노테이션을 사용하여 등록	인터셉터를 구현한 클래스를 빈으로 등록하고, 인터셉터를 등록하는 InterceptorRegistry 클래스의 addInterceptor() 메서드를 호출하여 등록
적용 용도	요청 및 응답에 대한 전역적인 처리가 필요한 경우	특정 컨트롤러의 요청에 대해 공통적인 전처리 작업을 수행하거나, 특정 조건에 따라 요청을 막아야 하는 경우

👨‍💻 구현

@Auth을 가진 Request가 오면 쿼리를 검사하는 로직을 만들어보겠습니다.

MvcConfig

@Configuration
@RequiredArgsConstructor
public class MvcConfig implements WebMvcConfigurer {
    private final AuthInterceptor authInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //addPathPatterns에 내가 원하는 주소만 넣어도 된다.
        registry.addInterceptor(authInterceptor).addPathPatterns("/api/private/*");
    }
}

스프링 MVC에서 인터셉터를 설정하기 위한 MvcConfig입니다.

@Configuration 어노테이션은 스프링 컨테이너에게 해당 클래스를 Bean 구성 클래스로 인식하도록 지정하는 역할을 합니다. 해당 어노테이션을 사용하면 스프링은 해당 클래스를 구성 클래스로 인식하여, 애플리케이션 실행 시에 Bean들을 생성하고 구성합니다.
@RequireArgsConstructor는 생성자를 자동으로 생성하는 Lombok 어노테이션입니다.

WebMvcConfigurer addInterceptors() 메서드를 오버라이딩하면, 해당 메서드에서 인터셉트를 등록할 수 있습니다. 부가적으로 addPathPatterns() 사용하여 특정 URL에서만 작동하게 할 수 있습니다.

AuthInterceptor

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

        URI uri = UriComponentsBuilder.fromUriString(request.getRequestURI())
                .query(request.getQueryString())
                .build()
                .toUri();

        boolean hasAnnotation = checkAnnotation(handler, Auth.class);
        log.info("has Annotation : {}", hasAnnotation);
        
        //Auth 권한을 가진 요청에 대해서만 세선,쿠키 등을 검사
        if (hasAnnotation) { //권한 체크
            String query = uri.getQuery();
            log.info("query : {}", query);
            return query.contains("name=Chan");
        }

        //return value -> false : filter -> dispatcher -> interceptor -> 진입 불가.
        return true;
    }

    private boolean checkAnnotation(Object handler, Class clazz) {
        //resource javascript, html 는 통과 시킨다.
        if (handler instanceof ResourceHttpRequestHandler) {
            return true;
        }

//        annotation check
        HandlerMethod method = (HandlerMethod) handler;

        log.info("get annotation : {}", method.getMethodAnnotation(clazz));
        log.info("get bean type : {}", method.getBeanType().getAnnotation(clazz));

        if (method.getMethodAnnotation(clazz) != null ||
                method.getBeanType().getAnnotation(clazz) != null) {
            //Auth annotation 이 있으면 true

            return true;
        }

        return false;
    }
}

checkAnnotation에서 @Auth의 여부를 확인하여 리턴합니다. 만약 @Auth가 사용된 Request면 쿼리문을 검사하여 name=Chan인지 확인합니다. false면 인터셉터선에서 종료가 되기 때문에 Response값을 클라이언트는 받지 못하게 됩니다.

실행결과 (쿼리문 일치)

{
"name": "Chan",
"age": 111
}

실행결과 (쿼리문 불일치)

No Content

실행결과 (@Auth 미사용

{
"name": "ㅁㅁㅁ",
"age": 111
}

✅ 요약

• Spring에서 제공하는 AOP의 한종류로 컨트롤러에서 실행 전/후에서 작업할 수 있다.
• 모든 요청에서 공통적인 작업을 처리할 때 인터셉트를 사용하면 좋다.
• 인터셉트는 WebMvcConfigurer, @Interceptor를 사용하는 방식으로 나뉜다.
• Filter와 유사하지만 적용범위와 역할이 다르다.