Spring MVC 2편 - 로그인 필터와 인터셉터

본 게시글은 인프런 김영한 선생님 강의 스프링 MVC 2편을 완강하고 배운 것을 남기고자 적은 포스팅입니다.

 

강의 링크는 아래와 같습니다.

 

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-2/dashboard

스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 - 인프런 | 강의

 

먼저 한 가지 예를 들어보겠다. 어떤 웹 애플리케이션에서 상품 관리 페이지는 로그인한 유저만 접속할 수 있다.

서버에게 요청을 보낸 클라이언트가 상품 관리 페이지에 접근해도 되는지 권한을 체크하는 방법은 서버가 로그인한 유저인지 아닌지 판단해서 접근을 막거나 허용하는 것이다. 그러면 이런 경우에는 로그인 여부를 점검하는 로직을 짜야할 것이다. 상품 관리 컨트롤러에서 로그인 여부를 체크하는 로직을 작성하면 되겠지만 등록, 수정, 삭제, 조회 등등 상품관리의 모든 컨트롤러 로직에 공통으로 로그인 여부를 확인해야 한다. 더 큰 문제는 향후 로그인과 관련된 로직이 변경될 때이다. 작성한 모든 로직을 다 수정해야 할 수 있다.

 

이렇게 애플리케이션 여러 로직에서 공통으로 관심이 있는 것을 공통 관심사라고 한다. 여기서는 등록, 수정, 삭제, 조회 등등 여러 로직에서 공통으로 인증에 대해서 관심을 가지고 있다.

 

이러한 공통 관심사는 지금부터 서블릿 필터와 인터셉터를 사용해서 해결해볼 것이다. 웹과 관련된 공통 관심사를 처리할 때는 HTTP의 헤더나 URL 정보 등이 필요한데, 서블릿 필터와 인터셉터는 HttpServletRequest를 제공한다.

 

 

서블릿 필터

필터는 서블릿이 지원하는 수문장이다.

 

필터의 흐름은 아래와 같다.

 

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

 

필터를 적용하면 필터가 호출된 다음에 서블릿이 호출된다. 그래서 모든 고객의 요청 로그를 남기는 요구사항이 있다면 필터를 사용하면 된다. 참고로 필터는 특정 URL 패턴에 적용할 수 있다. /*이라고 하면 모든 요청에 필터가 적용된다.

참고로 스프링을 사용하는 경우 여기서 말하는 서블릿은 스프링의 디스패처 서블릿으로 생각하면 된다.

 

필터 제한은 아래와 같다.

 

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

 

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

필터는 체인으로 구성되는데, 중간에 필터를 자유롭게 추가할 수 있다. 먼저 로그를 남기는 필터를 적용하고, 이후에 로그인 여부를 체크하는 필터를 넣을 수도 있다.

 

필터 인터페이스는 아래와 같다.

 

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(): 필터 초기화 메서드, 서블릿 컨테이너가 생성될 때 호출된다.
• doFilter(): 고객의 요청이 올 때마다 해당 메서드가 호출된다. 필터의 로직을 구현하면 된다.
• destroy(): 필터 종료 메서드, 서블릿 컨테이너가 종료될 때 호출된다.

 

먼저 가장 기본적인 로그를 남기는 필터를 개발하고 적용해보자. 

 

@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 {
         HttpServletRequest httpRequest = (HttpServletRequest) request;
         String requestURI = httpRequest.getRequestURI();
         String uuid = UUID.randomUUID().toString();
         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");
     }
}

 

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

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

 

chain.doFilter(request, response);

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

 

이제 필터를 설정해야 한다.

 

@Configuration
public class WebConfig {
     @Bean
     public FilterRegistrationBean logFilter() {
         FilterRegistrationBean<Filter> filterRegistrationBean = new
        FilterRegistrationBean<>();
         filterRegistrationBean.setFilter(new LogFilter());
         filterRegistrationBean.setOrder(1);
         filterRegistrationBean.addUrlPatterns("/*");
         return filterRegistrationBean;
     }
}

 

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

 

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

 

이제 로그 필터가 아닌 로그인을 체크하는 필터를 개발해보자.

 

@Slf4j
public class LoginCheckFilter implements Filter {
 private static final String[] whitelist = {"/", "/members/add", "/login","/logout","/css/*"};

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

     HttpServletRequest httpRequest = (HttpServletRequest) request;
     String requestURI = httpRequest.getRequestURI();
     HttpServletResponse httpResponse = (HttpServletResponse) response;

     try {
     log.info("인증 체크 필터 시작 {}", requestURI);
     
     if (isLoginCheckPath(requestURI)) {
         log.info("인증 체크 로직 실행 {}", requestURI);
         HttpSession session = httpRequest.getSession(false);
         if (session == null || session.getAttribute(SessionConst.LOGIN_MEMBER) == null) {
             log.info("미인증 사용자 요청 {}", requestURI);
             //로그인으로 redirect
             httpResponse.sendRedirect("/login?redirectURL=" +requestURI);
             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);
     }
}

 

• whitelist = {"/", "/members/add", "/login", "/logout", "/css/*"};
  • 인증 필터를 적용해도 홈, 회원가입, 로그인 화면, css 같은 리소스에는 접근할 수 있어야 한다. 이렇게 화이트 리스트 경로는 인증과 무관하게 항상 허용한다. 화이트 리스트를 제외한 나머지 모든 경로에는 인증 체크 로직을 적용한다.
• isLoginCheckPath(requestURI)
  • 화이트 리스트를 제외한 모든 경우에 인증 체크 로직을 적용한다.
• httpResponse.sendRedirect("/login? redirectURL=" + requestURI);
  • 미인증 사용자는 로그인 화면으로 리다이렉트 한다. 그런데 로그인 이후에 다시 홈으로 이동해버리면, 원하는 경로를 다시 찾아가야 하는 불편함이 있다. 예를 들어서 상품 관리 화면을 보려고 들어갔다가 로그인 화면으로 이동하면, 로그인 이후에 다시 상품 관리 화면으로 들어가는 것이 좋다. 이런 부분이 개발자 입장에서는 좀 귀찮을 수 있어도 사용자 입장으로 보면 편리한 기능이다. 이러한 기능을 위해 현재 요청한 경로인 requestURI를 /login에 쿼리 파라미터로 함께 전달한다. 물론 /login 컨트롤러에서 로그인 성공 시 해당 경로로 이동하는 기능은 추가로 개발해야 한다.
• return;
  • 여기가 중요하다. 필터를 더는 진행하지 않는다. 이후 필터는 물론 서블릿, 컨트롤러가 더는 호출되지 않는다. 앞서 redirect를 사용했기 때문에 redirect 가 응답으로 적용되고 요청이 끝난다.

 

이제 마찬가지로 Bean으로 loginCheckFilter을 등록하고 순서를 정하고 URL 패턴을 더해주면 된다.

컨트롤러에서는 @RequestParam으로 돌아온 redirectURL만 신경써서 코드를 작성하면 된다. 그러면 우리의 로그인 여부를 체크하는 서블릿 필터가 정상적으로 등록되어 작동할 것이다.

 

 

스프링 인터셉터

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

 

스프링 인터셉터의 흐름은 아래와 같다.

 

 

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

 

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

 

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

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

 

스프링 인터셉터도 서블릿 필터와 마찬가지로 체인이 가능하다. 스프링 인터셉터도 체인으로 구성되며, 중간에 마음대로 인터셉터를 추가할 수 있는 것이다. 로그를 남기는 인터셉터를 먼저 적용하고, 로그인 여부를 체크하는 인터셉터를 이후에 넣을 수도 있다.

 

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

 

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

먼저 HandlerInterceptor 인터페이스를 살펴보자.

 

public interface HandlerInterceptor {

default boolean preHandle(HttpServletRequest request, HttpServletResponse 
response, Object handler) throws Exception {}
 
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 {}

}

 

• 서블릿 필터의 경우 단순하게 doFilter() 하나만 제공된다. 인터셉터는 컨트롤러 호출 전( preHandle ), 호출 후( postHandle ), 요청 완료 이후( afterCompletion )와 같이 단계적으로 잘 세분화되어 있다.
• 서블릿 필터의 경우 단순히 request , response 만 제공했지만, 인터셉터는 어떤 컨트롤러( handler )가 호출되는지 호출 정보도 받을 수 있다. 그리고 어떤 modelAndView 가 반환되는지 응답 정보도 받을 수 있다.

 

스프링 인터셉터 호출 흐름은 아래와 같다.

 

• preHandle : 컨트롤러 호출 전에 호출된다. (더 정확히는 핸들러 어댑터 호출 전에 호출된다.)
  • preHandle의 응답 값이 true 이면 다음으로 진행하고, false 이면 더는 진행하지 않는다. false 인 경우 나머지 인터셉터는 물론이고, 핸들러 어댑터도 호출되지 않는다. 그림에서 1번에서 끝이 나버린다.
• postHandle : 컨트롤러 호출 후에 호출된다. (더 정확히는 핸들러 어댑터 호출 후에 호출된다.)
• afterCompletion : 뷰가 렌더링 된 이후에 호출된다.

 

다음은 스프링 인터셉터 예외 상황이다.

 

예외 발생 시

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

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

 

정리하면 사실 웬만하면 인터셉터를 사용하는게 더 편리하다고 한다.

 

다음은 기본적인 요청 로그 인터셉터를 코드로 작성해보겠다.

 

@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();
         String uuid = UUID.randomUUID().toString();
         request.setAttribute(LOG_ID, uuid);
         //@RequestMapping: HandlerMethod
         //정적 리소스: ResourceHttpRequestHandler
         
     if (handler instanceof HandlerMethod) {
         HandlerMethod hm = (HandlerMethod) handler; //호출할 컨트롤러 메서드의
        모든 정보가 포함되어 있다.
         }
     log.info("REQUEST [{}][{}][{}]", uuid, requestURI, handler);
     return true; //false 진행X
     }

     @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();
     String logId = (String)request.getAttribute(LOG_ID);
     log.info("RESPONSE [{}][{}]", logId, requestURI);
     
     if (ex != null) {
         log.error("afterCompletion error!!", ex);
         }
     }
}

 

request.setAttribute(LOG_ID, uuid)

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

따라서 request 에 담아두었다. 이 값은 afterCompletion에서 request.getAttribute(LOG_ID)로 찾아서 사용한다.

 

HandlerMethod

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

 

ResourceHttpRequestHandler

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

 

postHandle, afterCompletion

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

 

 

이제 인터셉터를 등록해보겠다.

 

@Configuration
public class WebConfig implements WebMvcConfigurer {

     @Override
     public void addInterceptors(InterceptorRegistry registry) {
         registry.addInterceptor(new LogInterceptor())
         .order(1)
         .addPathPatterns("/**")
         .excludePathPatterns("/css/**", "/*.ico", "/error");
     }
 //...
}

 

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

 

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

 

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

 

이제 스프링 필터에서 사용한 인증 체크 기능을 인터셉터로 개발해보자.

 

@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);
     
     if (session == null || session.getAttribute(SessionConst.LOGIN_MEMBER)== null) {
         log.info("미인증 사용자 요청");
         //로그인으로 redirect
         response.sendRedirect("/login?redirectURL=" + requestURI);
         return false;
     }
     
     return true;
     }
}

 

서블릿 필터와 비교해서 코드가 매우 간결하다. 인증이라는 것은 컨트롤러 호출 전에만 호출되면 된다. 따라서 preHandle 만 구현하면 된다.

 

이제 등록은 마찬가지로 WebConfig 에서 registry에 addInterceptor 메서드를 사용해서 등록하면 된다. 이전에 한 인터셉터 등록과 동일하다. 다만 excludedPathPatterns만 좀 더 세심하게 설정하면 된다.

 

서블릿 필터와 스프링 인터셉터는 웹과 관련된 공통 관심사를 해결하기 위한 기술이다.

서블릿 필터와 비교해서 스프링 인터셉터가 더 편리하다. 특별한 문제없으면 인터셉터를 사용하자.

 

이상으로 포스팅을 마치겠습니다.