[Spring Boot] Interceptor

📍 Interceptor

• org.springframework.web.servlet.HandlerInterceptor 인터페이스를 구현한 클래스이다.
• HandlerInterceptor 인터페이스는 preHandler, postHandler, afterCompletion 등의 메서드를 제공한다.
• WebMvcConfigurer를 구현한 클래스에서 Interceptor를 추가하여 사용한다.(여기서 추가할 인터셉터, 적용 경로, 제외 경로 등을 지정할 수 있다.)
• 주로 웹 애플리케이션의 HTTP 요청 처리를 가로채어 처리 전, 후, 및 완료 후에 특정 작업을 수행하기 위해 사용한다.

📍 Interceptor 제공 메서드

• preHandler()
  • 실행 시점: 컨트롤러 실행 전(②와 ③ 사이)
  • 반환값
    • true: 컨트롤러 실행
    • false: 컨트롤러 실행하지 않고 요청 중단
• postHandler()
  • 실행 시점: 컨트롤러 실행 후, 뷰 렌더링 전(⑥와 ⑦ 사이)
  • 반환값: 없음
• afterCompletion()
  • 실행 시점: 클라이언트 응답 전송 후(⑧ 이후)
  • 반환값: 없음

이미지 출처

① DispatcherServlet은 요청을 수신한다.
② DispatcherServlet은 적절한 컨트롤러를 선택하는 작업을 HandlerMapping에게 위임한다. HandlerMapping은 요청된 URL에 매핑된 컨트롤러를 선택하고 선택된 핸들러 및 컨트롤러를 DispatcherServlet에 반환한다.
③ DispatcherServlet은 컨트롤러의 비즈니스 로직 실행 작업을 HandlerAdapter에게 위임한다.
④ HandlerAdapter는 컨트롤러의 비즈니스 로직을 호출한다.
⑤ 컨트롤러는 1️⃣비즈니스 로직을 실행하고, 2️⃣결과를 모델에 설정하고, 3️⃣뷰의 논리적 이름(컨트롤러에서 반환되는 문자열)을 HandlerAdapter에 반환한다.
⑥ DispatcherServlet은 뷰의 이름에 해당하는 뷰를 찾아주는 작업을 ViewResolver에게 위임한다. ViewResolver는 뷰 이름에 매핑된 뷰를 반환한다.
⑦ DispatcherServlet은 반환된 뷰에 렌더링 작업을 위임한다.
⑧ 뷰는 모델 데이터를 렌더링하고 응답을 반환한다.

👉 Filter와 Interceptor의 차이점

• Filter
  • 서블릿 컨테이너 레벨에서 동작(Spring MVC와는 무관하게 웹 애플리케이션의 전역 수준에서 동작)
  • javax.servlet.Filter 인터페이스를 구현
  • 메서드: doFilter(DispatcherServlet이 요청을 수신하기 전(① 이전)에 실행)
• Interceptor
  • Spring MVC의 일부로서 컨트롤러 레벨에서 동작(Spring Bean으로 등록하기 위해 @Component 어노테이션 필요)
  • org.springframework.web.servlet.HandlerInterceptor 인터페이스를 구현
  • 메서드: preHandelr, postHandler, afterCompletion

👉 Filter와 Interceptor 실행 순서 요약

• doFilter() -> preHandle() -> 컨트롤러 실행 -> postHandle() -> 뷰 렌더링 -> 클라이언트에 응답 전송 -> afterCompletion()

📍 예시 코드

1) HandlerInterceptor 구현 클래스(인터셉터 클래스)

• @Component 어노테이션 필요
• HandlerInterceptor 구현
• preHandle, postHandler, afterCompletion 메서드 오버라이드

// 🟢 /src/main/java/com/memo/interceptor/PermissionInterceptor.java

package com.memo.interceptor;

import java.io.IOException;

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import jakarta.servlet.http.HttpSession;
import lombok.extern.slf4j.Slf4j;

@Slf4j
@Component
public class PermissionInterceptor implements HandlerInterceptor {

	@Override
	public boolean preHandle(
			HttpServletRequest request, 
			HttpServletResponse response, 
			Object handler) throws IOException {

		String uri = request.getRequestURI();
		
		HttpSession session = request.getSession();
		Integer userId = (Integer)session.getAttribute("userId");
		
		log.info("[@@@@@@@@@@@ preHandle] uri:{}", uri);
		
		// 비로그인 && /post => 로그인 페이지로 이동, 컨트롤러 수행 방지
		if(userId == null && uri.startsWith("/post")) {
			response.sendRedirect("/user/sign-in-view");
			return false; // 원래 요청에 대해서 컨트롤러 수행 안함
		} 
		
		// 로그인 && /user => 글목록 페이지로 이동, 컨트롤러 수행 방지
		if(userId != null && uri.startsWith("/user")) {
			response.sendRedirect("/post/post-list-view");
			return false; // 원래 요청에 대해서 컨트롤러 수행 안함
		}

		return true; // 컨트롤러 수행
	}
	
	@Override
	public void postHandle(
			HttpServletRequest request, 
			HttpServletResponse response, 
			Object handler, 
			ModelAndView mav) {
            
		log.info("[########### postHandle]");
	}
	
	@Override
	public void afterCompletion(
			HttpServletRequest request, 
			HttpServletResponse response, 
			Object handler,
			Exception ex) {
		
		log.info("[$$$$$$$$$$$ afterCompletion]");
	}
	
}

2) WebMvcConfigurer 구현 클래스(경로 설정 클래스)

• @Configuration 어노테이션 필요
• WebMvcConfigurer 구현
• 구현한 인터셉터 autowired
• addInterceptors 메서드 오버라이드

// 🟢 /src/main/java/com/memo/config/WebMvcConfig.java

package com.memo.config;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import com.memo.interceptor.PermissionInterceptor;

@Configuration // 설정을 위한 spring bean
public class WebMvcConfig implements WebMvcConfigurer {

	@Autowired
	private PermissionInterceptor interceptor;
	
	@Override
	public void addInterceptors(InterceptorRegistry registry) {
		registry
		.addInterceptor(interceptor)
		.addPathPatterns("/**")
		.excludePathPatterns("/static/**", "/error", "/user/sign-out");
	}
	
}