로그인 필터와 인터셉터

웹에서의 공통 관심사항 처리하기

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

이러한 공통 관심사는 스프링의 AOP로도 해결할 수 있지만, 웹과 관련된 공통 관심사는 지금부터 설명할 서블릿 필터, 스프링 인터셉터를 사용하는 것이 좋다. 웹과 관련된 공통 관심사를 처리할 때는 HTTP의 헤더나 URL의 정보들이 필요하고, 서블릿 필터나 스프링 인터셉터는 HttpServletRequest를 제공한다.

서블릿 필터

서블릿 필터 설정

서블릿 필터의 동작 흐름은 아래와 같다.

필터 흐름
Http 요청 → WAS → 필터 → 서블릿 → 컨트롤러
필터 제한
Http 요청 → WAS → 필터(인가받지 않은 사용자는 서블릿 호출 x)

@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 {
        log.info("log filter doFilter");

        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");
    }
}

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

• init(): 필터 초기화 메서드(서블릿 컨테이너 생성시 호출)
• doFilter(): 고객의 요청이 올 때 마다 해당 메서드가 호출(필터 로직 구현 부분)
• destroy(): 필터 종료 메서드(서블릿 컨테이너 종료시 호출)

chain.doFilter(request, response)를 통하여 다음 필터가 있으면 필터를 호출하고, 필터가 없으면 서블릿을 호출한다. 만약 이 로직이 호출되지 않으면 다음 단계로 진행이 불가능하다.

서블릿 필터를 등록하기

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

우선 @Configuration을 통해 빈으로 등록을 해준다. 스프링 부트를 사용한다면 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);
                    //로그인으로 리다이렉트
                    httpResponse.sendRedirect("/login?redirectURL=" + requestURI);
                    return;
                }
            }
            chain.doFilter(request, response);

        } catch (Exception e) {
            throw e;
        } finally {
            log.info("인증 체크 필터 종료 {}", requestURI);
        }
    }

    /**
     * whiteList의 경우 인증 체크를 안하도록 한다.
     */
    private boolean isLoginCheckPath(String requestURI) {
        return !PatternMatchUtils.simpleMatch(whitelist, requestURI);
    }

}

• private static final String[] whitelist = {"/", "/members/add", ...};

모든 곳에 로그인이 되어있어야 하는건 아니다. 정적 리소스와 로그인, 로그아웃의 경우 로그인을 하지 않아도 접근이 가능해야 한다. 이 화이트리스트를 이용해 이러한 경로 검사를 해 준다.

• isLoginCheckPath(String requestURI)

매개변수로 전달받은 requestURI가 화이트리스트와 일치하는지 검사한다. 이때 PatternMatchUtils라는 정적 헬퍼 클래스를 이용하여 쉽게 경로 검사가 가능하다.

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

로그인을 안했는데 로그인이 필요한 페이지에 접근시 로그인 페이지로 이동시키는건 알기 쉽다. 그런데 redirectURL이라고 queryString을 작성하고 있다. 이게 같이 작성 된 이유는 예를들어 내가 내가 등록한 상품 목록 페이지에 접근하려는 상황에서 로그인이 안되어 있어 로그인 페이지로 이동했다고 가정할 때 로그인을 하면 어디로 이동시킬 것인가? 별 생각을 하지 않는다면 그냥 메인 페이지를 얘기할 수 있지만, 내가 원래 접근하려는 페이지로 다시 이동시켜주면 사용자 입장에선 편리할 것이다.

• return

필터는 더는 진행하지 않는다. redirect를 사용했기에 redirect가 응답으로 적용되고 요청이 끝난다.

서블릿 필터를 등록하기 2

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

WebConfig에 loginCheckFilter()를 동록하여 로그인 사용자만 들어올 수 있는 필터를 등록시켜준다.

스프링 인터셉터

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

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

요청 흐름
Http 요청 → WAS → 필터 → 서블릿 → 스프링 인터셉터 → 컨트롤러
요청 제한
Http 요청 → WAS → 필터 → 서블릿 → 스프링 인터셉터(인가받지 않은 요청이면 컨트롤러 호출 x)

스프링 인터셉터는 dispatcher servlet과 컨트롤러 사이에서 호출된다. 스프링 MVC가 제공하는 기능이기 때문에 결국 dispatcher servlet이후에 등장하게 되는 것이다.

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 {
	}
}

인터셉터를 사용하기 위해서는 HandlerInterceptor 인터페이스를 구현해야 한다.

• preHandle : 컨트롤러 호출 전에 호출(응답값이 true면 다음 진행, false면 진행하지 않음)
• postHandle : 컨트롤러 호출 후에 호출 (정확히는 핸들러 어댑터 후)
• afterCompletion : 뷰가 렌더링 된 이후에 호출

• postHandle : 컨트롤러에서 예외가 발생하면 postHandle은 호출되지 않음
• afterCompletion : 예외를 파라미터로 받아 어떤 예외가 발생했는지 알 수 있음

스프링 인터셉터 구현

@Slf4j
public class LoginInterceptor 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;
    }

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

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        String requestURI = request.getRequestURI();
        String uuid = (String) request.getAttribute(LOG_ID);
        log.info("RESPONSE [{}][{}][{}]", uuid, requestURI, handler);

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

• request.setAttribute(LOG_ID, uuid)

서블릿 필터의 경우 지역변수로 해결이 가능하지만, 스프링 인터셉터는 호출 시점이 완전히 분리되어 있어서 preHandle에서 지정한 값을 postHandle, afterCompletion에서 함께 사용하려면 어딘가에 담아두어야 한다. 그러기위해 request에 담아두어 afterCompletion에서 reqeust.getAttribute(LOG_ID)로 가지고 온다.

• HandlerMethod hm = (HandlerMethod) handler

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

인터셉터 등록

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

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

• registry.addInterceptor(new LogInterceptor()) : 인터셉터 등록
• order(1) : 인터셉터 호출 순서 지정(낮을 수록 먼저 호출)

인터셉터 인증 체크

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

session이 null이거나 LoginMember가 아니라면 redirect로 보낸다.

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

필터에서 진행한 것처럼 인터셉터에 로그인 사용자만 이용할 수 있는 인터셉터를 등록시켜 준다.

ArgumentResolver

ArgumentResolver 구현하기

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface Login {
}

• @Target(ElementType.PARAMETER) : 파라미터에만 사용
• @Retention(RetentionPolicy.RUNTIME) : 리플렉션 등을 활용할 수 있도록 런타임 시점까지 어노테이션을 활용하기 위해 등록

@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("resolverArgument 실행");

        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 객체를 찾아서 반환)

LoginMemberArgumentResolver 등록

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
        resolvers.add(new LoginMemberArgumentResolver());
    }