[Spring] Interceptor는 어떻게 동작할까? - DispatcherServlet 내부 코드 살펴보기

여기 간단한 장바구니 어플리케이션이 있습니다.

장바구니에 상품을 추가, 제거, 조회하는 딱 세 가지의 일을 할 수 있습니다.

 

그래도 아무나 내 장바구니에 상품을 담을 수는 없습니다!

로그인한 사용자만 자신의 장바구니에 상품을 담을 수 있습니다.

그렇다면 상품을 담기 전에 상품을 담으려는 사용자의 인증 작업을 먼저 수행해야합니다.

 

인증 작업은 다음과 같은 절차로 진행됩니다.

1. 'Authorization' 헤더 추출
2. 추출된 정보로 우리의 장바구니 어플리케이션의 회원인지 확인

이 작업은 상품 추가, 상품 제거, 상품 조회 API에 모두 추가가 되어야 합니다.

@RestController
public class CartController {

    @PostMapping("/carts/products/{productId}")
    public void add() {
        // 'Authorization' 헤더 추출
        // 추출된 정보로 회원인지 확인

        // 상품 추가
    }

    @DeleteMapping("/carts/products/{productId}")
    public void remove() {
        // 'Authorization' 헤더 추출
        // 추출된 정보로 회원인지 확인

        // 상품 제거
    }

    @GetMapping("/carts/products")
    public List<ProductDto> get() {
        // 'Authorization' 헤더 추출
        // 추출된 정보로 회원인지 확인

        // 상품 조회
    }
}

주석으로 간단하게 표현했지만, 이를 실제 코드로 작성한다면 같은 코드가 길게 반복되어 아주 불편할 것 같습니다.

또 API가 추가된다면 중복 코드는 더 늘어날 것입니다. 

 

여기서 중복 로직을 따로 분리해서 처리할 수는 없을까요?

이때 Interceptor를 사용할 수 있습니다.

 

Interceptor란?

인터셉터는 들어온 요청을 처리하기 전에 그 요청을 가로채서 어떤 일을 수행하는 역할을 합니다.

그렇다면 위의 공통된 인증 로직을 인터셉터를 이용해 해결할 수 있을 것 같습니다!

 

인터셉터는 HandlerInterceptor 인터페이스를 구현하거나 HandlerInterceptorAdapter 클래스를 확장하여 사용합니다.

HandlerInterceptor에는 아래와 같이 세 가지의 메서드가 있습니다. 이 메서드들을 오버라이딩하여 원하는 작업을 하도록 할 수 있습니다.

• preHandler() - 핸들러가 실행되기 전에 호출된다.
• postHandler() - 핸들러가 실행된 후에 호출된다.
• afterCompletion() - 요청이 완료되고 뷰가 생성된 후에 호출된다. 

그렇다면 저희는 preHandle() 메서드를 구현하여 컨트롤러가 실행되기 전에 인증 작업을 할 수 있습니다.

public class AuthenticationInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
            
        // 'Authorization' 헤더 추출
        // 추출된 정보로 회원인지 확인
        
        return true;
    }
}

컨트롤러에 있던 공통 로직을 제거할 수 있게 됐습니다!

 

우리가 만든 인터셉터를 등록하기 위해서 WebMvcConfigurer을 구현한 클래스를 만들고 @Configuration 어노테이션을 붙여줍니다.

WebMvcConfigurer의 addInterceptors() 메서드를 오버라이딩 하여 우리가 만든 인터셉터를 등록합니다. 

WebMvcConfigurer에 대한 자세한 내용은 생략하겠습니다. (공식문서 참고)

 

@Configuration
public class WebConfiguration implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new AuthenticationInterceptor())
                .addPathPatterns("/carts/**");
    }
}

addPathPatterns를 통해 인터셉터가 동작할 URI를 지정해줄 수 있습니다.

---

인터셉터가 제대로 동작하는 지 확인해보겠습니다.

동작 순서를 확인하기 위해 컨트롤러의 조회 API와, 인터셉터의  preHandle(), postHandle(), afterCompletion() 메서드에 출력문을 추가합니다.

AuthenticationInterceptor 각 메서드에 출력문 추가

Controller Get 메서드에 출력문 추가

그리고 GET 요청을 보내보면 아래와 같은 순서로 동작하는 것을 확인할 수 있습니다!

이제 인터셉터의 동작순서와 사용법에 대해서는 알았습니다.

 

하지만 근본적인 궁금증이 남습니다.

어떻게 인터셉터가 컨트롤러의 요청 수행 전과 후에 동작을 할 수 있는지, 내부 동작이 궁금합니다.

 

Interceptor는 어떻게 동작할까?

인터셉터가 어떻게 동작하는지 알기 위해서는 DispatcherServlet의 HandlerMapping에 대해서 알 필요가 있습니다.

그래서 DispatcherServlet 내부 코드를 살짝 살펴보았습니다.

 

다음은 DispatcherServlet 내의 doDispatch() 메서드 입니다. 그 중에서 대부분 생략하고 중요한 부분만 가져왔습니다.

// DispatcherServlet내의 doDispatch()
protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
    // 생략..		
    HandlerExecutionChain mappedHandler = null;				
    // 생략..
    try {
    	// 생략.. 
        try {
        	// 생략..
            // Determine handler for the current request.
            mappedHandler = getHandler(processedRequest);
            
            // 생략..
            // Determine handler adapter for the current request.
            HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());

            // 생략..

            if (!mappedHandler.applyPreHandle(processedRequest, response)) {
                return;
            }

            // Actually invoke the handler.
            mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
            
            // 생략..
            mappedHandler.applyPostHandle(processedRequest, response, mv);
        }
        // 생략..
        processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
    }
}

요청이 들어오면 DispatcherServlet은 HandlerMapping에게 요청에 맞는 핸들러를 찾도록 요구합니다.

mappedHandler = getHandler(processedRequest);

이 부분이 HandlerMapping이 핸들러를 찾는 부분인 것 같습니다.

getHandler() 내부로 들어가보면, 실제로 등록된 HandlerMapping 빈들을 돌면서 현재 들어온 요청을 처리할 핸들러를 찾는 것을 볼 수 있습니다.

HandlerExecutionChain handler = mapping.getHandler(request);

위의 부분에서 핸들러를 찾는 일을 수행할 것 같으니 getHandler() 메서드 내부로 한 번 더 들어가봅니다.

 

그럼 아래와 같은 코드가 있습니다. 중요한 부분만 살펴봅시다.

@Override
@Nullable
public final HandlerExecutionChain getHandler(HttpServletRequest request) throws Exception {
    // 생략..

    HandlerExecutionChain executionChain = getHandlerExecutionChain(handler, request);

    // 생략 ..
    return executionChain;
}

getHandlerExecutionChain()이 최종적으로 HandlerExecutionChain 객체를 반환하는군요.

 

여기서 HandlerExecutionChain 클래스가 무엇인지 잠깐 알아봅시다.

HandlerExecutionChain은 핸들러와, 핸들러에 적용될 인터셉터들을 가지고 있는 클래스입니다.

 

그럼 다시 돌아와서 마지막으로 getHandlerExecutionChain()을 살펴봅시다...!

드디어 찾았습니다!

우리가 등록한 인터셉터가 있는지 확인하고 HandlerExecutionChain에 인터셉터를 추가한 후, 그 HandlerExecutionChain을 반환합니다.

 

그럼 다시 DispatcherServlet의 doDispatch() 메서드로 돌아가 봅시다.

// DispatcherServlet내의 doDispatch()
protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
    // 생략..		
    HandlerExecutionChain mappedHandler = null;				
    // 생략..
    try {
    	// 생략.. 
        try {
        	// 생략..
            // Determine handler for the current request.
            mappedHandler = getHandler(processedRequest);
            
            // 생략..
            // Determine handler adapter for the current request.
            HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());

            // 생략..

            if (!mappedHandler.applyPreHandle(processedRequest, response)) {
                return;
            }

            // Actually invoke the handler.
            mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
            
            // 생략..
            mappedHandler.applyPostHandle(processedRequest, response, mv);
        }
        // 생략..
        processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
    }
}

getHandler()를 통해 받은 HandlerExecutionChain을 mappedHandler 변수에 대입합니다.   

그리고 실제 핸들러 로직을 수행할 HandlerAdapter를 가져와 ha 변수에 대입합니다. (getHandlerAdapter() 메서드)

 

이후 드디어 인터셉터의 preHandle() 메서드를 실행할 것 같은 코드가 보입니다.

if (!mappedHandler.applyPreHandle(processedRequest, response)) {
   return;
}

실제로 applyPreHandle() 메서드 내부에서 우리가 정의한 preHandle() 메서드를 실행합니다.

그 후에 HandlerAdapter가 핸들러 로직을 수행합니다. 

mv = ha.handle(processedRequest, response, mappedHandler.getHandler());

 

여기서 말하고 싶은 것은, 실제 컨트롤러의 로직이 수행되기 전 인터셉터의 preHandle()을 수행하는 코드가 실행됩니다.

그리고 컨트롤러의 로직이 수행된 후 postHandle()을 수행하는 코드가 있는 것도 확인할 수 있습니다.

processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
}

마지막으로 processDispatchResult() 내부를 확인해보면 인터셉터의 afterCompletion() 메서드를 수행하는 로직을 볼 수 있습니다.

 

결론

결론은 인터셉터는 DispatcherServlet 내부에서 다음과 같은 순서로 동작합니다.

1. 요청이 들어오면 DispatcherServlet은 HandlerMapping에게 요청에 맞는 핸들러를 찾도록 한다.
2. 핸들러를 찾는 과정에서 등록된 인터셉터가 있는지 확인한 후 인터셉터도 등록한다. 
3. 실제 핸들러(컨트롤러) 로직을 처리할 HandlerAdapter를 가져온다.
4. HandlerAdapter가 핸들러 코드를 실행하기 전 preHandle() 메서드를 실행한다.
5. 핸들러 코드를 실행한다.
6. postHandle() 메서드를 실행한다.
7. 이후에 afterCompletion() 메서드를 실행한다.

 

---

참고자료

https://www.baeldung.com/spring-mvc-handlerinterceptor