본문 바로가기

SPRING

김영한 - 스프링 MVC 2편 - 백엔드 웹 개발 핵심 기술 7일차

서블릿 필터

애플리케이션 여러 로직에서 공통으로 관심이 있는 것을 공통 관심사라고 한다.

공통 관심사는 스프링의 AOP로도 해결할 수 있지만, 서블릿 필터 또는 스프링 인터셉터를 사용하는 것이 좋다.

서블릿 필터나 스프링 인터센텁는 HttpServletRequest를 제공한다.

 

필터 흐름

 

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

 

필터를 적용하면 필터가 호출 된 다음에 서블릿이 호출 된다. 

필터는 특정 URL 패턴에 적용할 수 있다. /* 이라고 하면 모든 요청에 필터가 적용된다.

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

 

필터 제한

 

HTTP 요청 -> WAS -> 필터(적절 하지 않은 요청이라 판단, 서블릿 호출X) 

 

필터에서 적절하지 않은 요청이라고 판단하면 거기에서 끝을 낼 수도 있다.

 

필터 체인

 

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

 

필터는 체인으로 구성되는데, 중간에 필터를 자유롭게 추가할 수 있다.

 

필터 인터페이스

init() : 필터 초기화 메서드, 서블릿 컨테이너가 생성될 때 호출된다.

doFilter() : 고객의 요청이 올 때 마다 해당 메서드가 호출된다. 필터의 로직을 구현하면 된다.

destroy() : 필터 종료 메서드, 서블릿 컨테이너가 종료될때 호출 된다.

 

서블릿 필터 - 요청 로그

 

package hello.login.web.filter;

import lombok.extern.slf4j.Slf4j;

import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.util.UUID;

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

 

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

 

chain.doFilter(request, response);

다음 필터가 있으면 필터를 호출하고, 필터가 없으면 서블릿을 호출한다.

이 로직을 호출하지 않으면 다음 단계로 진행되지 않는다.

 

WebConfig - 필터 설정

 

@Bean
public FilterRegistrationBean logFilter() {
    FilterRegistrationBean<Filter> filterRegistrationBean = new FilterRegistrationBean<>();

    filterRegistrationBean.setFilter(new LogFilter());
    filterRegistrationBean.setOrder(1);
    filterRegistrationBean.addUrlPatterns("/*");

    return filterRegistrationBean;
}

스프링 부트를 사용한다면 FilterRegistrationBean을 사용해서 등록하면 된다.

setFilter() : 등록할 필터를 지정한다.

setOrder(1) : 필터는 체인으로 동작한다. 따라서 순서가 필요한데 낮을 수록 먼저 동작한다.

addUrlPatterns() : 필터를 적용할 URL 패턴을 지정한다.

 

서블릿 필터 - 인증 체크

 

package hello.login.web.filter;

import hello.login.web.SessionConst;
import lombok.extern.slf4j.Slf4j;
import org.springframework.util.PatternMatchUtils;

import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import java.io.IOException;

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

인증 필터를 적용해도 홈, 회원가입 , 로그인 화면, css 같은 리소스에는 접근할 수 있어야 한다.

화이트 리스트 경로는 인증과 무관하게 항상 허용한다. 

 

isLoginCheckPath(requestURI)

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

 

httpResponse.sendRedirect();

미인증 사용자는 로그인 화면으로 리다이렉트한다. 

 

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

 

 RedirectURL 처리

 

    @PostMapping("/login")
    public String loginV4(@Valid @ModelAttribute LoginForm form, BindingResult
            bindingResult, HttpServletRequest request , @RequestParam(defaultValue = "/") String redirectURL) {
        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);

        //세션 관리자를 통해 세션을 생성하고, 회원 데이터 보관
//        sessionManager.createSession(loginMember, response);
        return "redirect:" + redirectURL;
    }

 

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

 

 

필터에는 스프링 인터셉터에 제공하지 않는 기능이 있다.

chain.doFilter(request, response) 를 호출해서 다음 필터 또는 서블릿을 호출할 때 request , response를 다른 객체로 바꿀 수 있다. ServletRequest , ServletResponse 를 구현한 다른 객체를 만들어서 넘기면 해당 객체가 다음 필터 또는 서블릿에서 사용된다.

 

스프링 인터셉터 - 소개

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

서블릿 필터가 서블릿이 제공하는 기술이라면, 스프링 인터셉터는 스프링 MVC가 제공하는 기술이다.

 

스프링 인터셉터 흐름

 

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

 

스프링 인터셉터는 디스패처 서블릿과 컨트롤러 사이에서 컨트롤러 호출 직전에 호출 된다.

스프링 인터셉터는 스프링 MVC가 제공하는 기능이기 때문에 결국 디스패처 서블릿 이후에 등장하게 된다.

 

스프링 인터셉터 제한

 

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

 

스프링 인터셉터 체인

 

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

 

스프링 인터셉터는 체인으로 구성되는데, 중간에 인터셉터를 자유롭게 추가할 수 있다. 

 

스프링 인터셉터 호출 흐름

 

preHandle : 컨트롤러 호출 전에 호출된다.

preHandle의 응답값이 true 이면 다음으로 진행하고, false이면 더는 진행하지 않는다.

false인 경우 나머지 인터셉터는 물론이고, 핸들러 어댑터도 호출되지 않는다.

postHandle : 컨트롤러 호출 후에 호출된다.

afterCompletion : 뷰가 렌더링 된 이후에 호출된다.

 

예외 발생시

 

postHandle : 컨트롤러에서 예외가 발생하면 postHandle은 호출되지 않는다.

afterCompletion : afterCompletion은 항상 호출된다. 

 

예외가 발생하면 postHandle은 호출되지 않으므로 예외와 무관하게 공통 처리를 하려면 afterCompletion()을 사용해야한다. 

 

스프링 인터셉터 - 요청 로그

 

package hello.login.web.interceptor;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.UUID;

@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("postHandle [{}]", modelAndView);
    }

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

        log.info("RESPONSE [{}][{}][{}]", logId, requestURI, handler);
        if ( ex != null) {
            log.error("afterCompletion error!!", ex);
        }
    }
}

 

return true

true 면 정상 호출이다. 다음 인터셉터나 컨트롤러가 호출된다.

 

if(handler instanceof HandlerMethod) {
    HandlerMethod hm = (HandlerMethod) handler;
}

 

HandlerMethod

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

 

ResourceHttpRequestHandler

@Controller 가 아니라 /resource/static와 같은 정적 리소스 호출 되는 경우 

ResourceHttpRequestHandler가 핸들러 정보로 넘어오기 때문에 타입에 따라서 처리가 필요하다.

 

WebConfig - 인터셉터 등록

 

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

 

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

registry.addInterceptor() : 인터셉터를 등록한다.

order(1): 인터셉터의 호출 순서를 지정한다.

addPathPatterns(): 인터셉터를 적용할 URL 패턴을 지정한다.

excludePathPatterns(): 인터셉터에서 제외할 패턴을 지정한다.

 

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

 

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

 

package hello.login.web.interceptor;

import hello.login.web.SessionConst;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.servlet.HandlerInterceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

@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 만 구현 하면 된다.

 

@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에 작성하면 된다.

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

 

ArugumentResolver 활용

ArugumentResolver 기능을 사용해서 로그인 회원을 조금 편리하게 바꿔 보았다.

public String homeLoginV3Spring(@SessionAttribute(name = SessionConst.LOGIN_MEMBER,required = false) Member member, Model model) {


    //세션에 회원 데이터가  없으면 home
    if(member == null) {
        return "home";
    }

    //세션이 유지되면 로그인으로 이동
    model.addAttribute("member", member);
    return "loginHome";
}
@GetMapping("/")
public String homeLoginV3ArgumentResolver(@Login Member member, Model model) {


    //세션에 회원 데이터가  없으면 home
    if(member == null) {
        return "home";
    }

    //세션이 유지되면 로그인으로 이동
    model.addAttribute("member", member);
    return "loginHome";
}

 

@Login 애노테이션이 있으면 직접 만든 ArgumentResolver가 동작해서 자도으로 세션에 있는 로그인 회원을

찾아주고, 만약 세션에 없다면 null을 반환하도록 수정했다.

 

package hello.login.web.argumentResolver;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

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

@Target(ElementType.PARAMETER) : 파라미터에만 사용

@Retention(RetentionPolicy.RUNTIME) : 리플렉션 등을 활용할 수 있도록 런타임까지 애노테이션 정보가 남아있음.

 

package hello.login.web.argumentResolver;

import hello.login.domain.member.Member;
import hello.login.web.SessionConst;
import lombok.extern.slf4j.Slf4j;
import org.springframework.core.MethodParameter;
import org.springframework.web.bind.support.WebDataBinderFactory;
import org.springframework.web.context.request.NativeWebRequest;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.method.support.ModelAndViewContainer;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;

@Slf4j
public class LoginMemberArgumentResolver implements HandlerMethodArgumentResolver {

    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        log.info("supportsParameter 실행");

        boolean hasParameterAnnotation = parameter.hasParameterAnnotation(Login.class);
        boolean hasMemberType = Member.class.isAssignableFrom(parameter.getParameterType());

        return hasParameterAnnotation && 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() : 컨트롤러 호출 직전에 호출 되어서 필요한 파라미터 정보를 생성해준다. 여기서는 세션에 있는 로그인 회원 정보인 memer 객체를 찾아서 반환해준다. 이후 스프링 MVC는 컨트롤러의 메서드를 호출하면서 여기에서 반환된 member 객체를 파라미터에 전달해준다.

 

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

LoginMemberArgumentResolver 를 등록 하였다.

 

출처

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