Github 소스코드

🔎 Spring Interceptor의 동작 시점

🔎 Interceptor 구현

인터셉터 클래스는 HandlerInterceptor 인터페이스를 구현해야 합니다.

HandlerInterceptor에는 3가지 메서드가 있습니다.

• preHandle 메서드는 컨트롤러 호출 전에 호출되는 메서드입니다.
  우리가 하고자 하는 로그인 검증 및 분기 처리는 이 메서드에 구현해줘야 합니다.
• 기본적으로 request, response 객체를 갖고 있고 handler 즉 컨트롤러에 대한 객체도 갖고있습니다. Dispatcher servlet 이후에 호출되기에 가능한 것이지요.
  • 
• postHandle 메서드는 컨트롤러 호출 후에 예외가 없을 때 호출되는 메서드입니다. 컨트롤러 호출 직후에 호출되지만 만약 예외가 발생하였다면 postHandle 메서드는 실행되지 않습니다.
• ModelAndView 객체도 갖고있는 것이 특이점 입니다.
  • 
• afterComplete 메서드는 컨트롤러의 Http 요청이 모두 완료된 후에 호출됩니다. 이 메서드는 예외가 발생하여도 반드시 호출됩니다.
• 때문에 Exception 객체도 갖고 있습니다.
  • 

우리가 필요한 메서드는 preHandle 메서드이기 때문에 preHandle 메서드만 구현하겠습니다. HandlerInterceptor의 모든 메서드는 default 키워드가 붙어있기 때문에 필수 구현 메서드가 아닙니다.

preHandle의 구현은 이전 Filter의 doFilter메서드와 거의 비슷합니다.
다른 점은 접근 가능한 URI에 대한 처리를 인터셉터 구현부에서 하지 않는다는 점 입니다.

@Slf4j
public class LoginCheckInterceptor implements HandlerInterceptor {

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

        String requestURI = request.getRequestURI();
        log.info("인증 요청 {}", requestURI);

        HttpSession session = request.getSession();
        if (session == null || session.getAttribute(SessionConst.LOGIN_MEMBER) == null) {
            log.info("인증 실패");
            response.sendRedirect("/login?redirectURL=" + requestURI);
            return false; // 더 이상 진행 ❌
        }
        return true;
    }
}

HttpServletRequest 객체로부터 session 정보를 받아와 권한을 검증합니다.

• 검증에 실패시 로그인 페이지로 이동전 직전 URI정보와 함께 로그인 페이지로 redirect 후 false를 리턴합니다.
• 검증에 성공시 true를 리턴합니다.

true 리턴시 다음 인터셉터 혹은 컨트롤러로 진행합니다.
false 리턴시 현재 인터셉터에서 진행을 멈춥니다. (우리는 false 리턴 전 redirect해주었기 때문에 멈추지 않고 redirect 이후 흐름을 따라갑니다.)

🔎 Interceptor 등록

WebMvcConfigurer를 구현하는 설정 클래스를 정의합니다.
(컴포넌트 스캔의 대상이 되기 위해 @Configuration을 붙여줍니다.)

addInterceptors(InterceptorRegistry) 메서드를 오버라이딩 합니다.

@Override
public void addInterceptors(InterceptorRegistry registry) {

    registry.addInterceptor(new LoginCheckInterceptor())
            .order(1)
            .addPathPatterns("/**")
            .excludePathPatterns("/", "/members/add", "/login", "/logout",  "/css/**");
}

• order는 인터셉터의 순서를 정의합니다. 만약 권한 검증을 위한 인터셉터보다 앞에 동작시키고 싶은 인터셉터가 있다면 그 인터셉터의 order를 1로하고 로그인 검증 인터셉터의 order를 2로 해줍니다.
• addPathPatterns 등록하고자 하는 인터셉터를 적용시킬 경로를 설정합니다.
  보통 스프링 기술에서 전체 경로는 /** 입니다. /*가 아닌 것에 유의합니다.
• excludePathPatterns에는 인터셉터를 적용시키지 않고자 하는 경로를 설정합니다.
  • 이런 메서드가 지원되기 때문에 인터셉터 구현부에서 경로에 대한 검증이 불필요한 것 입니다.

위와 같이 경로를 설정해준다면 모든 경로에 대해 등록한 인터셉터를 적용시키고 / , /members/add, /login, /logout, /css/** 에 대해 인터셉터를 적용시키지 않습니다.

인프런 김영한님의 스프링 MVC 2편 을 수강하고 정리한 내용입니다.