서블릿 필터
공통 관심 사항
요구사항에 따르면, 로그인을 한 사용자만 상품 관리 페이지에 접근할 수 있다. 그러나 지금까지 우리가 작성한 코드는 URL을 직접 호출하는 경우 상품 관리화면에 접근 가능하다. (단순히 버튼을 보여주지 않는 방식으로 구현했기 때문에)
이는 모든 컨트롤러 로직에서 일일이 로그인 여부를 체크함으로써 해결할 수 있다.(만약 로그인 로직이 바뀐다면 이 공통 로직을 전부 수정해야 한다)
이처럼 애플리케이션의 여러 로직에서 공통으로 관심이 있는 것을 공통 관심사(cross-cutting concern)이라고 한다. 등록, 수정, 삭제, 조회 등등 모든 로직에서 공통으로 로그인 여부 체크(인증)이라는 공통 관심사를 가지고 있다.
이같은 공통 관심사는 AOP로도 해결 가능하나, 웹과 관련된 공통 관심사는 서블릿 필터 또는 스프링 인터셉터를 사용하는것이 좋다. 웹과 관련된 공통 관심사 처리를 위해서는 HTTP 헤더나 URL의 정보들이 필요한데, 서블릿 필터나 스프링 인터셉터는 HttpServletRequest를 제공한다. (그외에도 AOP와 비교하여 부가적인 요소들을 많이 제공하므로 사용이 더 권장된다!)
서블릿 필터
필터는 서블릿이 지원하는 수문장(문을 지키고 있는 문지기)이다.
필터 흐름
HTTP 요청 > WAS(서버) > 필터 > 서블릿 > 컨트롤러- 필터(로직)를 적용하면 필터가 호출 된 다음 서블릿이 호출된다.
- 모든 고객의 요청 로그를 남기는 요구사항이 있다면, 필터를 사용할 수 있다.
- 필터는 특정 URL패턴에 적용할 수 있다.
/*라고 하면 모든 요청에 필터가 적용된다.
- 만약 스프링을 사용중이라면, 여기서 말하는 서블릿은 스프링의 디스패처 서블릿으로 생각하면 된다.
필터 제한
HTTP 요청 > WAS > 필터 > 서블릿 > 컨트롤러 //로그인 사용자
HTTP 요청 > WAS > 필터(적절하지 않은 요청이라 판단, 서블릿 호출X) // 비로그인 사용자- 필터에서 적절하지 않은 요청이라고 판단하면, 거기서 흐름을 중단할 수 있다.
- 다라서, 로그인 여부 체크에 적절하다.
필터 체인
HTTP 요청 > WAS > 필터1 > 필터2 > 필터3 > 서블릿 > 컨트롤러- 필터는 체인으로 구성된다. (중간에 필터를 자유롭게 추가할 수 있다.)
- ex. 로그 남기는 필터(먼저 적용) > 로그인 여부 체크 필터
필터 엔터페이스
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: 로그필터
package com.study.admin.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");
}
}public class LogFilter implements Filter)_
- 필터를 사용하려면 필터 인터페이스를 구현해야 한다.
doFilter(ServletRequest request, SerlvetResponse response, FilterChani 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);
- 가장 중요한 로직.
- 다음 필터가 있는 경우 필터를 호출하고, 필터가 없으면 서블릿을 호출한다.
- 만약 로직을 호출하지 않으면 다음 단계로 진행되지 않는다.
WebConfig: 필터 설정
package com.study.admin;
import com.study.admin.filter.LogFilter;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import javax.servlet.Filter;
@Configuration
public class WebConfig {
@Bean
public FilterRegistrationBean logFilter() {
FilterRegistrationBean<Filter> filterFilterRegistrationBean = new FilterRegistrationBean<>();
filterFilterRegistrationBean.setFilter(new LogFilter());
filterFilterRegistrationBean.setOrder(1);
filterFilterRegistrationBean.addUrlPatterns("/*");
return filterFilterRegistrationBean;
}
}필터를 등록하는데에는 여러가지 방법이 있지만, 스프링 부트를 사용한다면 FilterRegistrationBean을 사용하면 된다. (그럼 스프링이 알아서 서블릿 컨테이너를 올릴 때 같이 등록해준다.)
setFilter(new LogFilter())등록할 필터 지정setOrder(1): 필터는 체인으로 동작하므로, 순서를 할당해준다. (숫자가 낮을수록 먼저 동작)addUrlPatterns("/*"): 필터를 적용할 URL 패턴을 지정한다. 한번에 여러 패턴을 지정할 수 있다.
참고
- URL 패턴에 대한 룰: 필터도 서블릿과 동일. (서블릿 URL 패턴 검색으로 확인 가능)
참고
@ServletComponentScan,@WebFilter(filterName = "logFilter", urlPatterns = "/*")를 이용하여 필터 등록도 가능하다. 그러나 필터 순서 조절이 안되므로FilterRegistrationBean를 사용하는것이 좋다.
실행로그
hello.login.web.filter.LogFilter: REQUEST [0a2249f2cc70-4db4-98d1-492ccf5629dd][/items]
hello.login.web.filter.LogFilter: RESPONSE [0a2249f2cc70-4db4-98d1-492ccf5629dd][/items]필터 등록시 urlPattern을 /*로 등록했기 때문에 모든 요청에 해당 필터가 적용된다.
참고
실무에서 HTTP 요청시 같은 요청의 로그에 모두 같은 식별자를 자동으로 남기는 방법은 lombok mdc로 찾아보자.
서블릿 필터: 인증 체크
인증체크 필터를 개발해보자. 로그인 되지 않은 사용자는 페이지에 접근하지 못하도록 하자!
😧 근데... 모든 요청에 일일이 필터를 적용시킨다니, 성능이 떨어지지 않을까요?
🙂 아니에요, 필터는 모래알같은 작은 기능이라 크게 성능 저하를 유발하지는 않습니다. (그보단 쿼리, 네트워크 이런 부분에서 성능을 크게 좌우합니다.)
LoginCheckFilter: 인증 체크 필터
package com.study.admin.filter;
import com.study.admin.enums.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 = {"/", "/admin/add", "/admin/login", "/admin/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_ADMIN) == null) {
log.info("미인증 사용자 요청{}", requestURI);
// 로그인으로 redirect
httpResponse.sendRedirect("/admin/login?redirectURL=" + requestURI);
return;
// 아무것도 return하지 않음으로써 다음 chain filter, 서블릿 요청을 하지 않게 됨.
}
}
// whilteList인 경우 바로 doFilter적용
chain.doFilter(request, response);
} catch (Exception e) {
throw e; // 예외 로깅 가능하나, 톰캣까지 예외를 보내주어야 한다.
// 서블릿 필터에서 터진 예외가 올라오는데, 여기서 먹어버리면
// 정상 요청처럼 작용하므로 was까지 올려주는 것이 좋다.
} finally {
log.info("인증 체크 필터 종료 {}", requestURI);
}
}
/**
* 화이트 리스트의 경우 인증체크X
* - 화이트 리스트에 포함 X : 인증체크 필요 = true
* - 화이트 리스트에 포함 O : 인증체크 불필요 = false
*/
private boolean isLoginCheckPath(String requestURL) {
return !PatternMatchUtils.simpleMatch(whiteList, requestURL);
}
}-
whitelist = {"/", "/members/add", "/login", "/logout","/css/*"};- 인증 필터를 적용하더라도 홈, 회원가입, 로그인, css 같은 리소스에는 접근이 가능해야 한다.
- 화이트 리스트 경로는 인증과 무관하게 항상 접근을 허용한다.
- 화이트 리스트 외의 모든 경로에는 인증 체크 로직을 적용한다.
-
isLoginCheckPath(requestURI)- 화이트 리스트 외의 모든 경로에는 인증 체크 로직을 적용한다.
-
httpResponse.sendRedirect("/admin/login?redirectURL=" + requestURI);- 미인증 사용자는 로그인 화면으로 리다이렉트 한다.
- 로그인 이후 다시 홈으로 이동하면 사용자가 원하는 경로를 다시 찾아가야 한다는 불편함이 있다. 이 부분 개선을 위해 현재 요청한 경로인 requestURI를
/admin/login에 쿼리 파라미터로 함께 전달한다. - 이후
/admin/login컨트롤러에서 해당 경로로 이동하는 기능을 추가 개발한다.
-
return;- 가장 중요한 부분. 필터를 더 진행하지 않는다.
- 이후 필터, 서블릿, 컨트롤러가 더 호출되지 않는다.
- 앞서 redirect를 사용했으므로 redirect가 응답으로 적용되고 요청이 종료된다.
WebConfig: loginCheckFilter() 추가
@Bean
public FilterRegistrationBean loginCheckFilter(){
FilterRegistrationBean<Filter> filterFilterRegistrationBean = new FilterRegistrationBean<>();
filterFilterRegistrationBean.setFilter(new LoginCheckFilter());
filterFilterRegistrationBean.setOrder(2);
filterFilterRegistrationBean.addUrlPatterns("/*");
return filterFilterRegistrationBean;
}setFilter(new LoginCheckFilter()): 로그인 필터를 등록한다.setOrder(2): 순서를 2번으로 잡았다. 로그 필터 다음에 로그인 필터가 적용된다.addUrlPatterns("/*"): 모든 요청에 로그인 필터를 적용한다.- 여기서 (로그인 필터 로직을 적용할) 접근 불가능한 url만 선언해 두는 것도 방법이 될 수 있다.
- 그러나 이는 미래 추가되는 접근 불가 url을 추가하기 위해 코드를 변경해야 한다는 단점이 있다.
- 따라서, 모든 경로애 filter를 적용하고, 접근 가능한 url만 따로 선언해주는 방식(whilteList)을 사용한다.
스프링 인터셉터
- 웹과 관련된 공통 관심 사항을 효과적으로 해결할 수 있는 기술(서블릿 필터처럼)
- 스프링 MVC가 제공하는 기술이다.
- 서블릿 필터와의 차이점: 적용되는 1.순서 2.범위 3.사용방법
스프링 인터셉터 흐름
HTTP 요청 > WAS > 필터 > 서블릿 > 스프링 인터셉터 > 컨트롤러
- 스프링 인터셉터는 디스패처 서블릿과 컨트롤러 사이에서 컨트롤러 호출 직전에 호출 된다.
- 스프링 인터셉터는 스프링 MVC가 제공하는 기능이기 때문에 결국 디스패처 서블릿 이후에 등장하게 된다.
- 이는 스프링 MVC의 시작점이 디스패처 서블릿이기 때문이다.
- 스프링 인터셉터에도 URL 패턴을 적용할 수 있다.
- 다만 서블릿 URL 패턴과는 다르고, 매우 정밀하게 설정할 수 있다.
스프링 인터셉터 제한
HTTP 요청 > WAS > 필터 > 서블릿 > 스프링 인터셉터 > 컨트롤러 //로그인 사용자
HTTP 요청 > WAS > 필터 > 서블릿 > 스프링 인터셉터(적절하지 않은 요청이라 판단, 컨트롤러 호출 X) // 비로그인 사용자
- 인터셉터에서 적절하지 않은 요청이라고 판단하면 거기서 중단할 수 있다.
- 로그인 여부 체크에 매우 적절!
스프링 인터셉터 체인
HTTP 요청 > WAS > 필터 > 서블릿 > 인터셉터1 > 인터셉터2 > 컨트롤러
- 스프링 인터셉터 또한 체인으로 구성된다. 따라서, 중간에 인터셉터를 자유롭게 추가할 수 있다.
- ex. 로그를 남기는 인터셉터 적용 -> 로그인 여부 체크하는 인터셉터 적용
- 서블릿 필터와 매우 유사해보이나, 훨씬 편리하고 정교하며 다양한 기능을 제공한다.
스프링 인터셉터 인터페이스
스프링 인터셉터를 사용하려면 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 {} response,
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번에서 종료된다.
-
postHandle: 컨트롤러 호출 후에 호출된다. (더 정확히는 핸들러 어댑터 호출 후에 호출된다.)
-
afterCompletion: 뷰가 랜더링이 된 이후에 호출된다.
스프링 인터셉터 예외 상황
예외가 발생 시
- preHandle: 컨트롤러 호출 전에 호출된다.
- postHandle: 컨트롤러에서 예외가 발생하면 postHandle은 호출되지 않는다.
- afterCompletion: afterCompletion은 항상 호출된다. 이 경우 예외(ex)를 파라미터로 받아서 어떤 예외가 발생했는지 로그로 출력할 수 있다.
afterCompletion은 예외가 발생하도 호출된다.
- 예외가 발생하면 postHandle()는 호출되지 않으므로 예외와 무관하게 공통 처리를 하려면
afterCompletion()을 사용해야 한다.- 예외가 발생하면
afterCompletion()에 예외 정보(ex)를 포함해서 호출된다.
인터셉터는 스프링 MVC 구조에 특화된 필터 기능을 제공한다. 스프링 MVC를 사용하고 있고, 특별히 필터를 꼭 사용해야 하는 상황이 아니라면 인터셉터를 사용하는 것이 더 편리하다.
스프링 인터셉터: 요청 로그
LogInterceptor- 요청 로그 인터셉터
package com.study.admin.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();
String logId = (String) request.getAttribute(LOG_ID);
log.info("RESPONSE [{}][{}][{}]", logId, requestURI, handler);
if(ex != null) {
log.error("afterCompletion error!!", ex);
}
}
}-
request.setAttribute(LOG_ID, uuid);- 서블릿 필터의 경우 전역변수로 해결했으나, 스프링 인터셉터는 호출 시점이 완전히 분리되어 있다.
- 따라서 preHandle에서 지정한 값을 postHandle, afterCompletion에서 함께 사용하려면 어딘가에 담아두어야 한다.
- LogInterceptor또한 싱글톤 처럼 사용되기 때문에 멤버변수로 사용하면 위험하다.
- 따라서, request에 담아두었다가 afterCompletion에서 request.getAttribute()로 찾아서 사용한다.
-
return true- true면 정상 호출이므로 다음 인터셉터나 컨트롤러가 호출된다.
if (handler instanceof HandlerMethod) {
HandlerMethod hm = (HandlerMethod) handler; //호출할 컨트롤러 메서드의 모든 정보가
포함되어 있다.
}HandlerMethod
핸들러 정보는 어떤 핸들러 매핑을 사용하는가에 따라 달라진다. 스프링 사용시 일반적으로 @Controller, @RequestMapping을 활용한 핸들러 매핑을 사용하는데, 이 경우 핸들러 정보로 HandlerMethod가 넘어온다.
ResourceHttpRequestHandler
/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/**", "/*.io", "/error");
}
}WebMvcConfigurer가 제공하는 addInterceptors()를 사용해서 인터셉터를 등록할 수 있다.
registry.addInterceptor(new LogInterceptor()): 인터셉터를 등록한다.order(1): 인터셉터의 호출 순서를 지정한다. (숫자가 작을 수록 먼저 호출)addPathPatterns("/**"): 인터셉터를 적용할 URL 패턴을 지정한다.excludePathPatterns("/css/**", "/*.ico", "/error"): 인터셉터에서 제외할 패턴을 지정한다.- 서블릿 필터에서 수행한 것처럼 whiteList를 따로 구현하지 않아도 된다!
필터와 비교해보면 인터셉터는 addPathPatterns, excludePathPatterns로 매우 정밀하게 URL 패턴을 지정할 수 있다.
스프링의 URL 경로
스프링이 제공하는 URL 경로는 서블릿 기술이 제공하는 URL 경로와 완전히 다르다. 더욱 자세하고, 세밀하게 설정할 수 있다.
스프링 인터셉터: 인증 체크
LogCheckInterceptor
package com.study.admin.interceptor;
import com.study.admin.enums.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_ADMIN) == null) {
log.info("미인증 사용자 요청");
// 로그인으로 redirect
response.sendRedirect("/admin/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/**", "/*.io", "/error");
registry.addInterceptor(new LoginCheckInterceptor())
.order(2)
.addPathPatterns("/**")
.excludePathPatterns(
"/", "/admin/add", "/admin/login",
"/admin/logout", "/css/**", "/*.ico",
"/error"
);
}
// @Bean
public FilterRegistrationBean logFilter() {
FilterRegistrationBean<Filter> filterFilterRegistrationBean = new FilterRegistrationBean<>();
filterFilterRegistrationBean.setFilter(new LogFilter());
filterFilterRegistrationBean.setOrder(1);
filterFilterRegistrationBean.addUrlPatterns("/*");
return filterFilterRegistrationBean;
}
}특정 url의 인터셉터 적용 여부를 addPathPatterns와 excludePathPatterns에 작성하면 된다.
기본적으로 모든 경로(/**)에 적용하되, 홈, 회원가입, 로그인 등등의 부분은 인터셉터를 적용하지 않는다.
정리
서블릿 필터와 인터셉터 모두 웹과 관련된 공통 관심사 해결에 유용하다. 다만 서블릿 인터셉터가 개발자 입장에서 훨씬 편리하므로 사용이 권장된다!
ArgumentResolver 활용
ArgumentResolver를 활용하여 로그인 회원을 조금 더 편리하게 찾아보자!
HomeController
@GetMapping("/")
public String homeLogin(@Login AdminDTO loginAdmin,
Model model) {
// 세션에 회원 데이터가 없으면 home으로 이동
if (loginAdmin == null) {
return "home";
}
// 세션이 유지되면 loginHome으로 이동
model.addAttribute("admin", loginAdmin);
return "loginHome";
}기존 코드에서 @SessionAttribute(name = SessionConst.LOGIN_ADMIN, required = false) 부분을 직접 만들 @Login 애노테이션으로 바꿨다.
@Login 애노테이션이 있으면 우리가 직접 만든 ArgumentResolver가 동작해 자동으로 세션에 있는 로그인 회원을 찾아주고, 만약 세션에 없다면 null을 반환하도록 개발해보자!
@Login 애노테이션 생성
package com.study.admin.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): 리플렉션 등을 활용할 수 있도록 런타임까지 애노테이션 정보가 남아있음
LoginMemberArgumentResolver 생성
package com.study.admin.argumentresolver;
import com.study.admin.dto.AdminDTO;
import com.study.admin.enums.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 LoginAdminArgumentResolver implements HandlerMethodArgumentResolver {
@Override
public boolean supportsParameter(MethodParameter parameter) {
log.info("supportsParameter 실행");
boolean hasLoginAnnotation = parameter.hasParameterAnnotation(Login.class); // 애노테이션(@Login) 포함 여부 확인
boolean hasAdminType = AdminDTO.class.isAssignableFrom(parameter.getParameterType()); // AdminDTO가 맞는지 인
// 둘 다 만족하는 경우 resolveArgument 실행
return hasLoginAnnotation && hasAdminType;
}
@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(false); // false: 새로운 세션 방지
if (session == null) {
// session이 null인 경우, AdminDTO에 null을 넣어줍니다.
return null;
}
return session.getAttribute(SessionConst.LOGIN_ADMIN);
}
}supportsParameter():@Login애노테이션 有 & AdminDTO 타입 => ArgumentResovler가 사용된다.reslveArgument()- 컨트롤러 호출 직전에 호출 되어서 필요한 파라미터 정보를 생성해준다.
- 세션에 있는 로그인 관리자 정보인 AdminDTO 객체를 찾아서 반환해준다.
- 스프링 MVC는 컨트롤러의 메서드를 호출하면서 여기에 반환된
AdminDTO객체를 파라미터에 전달해준다.
WebMvcConfigurer에 설정 추가
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Override
public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
resolvers.add(new LoginAdminArgumentResolver());
}
}LogAdminArgumentResolver를 등록한다.
Good Luck!
좋은 정보 얻어갑니다, 감사합니다.