필터의 흐름

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

필터를 적용하면 필터가 호출된 다음에 서블릿이 호출된다. 그래서 모든 요청 로그를 남기는 요구사항이 있으면 필터를 사용하면 된다.

필터의 제한

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

• 필터에서 적절하지 않다고 판단하면 끝날수 있어서 로그인 여부를 체크하기에 좋다.

필터 인터페이스

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(): 고객의 요청이 올때마다 해당 메서드 호출됨
• destroy(): 필터 종료 메서드, 서블릿 컨테이너가 종료될때 호출

서블릿 필터 예시

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

• public class LogFilter implements Filter{}
  • 필터를 사용하려면 필터 인터페이스를 구현해야 한다
• doFilter(ServletRequest request,ServletResponse response,FilterChain chain)
  • HTTP 요청이 오면 doFilter가 구현됨
  • ServletRequest request는 HTTP 요청이 아닌 경우까지 고려해서 만든 인터페이스이다. HTTP를 사용하면 HttpServletRequest request = (HttpServletRequest) request;와 같이 다운 케스팅을 하면 됨
• String uuid = UUID.randomUUID().toString()
  • HTTP 요청을 구분하기 위해 요청당 임의의 uuid를 생성해 놓음
• chain.doFilter(request,response)
  • 이 부분이 가장 중요하다. 다음 필터가 있으면 수행하고 필터가 없으면 서블릿을 수행한다. 만약 이 로직을 진행하지 않으면 다음 단계로 진해되지 않음

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 패턴을 지정, 한번에 여러 패턴을 지정 가능

서블릿 필터_ 인증체크

@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); 
        }	
	}
/**
* 화이트 리스트의 경우 인증 체크X */
    private boolean isLoginCheckPath(String requestURI) {
        return !PatternMatchUtils.simpleMatch(whitelist, requestURI);
	}
}

	

• whitelist = {"/", "/members/add", "/login", "/logout","/css/*"};
  • 인증 필터를 적용해도 홈,회원가입,로그인화면,css 같은 리소스에는 접근 할 수 있어야 함
  • 화이트 리스트 경로는 인증과 무관하게 항상 허용하지만 이를 제외한 나머지 모든 경로는 인증 체크 로직 사용

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

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

• return;

  • 더이상 필터를 진행하지 않음

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("/*/): 모든 요청에 로그인 필터를 적용

스프링 인터셉터

인터셉터의 흐름

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

• 적절하지 않다고 판단하면 컨트롤러 호출 x
• 스프링 인터셉터는 디스패처 서블릿과 컨트롤러 사이에서 컨트롤러 호출 직전에 발생

• preHandle: 컨트롤러 호출 전에 호출
  • preHandle의 응답값이 true면 진행 false면 더이상 진행하지 않음
• postHandle: 컨트롤러 호출 후에 호출
• afterCompletion: 뷰가 렌더링 된 다음에 호출

예외 발생시

• preHandle: 컨트롤러 호출전에 호출됨
• postHandle: 컨트롤러에서 예외가 발생하면 postHandle은 호출되지 않음
• afterCompletion: 이afterCompletion은 항상 호출 됨, 이경우 예외를 파라미터로 받아서 어떤 예외가 발생했는지 로그로 출력이 가능

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

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

	if (handler instanceof HandlerMethod) {
			HandlerMethod hm = (HandlerMethod) handler; 
            //호출할 컨트롤러 메서드의 모든 정보가 포함되어 있다.
		}
    log.info("REQUEST  [{}][{}][{}]", uuid, requestURI, handler);
	return true; 
    //false 진행X
    }
	@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();
        String logId = (String)request.getAttribute(LOG_ID);
        log.info("RESPONSE [{}][{}]", logId, requestURI);
        if (ex != null) {
            log.error("afterCompletion error!!", ex);
        }
	}
}

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

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

인터셉터 등록

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LogInterceptor())
                .order(1)
	}
//...
}

• registry.addInterceptor(new LogInterceptor()): 인터셉터를 등록
• order(1) : 인터셉터의 호출 순서를 지정해 낮을 수록 먼저 호출
• addPathPatterns("/**"): 인터셉터를 적용할 URL 패턴을 지정
• excludePathPatterns("/css/**","/*.ico","/error"):인터셉터에서 제외할 패턴을 지정

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

@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");
		registry.addInterceptor(new LoginCheckInterceptor())
      	 	 .order(2)
       		 .addPathPatterns("/**")
        	.excludePathPatterns(
	"/", "/members/add", "/login", "/logout","/css/**", "/*.ico", "/error");
    }
 }

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