[Spring MVC] 필터, 인터셉터(로그인 처리 관련)

이 글은 인프런 김영한님의 Spring 강의를 바탕으로 개인적인 정리를 위해 작성한 글입니다.

---

로그인 한 사용자만 상품 관리 페이지에 들어갈 수 있어야 한다. 로그인 하지 않은 사용자도 URL을 직접 호출하면 상품 관리 화면에 들어갈 수 있다.
이렇게 로그인하지 않은 사용자는 다른 URL에 접근할 수 없도록 해주는 것이 서블릿 필터와 인터셉터이다.

 

애플리케이션 여러 로직에서 공통으로 관심이 있는 있는 것을 공통 관심사(cross-cutting concern)라고 한다. 

여기서는 등록, 수정, 삭제, 조회 등등 여러 로직에서 공통으로 인증에 대해서 관심을 가지고 있다.

이러한 공통 관심사는 스프링의 AOP로도 해결할 수 있지만, 웹과 관련된 공통 관심사는 지금부터 설명할 서블릿 필터 또는 스프링 인터셉터를 사용하는 것이 좋다.

 

웹과 관련된 공통 관심사를 처리할 때는 HTTP의 헤더나 URL의 정보들 이 필요한데, 서블릿 필터나 스프링 인터셉터는 HttpServletRequest 를 제공한다.

 

서블릿 필터

필터 흐름

HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 컨트롤러

필터를 적용하면 필터가 호출된 다음에 서블릿이 호출된다. 그래서 모든 고객의 요청 로그를 남기는 요구사항이 있다면 필터를 사용하면 된다.

필터는 특정 URL 패턴에 적용할 수 있다. /* 이라고 하면 모든 요청에 필터가 적용된다. 스프링을 사용하는 경우 여기서 말하는 서블릿은 스프링의 디스패처 서블릿으로 생각하면 된다.

 

필터 제한

로그인 사용자 : HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 컨트롤러

로그인 하지 않은 사용자 : HTTP 요청 -> WAS -> 필터(적절하지 않은 요청이라 판단, 서블릿 호출X)

필터에서 적절하지 않은 요청이라고 판단하면 거기에서 끝을 낼 수도 있다. 그래서 로그인 여부를 체크하기에 좋다. 

 

필터 체인

HTTP 요청 -> WAS -> 필터1 -> 필터2 -> 필터3 -> 서블릿 -> 컨트롤러

필터는 체인으로 구성되는데, 중간에 필터를 자유롭게 추가할 수 있다. 예를 들어서 로그를 남기는 필터를 먼저 적용하 고, 그 다음에 로그인 여부를 체크하는 필터를 만들 수 있다.

 

Filter 인터페이스

필터 인터페이스를 구현하고 등록하면 서블릿 컨테이너가 필터를 싱글톤 객체로 생성하고, 관리한다.

 public interface Filter {
     public default void init(FilterConfig filterConfig) throws ServletException {}
     
     public void doFilter(ServletRequest request, ServletResponse response,
             FilterChain chain) throws IOException, ServletException {}
             
     public default void destroy() {}
}

init(FilterConfig filterConfig)

이 메서드는 필터 인스턴스가 생성될 때 호출된다. 필터의 초기화 작업을 위한 메서드이다. FilterConfig 객체를 매개변수로 받아, 필터 구성 정보에 접근할 수 있다. Java 8 이상에서는 default 메서드로 제공되어, 필수적으로 오버라이드할 필요는 없다. 필터에 초기화할 특별한 작업이 없다면, 이 메서드를 구현하지 않아도 된다.

doFilter(ServletRequest request, ServletResponse response, FilterChain chain)

이 메서드는 필터의 핵심 기능을 수행한다. 요청과 응답을 가로채어 필요한 처리를 한 뒤, 필터 체인에서 다음 필터로 요청과 응답을 넘기거나, 혹은 요청 처리를 중단할 수 있다. ServletRequest와 ServletResponse 객체를 통해 요청과 응답 데이터에 접근하며, FilterChain 객체를 사용해 체인 내의 다음 필터로 작업을 전달한다. 이 메서드는 모든 필터에서 반드시 구현해야 한다.

destroy()

이 메서드는 필터 인스턴스가 제거될 때 호출된다. 필터가 더 이상 필요하지 않을 때 정리 작업을 수행하기 위한 메서드이다. 이 역시 Java 8 이상에서는 default 메서드로 제공되므로, 필요한 경우에만 오버라이드하면 된다.

 

요청 로그와 인증 체크 

요청 로그

@Slf4j
public class LogFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        log.info("log filter init"); //필터가 생성된 시점 로깅
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {

        //HTTP 요청이 오면 doFilter 가 호출
        HttpServletRequest httpRequest = (HttpServletRequest) request; //HttpServletRequest 로 캐스팅
        String requestURI = httpRequest.getRequestURI(); //요청 URL 얻어옴
        String uuid = UUID.randomUUID().toString(); //UUID 생성

        try {
            log.info("REQUEST  [{}][{}]", uuid, requestURI);
            chain.doFilter(request, response); //다음 필터를 호출하거나, 필터가 없으면 서블릿, 컨트롤러 호출
        } catch (Exception e) {
            throw e;
        } finally {
            log.info("RESPONSE [{}][{}]", uuid, requestURI);
        }
    }

    @Override
    public void destroy() {
        log.info("log filter destroy"); //필터가 종료된 시점을 로깅
    }
}

public class LogFilter implements Filter {}

→필터를 사용하려면 필터 인터페이스를 구현해야 한다.

 

doFilter(ServletRequest request, ServletResponse response, FilterChain chain)

→HTTP 요청이 오면 doFilter 가 호출된다.

→ServletRequest request 는 HTTP 요청이 아닌 경우까지 고려해서 만든 인터페이스이다. HTTP를 사용하면 HttpServletRequest httpRequest = (HttpServletRequest) request; 와 같이 다운 케스팅 하면 된다.

 

String uuid = UUID.randomUUID().toString();

→HTTP 요청을 구분하기 위해 요청당 임의의 uuid 를 생성해둔다. log.info("REQUEST [{}][{}]", uuid, requestURI);
uuid 와 requestURI 를 출력한다.

 

chain.doFilter(request, response);

→다음 필터가 있으면 필터를 호출하고, 필터가 없으면 서블릿을 호출한다. 만약 이 로직을 호출하지 않으면 다음 단계로 진행되지 않는다.

 

인증 체크

@Slf4j
public class LoginCheckFilter implements Filter {
    private static final String[] whitelist = {"/", "/members/add", "/login", "/ logout","/css/*"}; //이 URL 에 대해서는 필터를 적용하지 않음
    @Override
     public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
         HttpServletRequest httpRequest = (HttpServletRequest) request; // HttpServletRequest 로 캐스팅
         String requestURI = httpRequest.getRequestURI(); //요청 URL 가져오기
         HttpServletResponse httpResponse = (HttpServletResponse) response;// HttpServletResponse 로 캐스팅
         try {
                 log.info("인증 체크 필터 시작 {}", requestURI);
                 if (isLoginCheckPath(requestURI)) { //url 과 whitelist 와 매치되는 것이 없다면 true
                        log.info("인증 체크 로직 실행 {}", requestURI);
                        HttpSession session = httpRequest.getSession(false); //세션이 이미 존재하지 않는 경우 새로 만들지 않고, null 을 반환
                        if (session == null || session.getAttribute(SessionConst.LOGIN_MEMBER) == null) { //세션이 없거나 세션을 찾을 수 없다면
                            log.info("미인증 사용자 요청 {}", requestURI);
                            httpResponse.sendRedirect("/login?redirectURL=" + requestURI); //로그인으로 기존에 접속했던 url 을 파라미터로 넘겨서 redirect
                            return; //여기가 중요, 미인증 사용자는 다음으로 진행하지 않고 끝
                        }
                 }
                 //필터링 후 이상이 없다면
                 chain.doFilter(request, response); //다음 필터를 호출하거나 서블릿, 컨트롤러 호출
         } catch (Exception e) {
                 throw e; //예외 로깅 가능 하지만, 톰캣까지 예외를 보내주어야 함
         } finally {
                 log.info("인증 체크 필터 종료 {}", requestURI);
         }
    }

    /**
     * 화이트 리스트의 경우 인증 체크X
     */
    private boolean isLoginCheckPath(String requestURI) {
        return !PatternMatchUtils.simpleMatch(whitelist, requestURI); //문자열 탐색 메소드(매치되는 것이 있다면 true, 여기서는 매치되는 것이 없다면 true)
    }
}

whitelist = {"/", "/members/add", "/login", "/logout", "/css/*"};

→인증 필터를 적용해도 홈, 회원가입, 로그인 화면, css 같은 리소스에는 접근할 수 있어야 한다. 이렇게 화이트 리스트 경로는 인증과 무관하게 항상 허용한다. 화이트 리스트를 제외한 나머지 모든 경로에는 인증 체크 로직을 적용한다. 

 

isLoginCheckPath(requestURI)

→화이트 리스트를 제외한 모든 경우에 인증 체크 로직을 적용한다.

 

httpResponse.sendRedirect("/login?redirectURL=" + requestURI);

→미인증 사용자는 로그인 화면으로 리다이렉트 한다. 그런데 로그인 이후에 다시 홈으로 이동해버리면, 원하는 경로를 다시 찾아가야 하는 불편함이 있다. 예를 들어서 상품 관리 화면을 보려고 들어갔다가 로그인 화면으로 이동하면, 로그인 이후에 다시 상품 관리 화면으로 들어가는 것이 좋다. 이런 부분이 개발자 입장에서는 좀 귀찮을 수 있어도 사용자 입장으로 보면 편리한 기능이다. 이러한 기능을 위해 현재 요청한 경로인 requestURI 를 /login 에 쿼리 파라미터로 함께 전달한다. 물론 /login 컨트롤러에서 로그인 성공시 해당 경로로 이동하는 기능은 추가로 아래의 코드와 같이 개발해야 한다.

@PostMapping("/login")
 public String loginV4(
         @Valid @ModelAttribute LoginForm form, BindingResult bindingResult,
         @RequestParam(defaultValue = "/") String redirectURL,
         HttpServletRequest request) {
         
          //redirectURL 적용
     return "redirect:" + redirectURL; //redirectURL 적용
 
 }

 

return; 

→필터를 더는 진행하지 않는다. 이후 필터는 물론 서블릿, 컨트롤러가 더는 호출되지 않는다. 앞서 redirect 를 사용했기 때문에 redirect 가 응답으로 적용되고 요청이 끝난다.

 

필터 인터페이스를 구현한다고 해서 필터가 적용되지 않는다. 따라서 필터를 등록해줘야 한다.

 

필터 등록

필터를 등록하는 방법은 여러가지가 있지만, 스프링 부트를 사용한다면 FilterRegistrationBean 을 사용해서 등록하면 된다.

@Configuration
public class WebConfig implements WebMvcConfigurer {
    //FilterRegistrationBean 필터 등록
    @Bean
    public FilterRegistrationBean logFilter() {
        FilterRegistrationBean<Filter> filterRegistrationBean = new FilterRegistrationBean<>();
        filterRegistrationBean.setFilter(new LogFilter()); //등록할 필터 지정
        filterRegistrationBean.setOrder(1); //필터 체인 순서, 낮을 수록 먼저 동작
        filterRegistrationBean.addUrlPatterns("/*"); //필터를 적용할 URL 패턴 지정, 한 번에 여러 패턴 지정 가능
        return filterRegistrationBean;
    }

    @Bean
    public FilterRegistrationBean loginCheckFilter() {
        FilterRegistrationBean<Filter> filterRegistrationBean = new FilterRegistrationBean<>();
        filterRegistrationBean.setFilter(new LoginCheckFilter());
        filterRegistrationBean.setOrder(2);
        filterRegistrationBean.addUrlPatterns("/*");
        return filterRegistrationBean;
    }
}

 

• setFilter(new LogFilter()) : 등록할 필터를 지정한다.
• setOrder(1) : 필터는 체인으로 동작한다. 따라서 순서가 필요하다. 낮을 수록 먼저 동작한다.
• addUrlPatterns("/*") : 필터를 적용할 URL 패턴을 지정한다. 한번에 여러 패턴을 지정할 수 있다.

 

@ServletComponentScan, @WebFilter(filterName = "logFilter", urlPatterns = "/*") 로 필터 등록이 가능하지만 필터 순서 조절이 안된다.
따라서 FilterRegistrationBean  을 사용하는 것이 좋다.

 

스프링 인터셉터

스프링 인터셉터도 서블릿 필터와 같이 웹과 관련된 공통 관심 사항을 효과적으로 해결할 수 있는 기술이다.

서블릿 필터가 서블릿이 제공하는 기술이라면, 스프링 인터셉터는 스프링 MVC가 제공하는 기술이다. 둘다 웹과 관련 된 공통 관심 사항을 처리하지만, 적용되는 순서와 범위, 그리고 사용방법이 다르다.

 

스프링 인터셉터 흐름

HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 스프링 인터셉터 -> 컨트롤러

스프링 인터셉터는 디스패처 서블릿과 컨트롤러 사이에서 컨트롤러 호출 직전에 호출된다.

스프링 인터셉터는 스프링 MVC가 제공하는 기능이기 때문에 결국 디스패처 서블릿 이후에 등장하게 된다. 스프링 MVC의 시작점이 디스패처 서블릿이라고 생각해보면 이해가 될 것이다.
스프링 인터셉터에도 URL 패턴을 적용할 수 있는데, 서블릿 URL 패턴과는 다르고, 매우 정밀하게 설정할 수 있다.

스프링 인터셉터 제한

로그인 사용자 : HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 스프링 인터셉터 -> 컨트롤러

비 로그인 사용자 : HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 스프링 인터셉터(적절하지 않은 요청이라 판단, 컨트롤러 호출)

인터셉터에서 적절하지 않은 요청이라고 판단하면 거기에서 끝을 낼 수도 있다. 그래서 로그인 여부를 체크하기에 좋다.

스프링 인터셉터 체인

HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 인터셉터1 -> 인터셉터2 -> 컨트롤러

스프링 인터셉터는 체인으로 구성되는데, 중간에 인터셉터를 자유롭게 추가할 수 있다. 예를 들어서 로그를 남기는 인터셉터를 먼저 적용하고, 그 다음에 로그인 여부를 체크하는 인터셉터를 만들 수 있다.

 

스프링 인터셉터는 서블릿 필터보다 편리하고, 더 정교하고 다양한 기능을 지원한다.

 

스프링 인터셉터 인터페이스

스프링의 인터셉터를 사용하려면 HandlerInterceptor 인터페이스를 구현하면 된다.

public interface HandlerInterceptor {
    default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        return true;
    }

    default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception {
    }

    default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {
    }
}

인터셉터는 컨트롤러 호출 전 ( preHandle ), 호출 후( postHandle ), 요청 완료 이후( afterCompletion )와 같이 단계적으로 잘 세분화 되어 있다.

서블릿 필터의 경우 단순히 request , response 만 제공했지만, 인터셉터는 어떤 컨트롤러( handler ) 가 호출되는지 호출 정보도 받을 수 있다. 그리고 어떤 modelAndView 가 반환되는지 응답 정보도 받을 수 있다.

 

preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)

목적: 컨트롤러 메서드가 호출되기 전에 실행된다. 인증 검사나 로깅과 같은 전처리 작업에 사용된다.

반환값: 이 메서드에서 true를 반환하면 요청 처리가 계속 진행된다. false를 반환하면, 요청 처리가 중단되며 더 이상의 컨트롤러 메서드 호출(핸들러 어댑터 호출 등)이나 다른 인터셉터 체인의 실행이 발생하지 않는다.

postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView)

목적: 컨트롤러 메서드가 실행된 후, 클라이언트에게 뷰를 렌더링하기 전에 호출된다(핸들러 어댑터 호출 후). 컨트롤러에서 생성된 데이터를 가공하거나 추가적인 속성을 모델에 추가하는 등의 후처리 작업에 사용될 수 있다.

매개변수: ModelAndView 객체를 통해 컨트롤러에서 반환된 모델과 뷰 정보에 접근하고 수정할 수 있다.

afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex)

목적: 요청 처리의 전체 과정이 완료된 후에 호출된다. 즉, 뷰 렌더링까지 모두 마친 후에 실행된다. 주로 리소스를 정리하는 작업이나 예외 로깅 등의 작업에 사용된다.

매개변수: Exception 객체를 통해 컨트롤러에서 발생한 예외를 처리할 수 있다.

 

예외가 발생시

• preHandle: 컨트롤러 호출 전에 호출된다.
• postHandle: 컨트롤러에서 예외가 발생하면 postHandle은 호출되지 않는다.
• afterCompletion: afterCompletion은 항상 호출된다. 이 경우 예외(ex)를 파라미터로 받아서 어떤 예외가 발생했는지 로그로 출력할 수 있다.

afterCompletion은 예외가 발생해도 호출된다.

예외가 발생하면 postHandle()는 호출되지 않으므로 예외와 무관하게 공통 처리를 하려면 afterCompletion()을 사용해야 한다.
예외가 발생하면 afterCompletion()에 예외 정보(ex)를 포함해서 호출된다.

인터셉터는 스프링 MVC 구조에 특화된 필터 기능을 제공한다고 이해하면 된다. 스프링 MVC를 사용하고, 특별히 필터를 꼭 사용해야 하는 상황이 아니라면 인터셉터를 사용하는 것이 더 편리하다.

 

요청 로그와 인증 체크

요청 로그

@Slf4j
public class LogInterceptor implements HandlerInterceptor {
    public static final String LOG_ID = "logId";

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        String requestURI = request.getRequestURI(); //요청 URL 받아옴
        String uuid = UUID.randomUUID().toString(); //UUID 생성
        request.setAttribute(LOG_ID, uuid); //UUID 값을 logId 라는 이름으로 request 에 저장

        //@RequestMapping: HandlerMethod
        //정적 리소스: ResourceHttpRequestHandler

        //핸들러 타입 체크: handler 객체가 HandlerMethod 의 인스턴스인지 확인한다.
        //이는 요청이 실제 컨트롤러 메서드에 의해 처리되는 경우에만 특정 로직을 실행하고자 할 때 유용
        if (handler instanceof HandlerMethod) { //HandlerMethod 는 요청을 처리하는 실제 메서드를 나타냄
            //호출할 컨트롤러 메서드의 모든 정보가 포함되어 있다.
            HandlerMethod hm = (HandlerMethod) handler; //핸들러(컨트롤러)를 HandlerMethod 로 캐스팅
        }
        log.info("REQUEST  [{}][{}][{}]", uuid, requestURI, handler);
        return true; //false 이면 다음 인터셉터나 컨트롤러가 호출 되지 않는다.
    }

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

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        String requestURI = request.getRequestURI();  //요청 URL 받아옴
        String logId = (String)request.getAttribute(LOG_ID); //request 에서 logId 로 저장되어 있는 UUID 를 가져옴

        log.info("RESPONSE [{}][{}]", logId, requestURI);

        if (ex != null) {
            log.error("afterCompletion error!!", ex);
        }
    }
}

 

1. 요청 URL 받아오기: HttpServletRequest 객체로부터 요청된 URL을 얻는다.
2. UUID 생성: 고유한 식별자(UUID)를 생성한다. 이 식별자는 요청을 구분하는 데 사용될 수 있다.
3. UUID 저장: 생성된 UUID를 request 객체에 속성으로 저장한다. 이를 통해 나중에 같은 요청에서 이 UUID를 참조할 수 있다.
   
4. 핸들러 타입 체크: handler 객체가 HandlerMethod의 인스턴스인지 확인한다. 이는 요청이 실제 컨트롤러 메서드에 의해 처리되는 경우에만 특정 로직을 실행하고자 할 때 유용하다.
   →HandlerMethod는 요청을 처리하는 컨트롤러 메서드의 모든 정보를 포함한다.
   →요청이 정적 리소스를 요구하는 경우, handler 객체는 ResourceHttpRequestHandler의 인스턴스가 될 수 있다.
5. 로깅: UUID, 요청된 URL, 핸들러 객체의 정보를 로깅한다. 이는 추후 문제 해결이나 모니터링에 유용할 수 있다.
6. 요청 처리 계속: preHandle 메서드에서 true를 반환하면 요청 처리가 계속된다. 만약 false를 반환하면, 요청 처리가 여기서 중단되고, 컨트롤러 메서드는 호출되지 않는다.

 

HandlerMethod

Spring MVC에서 컨트롤러의 메서드를 처리하는 데 사용되는 개념이다.
컨트롤러 내의 각 메서드는 HTTP 요청을 처리하기 위한 엔드포인트로 동작하며, HandlerMethod는 이러한 메서드와 관련된 메타데이터(예: 메서드 이름, 파라미터 타입, 어노테이션 등)를 캡슐화한다.

Spring MVC는 들어오는 HTTP 요청을 매핑하고 처리하는 적절한 컨트롤러 메서드를 결정하기 위해 HandlerMethod 객체를 사용한다.

HandlerMethod의 핵심 기능
-메서드 실행: HandlerMethod는 Spring MVC에서 요청을 처리하는 실제 메서드를 나타낸다.이 객체를 사용하면, 리플렉션 없이 관련 메서드를 직접 실행할 수 있다.
-메타데이터 접근: 메서드에 적용된 어노테이션, 메서드 파라미터, 메서드 반환 타입 등에 쉽게 접근할 수 있게 해준다. 이는 요청 처리, 파라미터 바인딩, 응답 생성 등에서 유용하게 사용된다.
-어노테이션 기반 처리: @RequestMapping과 같은 어노테이션이 적용된 메서드를 찾아 요청을 매핑하고 처리하는 데 중요한 역할을 한다.


@RequestMapping 어노테이션은 특정 HTTP 요청(예: GET, POST 등)을 컨트롤러의 메서드와 매핑한다. 이 과정에서 Spring MVC의 디스패처 서블릿(DispatcherServlet)은 들어오는 요청을 분석하여 해당 요청을 처리할 수 있는 HandlerMethod를 결정한다.

처리 과정
-요청 분석: 디스패처 서블릿은 요청의 URL, HTTP 메서드, 헤더, 파라미터 등을 분석한다.
-핸들러 매핑: 요청 정보를 바탕으로, 해당 요청을 처리할 컨트롤러 메서드를 찾기 위해 HandlerMapping 전략을 사용한다. 이때, @RequestMapping과 같은 어노테이션이 붙은 메서드가 후보가 된다.
-HandlerMethod 결정: 요청을 처리할 메서드가 결정되면, 해당 메서드와 연결된 HandlerMethod 객체가 생성된다. 이 객체는 메서드 자체뿐만 아니라, 메서드를 포함하는 컨트롤러 객체에 대한 참조도 포함한다.
-메서드 실행: HandlerAdapter를 사용하여 HandlerMethod를 실행한다. 이 과정에서 메서드의 파라미터는 요청에서 추출한 값으로 채워지며, 메서드의 반환 값은 적절한 뷰로 변환되어 응답을 생성한다

 

String uuid = UUID.randomUUID().toString(); 

→요청 로그를 구분하기 위한 uuid 를 생성한다.

 

request.setAttribute(LOG_ID, uuid)

→서블릿 필터의 경우 지역변수로 해결이 가능하지만, 스프링 인터셉터는 호출 시점이 완전히 분리되어 있다. 따라서 preHandle 에서 지정한 값을 postHandle, afterCompletion 에서 함께 사용하려면 어딘가에 담아두어야 한다. LogInterceptor 도 싱글톤 처럼 사용되기 때문에 맴버변수를 사용하면 위험하다. 따라서 request 에 담아두었다. 이 값은 afterCompletion 에서 request.getAttribute(LOG_ID) 로 찾아서 사용한다. 

 

return true

→true 면 정상 호출이다. 다음 인터셉터나 컨트롤러가 호출된다.(false 이면 추가적인 인터셉터나 컨트롤러 호출 X)

 

HandlerMethod

핸들러 정보는 어떤 핸들러 매핑을 사용하는가에 따라 달라진다. 스프링을 사용하면 일반적으로 @Controller, @RequestMapping을 활용한 핸들러 매핑을 사용하는데, 이 경우 핸들러 정보로 HandlerMethod가 넘어온다.

ResourceHttpRequestHandler

@Controller가 아니라 /resources/static 와 같은 정적 리소스가 호출 되는 경우 ResourceHttpRequestHandler가 핸들러 정보로 넘어오기 때문에 타입에 따라서 처리가 필요(intstancof 이용)하다.

postHandle, afterCompletion

종료 로그를 postHandle 이 아니라 afterCompletion에서 실행한 이유는, 예외가 발생한 경우 postHandle가 호출되지 않기 때문이다. afterCompletion은 예외가 발생해도 호출 되는 것을 보장한다.

 

인증 체크

@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(false); //세션이 이미 존재하지 않는 경우 새로 만들지 않고, null 을 반환
        if (session == null || session.getAttribute(SessionConst.LOGIN_MEMBER) == null) {  //세션이 없거나 세션을 찾을 수 없다면
            log.info("미인증 사용자 요청");
            response.sendRedirect("/login?redirectURL=" + requestURI); //로그인으로 기존에 접속했던 url 을 파라미터로 넘겨서 redirect
            return false;  //false 이면 다음 인터셉터나 컨트롤러가 호출 되지 않는다.
        }
        return true; //다음 인터셉터나 컨트롤러 호출
    }
}

 

이 코드는 스프링 인터셉터인 LoginCheckInterceptor 클래스의 구현 예이다. 이 클래스는 HandlerInterceptor 인터페이스를 구현한다. 로그인 여부를 확인하는 로직을 포함하고 있다. @Slf4j 어노테이션을 사용함으로써, 로그를 기록하는 기능을 클래스에 추가한다.

preHandle 메서드는 HTTP 요청이 컨트롤러에 도달하기 전에 호출된다. 이 메서드 내에서 요청된 URI를 로그로 기록하고, 현재 HTTP 세션의 유효성을 검사한다. 만약 세션이 존재하지 않거나, 세션 내에 로그인한 사용자 정보(SessionConst.LOGIN_MEMBER)가 없는 경우, 사용자가 미인증 상태로 판단된다.

이러한 경우, 사용자는 로그인 페이지로 리다이렉트되며, 원래 요청하려고 했던 URI는 쿼리 파라미터로 함께 전송되어 로그인 후 해당 페이지로 바로 이동할 수 있게 한다. preHandle 메서드에서 false를 반환하면, 이는 스프링 MVC가 이후의 인터셉터나 컨트롤러를 호출하지 않아야 함을 의미한다. 반면, 세션이 유효하고 로그인한 사용자 정보가 있는 경우 true를 반환하여 다음 인터셉터나 컨트롤러로 요청 처리를 계속 진행할 수 있도록 한다.

 

인터셉터 등록

@Configuration
public class WebConfig implements WebMvcConfigurer {

    //addInterceptors 인터셉터 등록
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LogInterceptor()) //인터셉터를 등록
                .order(1) //인터셉터의 호출 순서를 지정한다. 낮을 수록 먼저 호출
                .addPathPatterns("/**") //인터셉터를 적용할 URL 패턴을 지정
                .excludePathPatterns("/css/**", "/*.ico", "/error"); //인터셉터에서 제외할 패턴을 지정

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

WebMvcConfigurer가 제공하는 addInterceptors()를 사용해서 인터셉터를 등록할 수 있다.

• registry.addInterceptor(new LogInterceptor()) : 인터셉터를 등록한다.
• order(1) : 인터셉터의 호출 순서를 지정한다. 낮을수록 먼저 호출된다. addPathPatterns("/") : 인터셉터를 적용할 URL 패턴을 지정한다. 
• excludePathPatterns("/css/", "/*.ico", "/error") : 인터셉터에서 제외할 패턴을 지정한다.

필터와 비교해보면 인터셉터는 addPathPatterns, excludePathPatterns로 매우 정밀하게 URL 패턴을 지정할 수 있다.

 

스프링의 URL 경로

스프링이 제공하는 URL 경로는 서블릿 기술이 제공하는 URL 경로와 완전히 다르다. 더욱 자세하고, 세밀하게 설정할 수 있다.

PathPattern 공식 문서
? : 한 문자 일치
* : 경로(/) 안에서 0개 이상의 문자 일치
** : 경로 끝까지 0개 이상의 경로(/) 일치
{spring} : 경로(/)와 일치하고 spring이라는 변수로 캡처

{spring:[a-z]+} matches the regexp [a-z]+ as a path variable named "spring" {spring:[a-z]+} regexp [a-z]+ 와 일치하고, "spring" 경로 변수로 캡처
{*spring} 경로가 끝날 때 까지 0개 이상의 경로(/)와 일치하고 spring이라는 변수로 캡처
 /pages/t?st.html — matches /pages/test.html, /pages/tXst.html but not /pages/
 toast.html
 /resources/*.png — matches all .png files in the resources directory
 /resources/** — matches all files underneath the /resources/ path, including /
 resources/image.png and /resources/css/spring.css
 /resources/{*path} — matches all files underneath the /resources/ path and
 captures their relative path in a variable named "path"; /resources/image.png
will match with "path" → "/image.png", and /resources/css/spring.css will match
with "path" → "/css/spring.css"
 /resources/{filename:\\w+}.dat will match /resources/spring.dat and assign the
 value "spring" to the filename variable

링크: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/ web/util/pattern/PathPattern.html

 

서블릿 필터와 스프링 인터셉터는 웹과 관련된 공통 관심사를 해결하기 위한 기술이다.
서블릿 필터와 비교해서 스프링 인터셉터가 개발자 입장에서 훨씬 편리하다. 특별한 문제가 없다면 인터셉터를 사용하는 것이 좋다.