Link Search Menu Expand Document

7. 로그인 처리2 - 필터, 인터셉터

서블릿 필터

공통 관심사(cross-cutting concern)

  • 애플리케이션 여러 로직에서 공통으로 관심이 있는 것
    • 상품관리의 모든 컨트롤러 로직에 공통으로 로그인 여부를 확인
    • 로그인과 관련된 로직이 변경될 경우 작성한 모든 로직을 다 수정해야 함
  • 스프링 AOP 대신 서블릿 필터 또는 스프링 인터셉터를 사용하여 해결

필터 흐름

HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 컨트롤러
  • 필터가 호출 된 다음에 서블릿이 호출
  • 필터는 특정 URL 패턴에 적용할 수 있음
    • /*이라고 하면 모든 요청에 필터가 적용
  • 프링을 사용하는 경우 여기서 말하는 서블릿은 스프링의 디스패처 서블릿

필터 제한

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

필터 체인

HTTP 요청 -> WAS -> 필터1 -> 필터2 -> 필터3 -> 서블릿 -> 컨트롤러
  • 필터는 체인으로 구성되는데, 중간에 필터를 자유롭게 추가할 수 있음
  • 로그를 남기는 필터를 먼저 적용하고, 그 다음에 로그인 여부를 체크하는 필터를 추가할 수 있음

필터 인터페이스

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(): 필터 종료 메서드, 서블릿 컨테이너가 종료될 때 호출

요청 로그 필터

LogFilter - 로그 필터

@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");
    }
}
  • 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);
    • uuidrequestURI를 출력
  • chain.doFilter(request, response);
    • 다음 필터가 있으면 필터를 호출하고, 필터가 없으면 서블릿을 호출
    • 만약 이 로직을 호출하지 않으면 다음 단계로 진행되지 않음

WebConfig - 필터 설정

@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 패턴을 지정. 한번에 여러 패턴을 지정 가능

참고 URL 패턴에 대한 룰은 필터도 서블릿과 동일하다. 자세한 내용은 서블릿 URL 패턴으로 검색해보자.

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

참고 실무에서 HTTP 요청시 같은 요청의 로그에 모두 같은 식별자를 자동으로 남기는 방법은 logback mdc로 검색해보자.

인증 체크 필터

LoginCheckFilter - 인증 체크 필터

@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가 응답으로 적용되고 요청이 끝남

WebConfig - loginCheckFilter() 추가

@Bean
public FilterRegistrationBean loginCheckFilter() {
    FilterRegistrationBean<Filter> filterRegistrationBean = new FilterRegistrationBean<>();
    filterRegistrationBean.setFilter(new LoginCheckFilter());
    filterRegistrationBean.setOrder(2);
    filterRegistrationBean.addUrlPatterns("/*");
    return filterRegistrationBean;
}
  • setFilter(new LoginCheckFilter()): 로그인 필터를 등록
  • setOrder(2): 로그 필터 다음에 로그인 필터가 적용
  • addUrlPatterns("/*"): 모든 요청에 로그인 필터를 적용

LoginController - loginV4()

/**
* 로그인 이후 redirect 처리
*/
@PostMapping("/login")
public String loginV4(
  @Valid @ModelAttribute LoginForm form, BindingResult bindingResult,
  @RequestParam(defaultValue = "/") String redirectURL,
  HttpServletRequest request) {
  
    if (bindingResult.hasErrors()) {
        return "login/loginForm";
    }
  
    Member loginMember = loginService.login(form.getLoginId(), form.getPassword());
    log.info("login? {}", loginMember);
  
    if (loginMember == null) {
        bindingResult.reject("loginFail", "아이디 또는 비밀번호가 맞지 않습니다.");
        return "login/loginForm";
    }
  
    //로그인 성공 처리
  
    //세션이 있으면 있는 세션 반환, 없으면 신규 세션 생성
    HttpSession session = request.getSession();
    //세션에 로그인 회원 정보 보관
    session.setAttribute(SessionConst.LOGIN_MEMBER, loginMember);
  
    //redirectURL 적용
    return "redirect:" + redirectURL;
}
  • 로그인 체크 필터에서, 미인증 사용자는 요청 경로를 포함해서 /loginredirectURL 요청 파라미터를 추가해서 요청. 이 값을 사용해서 로그인 성공시 해당 경로로 고객을 redirect

참고 필터에는 다음에 설명할 스프링 인터셉터는 제공하지 않는, 아주 강력한 기능이 있는데 chain.doFilter(request, response);를 호출해서 다음 필터 또는 서블릿을 호출할 때 request, response를 다른 객체로 바꿀 수 있다. ServletRequest, ServletResponse를 구현한 다른 객체를 만들어서 넘기면 해당 객체가 다음 필터 또는 서블릿에서 사용된다. 잘 사용하는 기능은 아니니 참고만 해두자.

스프링 인터셉터

스프링 인터셉터 흐름

HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 스프링 인터셉터 -> 컨트롤러
  • 스프링 인터셉터는 디스패처 서블릿과 컨트롤러 사이에서 컨트롤러 호출 직전에 호출됨
  • 스프링 인터셉터는 스프링 MVC가 제공하는 기능이기 때문에 결국 디스패처 서블릿 이후에 등장
  • 스프링 인터셉터에도 URL 패턴을 적용할 수 있는데, 서블릿 URL 패턴과는 다르고, 매우 정밀하게 설정 가능

스프링 인터셉터 제한

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

스프링 인터셉터 체인

HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 인터셉터1 -> 인터셉터2 -> 컨트롤러
  • 스프링 인터셉터는 체인으로 구성되는데, 중간에 인터셉터를 자유롭게 추가할 수 있음
  • 지금까지 내용을 보면 서블릿 필터와 호출 되는 순서만 다르고, 제공하는 기능은 비슷해 보이지만 스프링 인터셉터는 서블릿 필터보다 편리하고, 더 정교하고 다양한 기능을 지원

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

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 가 반환되는지 응답 정보도 받을 수 있음

스프링 인터셉터 호출 흐름

로그인 처리2 - 필터, 인터셉터 - 01 스프링 인터셉터

정상 흐름

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

스프링 인터셉터 예외 상황

로그인 처리2 - 필터, 인터셉터 - 02 스프링 인터셉터

예외가 발생시

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

afterCompletion은 예외가 발생해도 호출됨

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

요청 로그 인터셉터

LogInterceptor - 요청 로그 인터셉터

@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);
        }
    }
}
  • String uuid = UUID.randomUUID().toString()
    • 요청 로그를 구분하기 위한 uuid를 생성
  • request.setAttribute(LOG_ID, uuid)
    • 서블릿 필터의 경우 지역변수로 해결이 가능하지만, 스프링 인터셉터는 호출 시점이 완전히 분리되어 있음. 따라서 preHandle에서 지정한 값을 postHandle, afterCompletion에서 함께 사용하려면 어딘가에 저장해야 함. LogInterceptor도 싱글톤 처럼 사용되기 때문에 맴버변수를 사용하면 위험. 따라서 request에 저장. 이 값은 afterCompletion에서 request.getAttribute(LOG_ID)로 찾아서 사용
  • return true
    • true면 정상 호출이므로 다음 인터셉터나 컨트롤러가 호출됨
if (handler instanceof HandlerMethod) {
    HandlerMethod hm = (HandlerMethod) handler; //호출할 컨트롤러 메서드의 모든 정보가 포함되어 있다.
}

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

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

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

WebConfig - 인터셉터 등록

@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 패턴을 지정 가능

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

인증 체크 인터셉터

LoginCheckInterceptor

@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;
    }
}

순서 주의, 세밀한 설정 가능

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

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

인터셉터를 적용하거나 하지 않을 부분은 addPathPatternsexcludePathPatterns에 작성하면

ArgumentResolver 활용

HomeController - 추가

@GetMapping("/")
public String homeLoginV3ArgumentResolver(@Login Member loginMember, Modelmodel) {
  
    //세션에 회원 데이터가 없으면 home
    if (loginMember == null) {
        return "home";
    }
  
    //세션이 유지되면 로그인으로 이동
    model.addAttribute("member", loginMember);
    return "loginHome";
}

@Login 애노테이션이 있으면 직접 만든 ArgumentResolver가 동작해서 자동으로 세션에 있는 로그인 회원을 찾아주고, 만약 세션에 없다면 null을 반환

@Login 애노테이션 생성

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface Login {
}
  • @Target(ElementType.PARAMETER): 파라미터에만 사용
  • @Retention(RetentionPolicy.RUNTIME): 리플렉션 등을 활용할 수 있도록 런타임까지 애노테이션 정보가 남아있음

LoginMemberArgumentResolver 생성

@Slf4j
public class LoginMemberArgumentResolver implements
HandlerMethodArgumentResolver {
  
    @Override
    public boolean supportsParameter(MethodParameter parameter) {
      
        log.info("supportsParameter 실행");
      
        boolean hasLoginAnnotation =        parameter.hasParameterAnnotation(Login.class);
        boolean hasMemberType = Member.class.isAssignableFrom(parameter.getParameterType());
      
        return hasLoginAnnotation && hasMemberType;
    }
  
    @Override
    public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
      
      //  log.info("resolveArgument 실행");

        HttpServletRequest request = (HttpServletRequest) webRequest.getNativeRequest();
        HttpSession session = request.getSession(false);
        if (session == null) {
            return null;
        }

        return session.getAttribute(SessionConst.LOGIN_MEMBER);
    }
}
  • supportsParameter(): @Login 애노테이션이 있으면서 Member 타입이면 해당 ArgumentResolver가 사용됨
  • resolveArgument() : 컨트롤러 호출 직전에 호출 되어서 필요한 파라미터 정보를 생성. 여기서는 세션에 있는 로그인 회원 정보인 member 객체를 찾아서 반환. 이후 스프링MVC는 컨트롤러의 메서드를 호출하면서 여기에서 반환된 member 객체를 파라미터에 전달

WebMvcConfigurer에 설정 추가

@Configuration
public class WebConfig implements WebMvcConfigurer {
  
    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
        resolvers.add(new LoginMemberArgumentResolver());
    }
    //...
}