서블릿 필터

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

요청 로그

@Slf4j
public class LogFilter implements Filter {

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

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

uuid 와 requestURI 를 출력한다.

chain.doFilter(request, response);

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

필터 등록

@Configuration
public class WebConfig {
 @Bean
 public FilterRegistrationBean logFilter() {
 FilterRegistrationBean<Filter> filterRegistrationBean = newFilterRegistrationBean<>();
 filterRegistrationBean.setFilter(new LogFilter()); //필터 지정
 filterRegistrationBean.setOrder(1); //필터 순서
 filterRegistrationBean.addUrlPatterns("/*");  //필터를 적용할 URL 패턴 지정. 여러개 가능.
 return filterRegistrationBean;
 }
}

인증 체크

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

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

서블릿 필터를 잘 사용한 덕분에 로그인 하지 않은 사용자는 나머지 경로에 들어갈 수 없게 되었다.

공통 관심사를 서블릿 필터를 사용해서 해결한 덕분에 향후 로그인 관련 정책이 변경되어도 이 부분만 변경하면 된다.

스프링 인터셉터

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

스프링 인터셉터 흐름

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

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

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

스프링 MVC의 시작점이 디스패처 서블릿이라고 생각해보면 이해가 될 것이다.

스프링 인터셉터에도 URL 패턴을 적용할 수 있는데, 서블릿 URL 패턴과는 다르고, 매우 정밀하게 설정할 수 있다.

인터셉터는 스프링 MVC 구조에 특화된 필터 기능을 제공. 특별히 필터를 꼭 사용해야 하는 상황이 아니라면 인터셉터를 사용하는 것이 더 편리하다.

요청 로그

@Slf4j
@Controller
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();
        //스프링 인터셉터는 호출 시점이 완전히 분리되어서 postHandle , afterCompletion 에서 함께 사용하려면
        //어딘가에 담아두어야 한다.
        request.setAttribute(LOG_ID, uuid);

        //@RequstMaaping:HandlerMethod
        //정적 리소스: ResourceHttpRequestHandler
        if(handler instanceof HandlerMethod){
            //호출할 컨트롤러 메서드의 모든 정보가 포함되어 있다.
            HandlerMethod hm = (HandlerMethod) handler;
        }
        log.info("REQUST  [{}][{}][{}]", uuid,requestURI,handler);
        return true;    //false시 진행 X
    }

    @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();
        String logId = (String) request.getAttribute(LOG_ID);
        log.info("RESPONSE  [{}][{}]",logId,requestURI);
        if (ex != null){
            log.error("afterCompletion error!!",ex);
        }
    }
}

HandlerMethod

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

ResourceHttpRequestHandler

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

postHandle, afterCompletion

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

인증 체크

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

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

인터셉트 등록

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LogInterceptor()) //인터셉트 등록
                .order(1)
                .addPathPatterns("/**") //슬래쉬 하위 전부 다
                .excludePathPatterns("/css/**","/*.ico","/error");  //whiteList를 따로 생성할 필요 없음.

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

ArgumentResolver

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

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

@Login 어노테이션 생성

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

@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();
        if (session == null){
            return null;
        }
        return session.getAttribute(SessionConst.LOGIN_MEMBER);
    }
}

supportsParameter() :

@Login 애노테이션이 있으면서 Member 타입이면 해당 ArgumentResolver가 사용된다.

resolveArgument() :

컨트롤러 호출 직전에 호출 되어서 필요한 파라미터 정보를 생성해준다. 여기서 는 세션에 있는 로그인 회원 정보인 member 객체를 찾아서 반환해준다. 이후 스프링MVC는 컨트롤러의 메서드를 호출하면서 여기에서 반환 된 member 객체를 파라미터에 전달해준다.

ArgumentResolver를 활용하면 공통 작업이 필요할 때 컨트롤러를 더욱 편리하게 사용할 수 있다.