서블릿 필터
필터는 서블릿이 지원하는 수문장이다. 필터의 특성은 다음과 같다
필터 흐름
HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 컨트롤러필터를 적용하면 필터가 호출 된 다음에 서블릿이 호출된다.
필터는 특정 URL 패턴에 적용할 수 있다. /* 이라고 하면 모든 요청에 필터가 적용된다.
스프링을 사용하는 경우 여기서 말하는 서블릿은 스프링의 디스패처 서블릿으로 생각하면 된다.
필터 제한
HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 컨트롤러 //로그인 사용자
HTTP 요청 -> WAS -> 필터(적절하지 않은 요청이라 판단, 서블릿 호출X) // 비 로그인 사용자필터에서 적절하지 않은 요청이라고 판단하면 거기에서 끝을 낼 수도 있다.
그래서 로그인 여부를 체크하기에 좋다.
필터 체인
HTTP 요청 -> WAS -> 필터1 -> 필터2 -> 필터3 -> 서블릿 -> 컨트롤러필터는 체인으로 구성되는데, 중간에 필터를 자유롭게 추가할 수 있다.
필터 인터페이스
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 {
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");
}
}- public class LogFilter implements Filter{}
- 필터를 사용하려면 필터 인터페이스를 구현야 한다.
- doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
- HTTP 요청이 오면 doFilter가 호출된다.
- ServletRequest request는 HTTP 요청이 아닌 경우까지 고려해서 만든 인터페이스다.
HTTP를 사용하면 다운 케스팅하면 된다.
- String uuid = UUID.randomUUID().toString();
- HTTP 요청을 구분하기 위해 요청당 임의의 uuid 생성
- log.info("REQUEST [{}][{}]", uuid, requestURI);
- uuid와 requestURI를 출력한다
- 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);
//모든 URL에 다 적용
filterRegistrationBean.addUrlPatterns("/*");
return filterRegistrationBean;
}
}필터를 등록하는 방법은 여러가지가 있지만, 스프링 부트를 사용한다면 FilterRegistrationBean을 사용해서 등록하면 된다.
-
setFilter(new LogFilter()) : 등록할 필터를 지정한다.
-
setOrder(1) : 필터는 체인으로 동작한다. 따라서 순서가 필요하다. 낮을 수록 먼저 작동한다.
-
addUrlPatterns("/*") : 필터를 적용할 URL 패턴을 지정한다. 한번에 여러 패턴을 지정할 수 있다.
서블릿 필터 - 인증 체크
인증체크 필터를 개발해보자. 로그인 되지 않은 사용자는 상품 관리 뿐만 아니라 미래에 개발 될
페이지에도 접근하지 못하도록 하자.
@Slf4j
public class LoginCheckFilter implements Filter {
private static final String[] whitelist = {"/","/member/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 = {"/", "/members/add", "/login", "/logout","/css/*"};
- 인증 필터를 적용해도 홈, 회원가입, 로그인화면, css같은 리소스에는 접근할 수 있어야 한다. 이렇게 화이트 리스트경로는 인증과 무관하게 항상 허용한다.
화이트 리스트를 제외한 나머지 경로에는 인증 체크 로직을 적용한다
- 인증 필터를 적용해도 홈, 회원가입, 로그인화면, css같은 리소스에는 접근할 수 있어야 한다. 이렇게 화이트 리스트경로는 인증과 무관하게 항상 허용한다.
- isLoginCheckPath(requestURI)
- 화이트 리스트를 제외한 모든 경우에 인증 체크 로직을 적용한다.
- httpResponse.sendRedirect("/login?redirectURL=" + requestURI);
- 미 인증 사용자는 로그인 화면으로 리다이렉트 한다. 그런데 로그인 이후 다시 홈으로 이동해 버리면, 원하는 경로를 다시 찾아가야 하는 불편함이 있다. 이런 기능을 위해 현재 요청 경로인 requestURI를 /login에 쿼리 파라미터로 함께 전달한다.
return; 여기가 중요하다. 필터는 더는 진행하지 않는다. 이후 필터는 물론 서블릿,컨트롤러가 더는 호출되지 않는다. 앞서 redirect를 사용했기 때문에 redirect가 응답으로 적용되고 요청이 끝난다.
- 미 인증 사용자는 로그인 화면으로 리다이렉트 한다. 그런데 로그인 이후 다시 홈으로 이동해 버리면, 원하는 경로를 다시 찾아가야 하는 불편함이 있다. 이런 기능을 위해 현재 요청 경로인 requestURI를 /login에 쿼리 파라미터로 함께 전달한다.
webConfig - loginCheckFilter()추가
@Bean
public FilterRegistrationBean loginCheckFilter() {
FilterRegistrationBean<Filter> filterRegistrationBean = new FilterRegistrationBean<>();
filterRegistrationBean.setFilter(new LoginCheckFilter());
filterRegistrationBean.setOrder(2);
//모든 URL에 다 적용
filterRegistrationBean.addUrlPatterns("/*");
return filterRegistrationBean;
}- setFilter(new LoginCheckFilter()) : 로그인 필터를 등록해준다
- setOrder(2) : 순서를 2번으로 잡았다. 로그 필터 다음에 로그인 필터가 적용된다.
- addUrlPatterns("/*") : 모든 요청에 로그인 필터를 적용한다
RedirectURL 처리
로그인에 성공하면 처음 요청한 URL로 이동하는 기능을 개발해보자.
public String loginV4(@Valid @ModelAttribute LoginForm form, BindingResult bindingResult,
@RequestParam(defaultValue = "/") String redirectURL,
HttpServletRequest request) {
~~~
return "redirect:" + redirectURL;
}로그인 체크 필터에서, 미인증 사용자는 요청 경로를 포함해서 /login에 redirectURL요청 파라미터를 추가해서 요청했다. 이 값을 사용해서 로그인 성공 시 해당 경로로 고객을 redirect한다.
스프링 인터셉터
스프링 인터셉터도 서블릿 필터와 같이 웹과 관련된 공통 관심 사항을 효과적으로 해결할 수 있는 기술이다.
서블릿 필터가 서블릿이 제공하는 기술이라면, 스프링 인터셉터는 스프링 MVC가 제공하는 기술이다.
둘 다 웹과 관련된 공통 관심 사항을 처리하지만, 적용 순서와 범위, 사용방법이 다르다
스프링 인터셉터 흐름
HTTP 요청 -> WAS - 필터 -> 서블릿 -> 스프링 인터셉터 -> 컨트롤러-
스프링 인터셉터는 디스패처 서블릿과 컨트롤러 사이에서 컨트롤러 호출 직전에 호출 된다.
-
스프링 인터셉터는 스프링 MVC가 제공하는 기술이기 때문에 결국 디스패처 서블릿 이후에 등장하게 된다, 스프링 MVC의 시작점이 디스패처 서블릿이라고 생각해보면 이해가 될 것이다.
-
스프링 인터셉터에도 URL 패턴을 적용할 수 있는데, 서블릿 URL 패턴과는 다르고, 매우 정밀하게 설정할 수 있다.
스프링 인터셉터 제한
HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 스프링 인터셉터 -> 컨트롤러 // 로그인 사용자
HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 스프링 인터셉터(적절하지 않은 요청이라 판단, 컨트롤러 요청 X) //비로그인인터셉터에서 적절하지 않은 요청이라고 판단하면 거기에서 끝을 낼 수도 있다.
그래서 로그인 여부를 체크하기에 좋다.
스프링 인터셉터 체인
HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 인터셉터1 -> 인터셉터2 -> 컨트롤러스프링 인터셉터는 체인으로 구성되는데, 중간에 인터셉터를 자유롭게 추가할 수 있다.
스프링 인터셉터는 서블릿 필터보다 편리하고, 더 정교하고 다양한 기능을 지원한다.
스프링 인터셉터 인터페이스
스프링의 인터셉터를 사용하려면 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번에서 끝난다.
-
postHanlde : 컨트롤러 호출 후에 호출된다.(핸들러 어댑터 호출 후에 호출된다.)
-
postCompletion : 뷰가 렌더링 된 이후에 호출된다.
스프링 인터셉터 예외 상황
예외가 발생 시
-
preHandle : 컨트롤러 호출 전에 호출된다.
-
postHandle : 컨트롤러에서 예외가 발생하면 postHandle은 호출되지 않는다.
-
afterCompletion : afterCompletion은 항상 호출된다. 이 경우 예외(ex)를 파라미터로 받아서 어떤 예외가 발생했는지 로그로 출력할 수 있다.
afterCompletion은 예외가 발생해도 호출된다
-
예외가 발생하면 postHandle()는 호출되지 않으므로 예외와 무관하게 공통 처리를 하려면
afterCompletion()을 사용해야 한다. -
예외가 발생하면 afterCompletion()에 예외 정보(ex)를 포함해서 호출된다.
스프링 인터셉터 - 요청 로그
@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();
String uuid = (String) request.getAttribute(LOG_ID);
log.info("REQUEST [{}][{}][{}]", 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에 담아두었다.
- 스프링 인터셉터는 호출 시점이 완전히 분리되어 있다.
- 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") : 인터셉터에서 제외할 패턴 지정.
필터와 다르게 인터셉터는 매우 정밀하게 URL 패턴을 지정할 수 있다.
스프링 인터셉터 - 인증체크
@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만 구현하면 된다.
세밀한 설정 가능
@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
인터셉터를 정용하지 않을 부분은 excludePathPattrens
기본적으로 모든 경로에 해당 인터셉터를 적용하되(/**)
홈(/), 회원가입(/members/add), 로그인(/login), 리소스 조회(/css/**), 오류(/error)와 같은 부분은 로그인 체크 인터셉터를 적용하지 않는다.
정리
서블릿 필터와 스프링 인터셉터는 웹과 관련된 공통 관심사를 해결하기 위한 기술이다.
서블릿 필터와 비교해서 스프링 인터셉터가 개발자 입장에서 훨씬 편리하다는 것을 코드로 이해했을
것이다. 특별한 문제가 없다면 인터셉터를 사용하는 것이 좋다.
