[Spring Boot] OncePerRequestFilter란?

 

 

 

🚀 OncePerRequestFilter

    🔽  개요

        📦 Filter와 OncePerRequestFilter 차이

Filter에 대해 설명한 내용은 이 곳을 통해 준비해 두었어요.

OncePerRequestFilter Class는 이름에서 알 수 있듯 Http Request의 한 번의 요청에 대해 한 번만 실행하는 Filter에요.

예를 들어 Forwarding이 발생하면 Filter Chain이 다시 동작하여 인증처럼 딱 한번만 해야 하는 Logic이 불필요하게 여러번 수행될 수 있어요.

반응형

포워딩 과정

        📦 doFilter()

doFilter()는 최초 실행 시 ServletRequest 객체에 자신의 이름과 수행하였을음 표시가히 위한 Boolean의 true 값을 함께 넣어 두어요. 그런 뒤 doFilterInternal()을 통해 자신의 기능을 수행 한답니다.

리다이렉트 등으로 다시 실행되는 경우 이 전 수행에서 요청 객체에 담아뒀던 수행 여부를 확인하게 되고, 이미 수행되었다고 표시가 되면 Filter Chain에게 요청과 응답 객체를 전달해 주는 방식으로 동작해요.

public abstract class OncePerRequestFilter extends GenericFilterBean {

    public final void doFilter(ServletRequest request, ServletResponse response, FilterChain filterChain) throws ServletException, IOException {
        if (request instanceof HttpServletRequest && response instanceof HttpServletResponse) {
            HttpServletRequest httpRequest = (HttpServletRequest)request;
            HttpServletResponse httpResponse = (HttpServletResponse)response;
            String alreadyFilteredAttributeName = this.getAlreadyFilteredAttributeName();
            boolean hasAlreadyFilteredAttribute = request.getAttribute(alreadyFilteredAttributeName) != null;
            if (!this.skipDispatch(httpRequest) && !this.shouldNotFilter(httpRequest)) {
                if (hasAlreadyFilteredAttribute) {
                    if (DispatcherType.ERROR.equals(request.getDispatcherType())) {
                        this.doFilterNestedErrorDispatch(httpRequest, httpResponse, filterChain);
                        return;
                    }
                    filterChain.doFilter(request, response);
                } else {
                    request.setAttribute(alreadyFilteredAttributeName, Boolean.TRUE);
                    try {
                        this.doFilterInternal(httpRequest, httpResponse, filterChain);
                    } finally {
                        request.removeAttribute(alreadyFilteredAttributeName);
                    }
                }
            } else {
                filterChain.doFilter(request, response);
            }
        } else {
            throw new ServletException("OncePerRequestFilter just supports HTTP requests");
        }
    }
}

728x90

즉, 어느 Filter에서 Header를 확인 한 뒤 특정 URL로 Forwarding 한다고 할 때, 예외가 발생하지 않았다면 URL로 포워딩 시키는 것 자체가 서블릿 실행 중 요청이 올 것이에요.

OncePerRequestFilter를 사용하지 않는다면 앞에서 거친 Filter를 또 거치게 되고, 자원 낭비를 하는 셈이 되어 버려요.

이 때, 동일한 요청안에서 한번만 Filtering 할 수 있게 해 주는 것이 OncePerRequestFilter의 역할이며, 인증 또는 인가와 같이 한번만 거쳐야 하는 Logic에 많이 사용된답니다.

인증, 인가를 거치고 특정 URL로 포워딩하면 요청이 들어왔으니 인증, 인가 Filter를 다시 실행 시켜야 하지만, OncePerRequestFilter를 이용하면 인증, 인가를 한번만 거치고 바로 다음 Logic을 진행할 수 있도록 사용할 수 있어요.