[Spring] Servlet Filter, Spring Interceptor(서블릿 필터, 스프링 인터셉터)

Servlet Filter

1. 공통 관심 사항(Cross-cutting Concern)

• 애플리케이션 여러 로직에서 공통으로 관심이 있는 것을 의미한다. 예를 들어, 인증과 권한 확인은 여러 웹 페이지나 기능에서 반복적으로 처리해야하는 공통 관심시가 될 수 있다.
• 로그인하지 않은 사용자도 특정 URL로 직접 접근 가능하다면 문제가 발생한다.
• 이런 공통적인 로직을 모든 컨트롤러나 서비스에서 반복적으로 구현하는 것은 유지보수의 어려움을 가져온다.

2. 서블릿 필터의 도입 

• 서블릿 필터는 웹 애플리케이션에서 반복되는 공통 관심사를 처리하기 위한 기능이다.
• 웹 요청이 들어올 때 필터를 거쳐 해당 로직(로그인 확인)을 처리하고, 그 후 실제 서비스 로직(컨트롤러)를 수행한다.

 

3. 필터의 작동 흐름

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

HTTP 요청이 들어오면, WAS는 먼저 필터를 통과시키고, 필터의 로직 후에 서블릿(Spring Dispatcher Servlet)를 호출한다.

 

4. 필터 체인

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

필터는 특정 URL 패턴에 따라 적용될 수 있으며, 필터 체인 구조를 통해 여러 필터를 순차적으로 적용할 수 있다.

 

5. 필터의 특성

• 필터를 사용하면 로그인 뿐만 아니라 로그 기록, 인코딩, 보안 등 여러 가지 웹 관련된 사전/사후 처리 작업을 할 수 있따.
• 필터가 요청을 적절하다고 판단하면 다음 필터나 서블릿으로 요청을 전달하고, 적절하지 않다고 판단하면 요청을 중단 시킬 수 도 있다.
• 필터는 'Filter Interface' 를 구현하여 사용한다. 이 인터페이스에는 'init(), doFilter(), destroy()' 세 가지 메서드가 정의 되어 있다.

 

6. Filter Interface

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() : 클라이언트의 모든 요청에서 호출되는 메서드로, 필터의 주 로직을 구현한다.
• destory() : 필터가 종료될 때 호출되는 메서드, 자원 해제와 관련된 작업을 수행한다.

---

서블릿 필터 - 요청 로그

 

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

        HttpServletRequest httpServlet = (HttpServletRequest) request;
        String requestURI = httpServlet.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 

• 필터를 사용하려면 Filter Interface 를 구현해야 한다.

doFilter(ServletRequest request, ServletResponse response, FilterChain chain)

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

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

• HTTP 요청을 구분하기 위해 요청당 임의의 uuid 를 생성해둔다.

log.info("REQUEST [{}][{}]", uuid, requestURI);

• uuid와 requestURI 를 출력한다.

chain.doFilter(request, respons);

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

---

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 패턴을 지정한다. 한번에 여러 패턴을 지정할 수 있다.

 

실행 로그

hello.login.web.filter.LogFilter  : log filter doFilter
hello.login.web.filter.LogFilter  : REQUEST [b5678707-a17f-493f-ba38-4467848c758e}[/]
hello.login.web.filter.LogFilter  : RESPONSE [b5678707-a17f-493f-ba38-4467848c758e][/]

필터를 등록할 때 urlPattern 을 /* 로 등록했기 때문에 모든 요청에 해당 필터가 적용된다.

---

서블릿 필터 - 인증 체크

인증 체크는 웹 애플리케이션에서 특정 리소스에 대한 접근을 제한 하기위해 사용된다. 이로 인해 로그인 되지 않는 사용자는 상품 관리, 글 쓰기 뿐만 아니라, 향 후 개발될 페이지에도 접근하지 못하도록 한다.

 

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

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

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

isLoginCheckPath(requlestURI)

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

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

• 미 인증 사용자는 로그인 화면으로 리다이렉트 한다. 그런데 로그인 이후에 다시 홈으로 이동할 경우, 사용자가 원하는 경로를 다시 찾아가야 하는 불편함이 있다. 로그인 이후에 다시 원하는 경로로 돌아가기위한 기능으로 현재 요청한 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) : 순서를 2번으로, 로그 필터 다음에 로그인 필터가 적용된다.
• addUrlPatterns("/*") : 모든 요청에 로그인 필터를 적용한다.

 

RedirectURL 처리 - LoginController

@PostMapping("login")
public String loginV4(@Validated @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());

    if (loginMember == null) {
        bindingResult.reject("loginFail", "아이디 또는 비밀번호가 틀립니다.");
        return "login/loginForm";
    }

    //로그인 성공 처리
    //세션이 있으면 있는 세션 반환, 없으면 신규 세션을 생성
    HttpSession session = request.getSession();
    //세션에 로그인 회원 정보 보관
    session.setAttribute(SessionConst.LOGIN_MEMBER, loginMember);

    return "redirect:" + redirectURL;
}

로그인 필터에서, 미 인증 사용자는 요청 경로를 포함해서 /login 에 redirectURL 요청 파라미터를 추가해서 요청한다. 이 값을 사용해서 로그인 성공시 해당 경로로 고객을 redirect 한다.

---

Spring Interceptor

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

 

스프링 인터셉터 흐름

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

 

Spring Interceptor Interface

스프링의 인터셉터를 사용하려면 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 : 컨트롤러에서 예외가 발생하면, 호출되지 않는다.

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

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

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        String requestURI = request.getRequestURI();
        Object uuid = (String) request.getAttribute(LOG_ID);

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

        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 패턴을 지정할 수 있다.

 

실행 로그

h.login.web.interceptor.LogInterceptor : REQUEST [44970a57-9572-4eb9-b625-9d4f2ce12baa][/][hello.login.web.HomeController#homeLoginV3Spring(Member, Model)]
h.login.web.interceptor.LogInterceptor : postHandler [ModelAndView [view="loginHome"; model={member=Member(id=1, loginId=test, name=스프링, password=1234!), org.springframework.validation.BindingResult.member=org.springframework.validation.BeanPropertyBindingResult: 0 errors}]]
h.login.web.interceptor.LogInterceptor : RESPONSE [44970a57-9572-4eb9-b625-9d4f2ce12baa][/][hello.login.web.HomeController#homeLoginV3Spring(Member, Model)]

---

Pathpattern 공식문서

PathPattern (Spring Framework 6.0.12 API)

---

스프링 인터셉터 - 인증 체크

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();

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

        return true;
    }
}

인증은 컨트롤러 호출 전에 호출되면 된다. 따라서 preHandle만 구현하면 된다.

 

WebConfig

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

인터셉터를 적용하거나 하지 않을 부분을 addPathPatterns와 excludePathPatterns에 작성하면 된다.

기본적으로 모든 경로에 해당 인터셉터를 적용하되(/**), 홈(/), 회원가입(/member/add), 로그인(/login), 리소스 조회(/css/**), 오류(/error)와 같은 부분은 로그인 체크 인터셉터를 적용하지 않는다.

 

 

 

출처 : 인프런 - 🔗 스프링 MVC 2 - 백엔드 개발 활용 기술by 우아한형제 김영한님