< 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 > 섹션7. 로그인 처리2 - 필터, 인터셉터
7. 로그인 처리2 - 필터, 인터셉터 - 서블릿 필터 - 소개
7. 로그인 처리2 - 필터, 인터셉터 - 서블릿 필터 - 요청 로그
7. 로그인 처리2 - 필터, 인터셉터 - 서블릿 필터 - 인증 체크
7. 로그인 처리2 - 필터, 인터셉터 - 스프링 인터셉터 - 소개
7. 로그인 처리2 - 필터, 인터셉터 - 스프링 인터셉터 - 요청 로그
7. 로그인 처리2 - 필터, 인터셉터 - 스프링 인터셉터 - 인증 체크
7. 로그인 처리2 - 필터, 인터셉터 - ArgumentResolver 활용 - 정리
7. 로그인 처리2 - 필터, 인터셉터 - 정리
서블릿 필터 - 소개
공통 관심 사항
-> '요구 사항'을 보면 로그인 한 사용자만 '상품 관리 페이지'에 들어갈 수 있어야 한다
-> 앞에서 로그인을 하지 않은 사용자에게는 '상품 관리 버튼'이 보이지 않기 때문에 문제가 없어 보인다. 그런데 문제는 로그인 하지 않은 사용자도 다음 URL을 직접 호출하면 '상품 관리 화면'에 들어갈 수 있다는 점이다
http://localhost:8080/items
-> '상품 관리 컨트롤러'에서 '로그인 여부'를 체크하는 로직을 하나하나 작성하면 되겠지만, 등록, 수정, 삭제, 조회 등등 '상품 관리'의 모든 컨트롤러 로직에 공통으로 '로그인 여부'를 확인해야 한다. 더 큰 문제는 향후 로그인과 관련된 로직을 변경할 때이다. 작성한 모든 로직을 다 수정해야 할 수도 있다.
-> 이렇게 '애플리케이션' 여러 로직에서 공통으로 관심이 있는 것을 '공통 관심사(cross-cutting concern)'라고 한다. 여기서는 등록, 수정, 삭제, 조회 등등 여러 로직에서 공통으로 인증에 대해서 관심을 가지고 있다
-> 이러한 '공통 관심사'는 스프링의 AOP로도 해결할 수 있지만, 웹과 관련된 '공통 관심사'는 지금부터 설명할 '서블릿 필터' 또는 '스프링 인터셉트'를 사용하는것이 좋다. 웹과 관련된 '공통 관심사'를 처리할 때는 'HTTP의 헤더'나 'URL의 정보'들이 필요한데, 서블릿 필터나 스프링 인터셉트는 HttpServletRequest를 제공한다.
서블릿 필터 소개
'필터'는 서블릿이 지원하는 '수문장'이다. 필터의 특성은 다음과 같다
필터 흐름
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() : 필터 종료 메서드, 서블릿 컨테이너가 종료될 때 호출된다.
< 2. 서블릿 필터 - 요청 로그 >
'필터'가 정말 '수문장 역할'을 잘 하는지 확인하기 위해 가장 단순한 필터인, 모든 요청을 '로그'로 남기는 필터를 개발하고 적용해보자
LogFilter - 로그 필터
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() {
Filter.super.destroy();
}
}
public class LogFilter implements Filter {}
-> 필터를 사용하려면 '필터 인터페이스'를 구현해야 한다.
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);
-> 이 부분이 가장 중요하다. 다음 필터가 있으면 필터를 호출하고, 필터가 없으면 서블릿을 호출한다.
-> 만약 이 로직을 호출하지 않으면 다음 단계로 진행하지 않는다.
WebConfig - 필터 설정
package hello.login.web;
import hello.login.web.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(){ //Was띄울때 필터를 넣어준다.
FilterRegistrationBean<Filter> filterRegistrationBean = new FilterRegistrationBean<>();
filterRegistrationBean.setFilter(new LogFilter());
filterRegistrationBean.setOrder(1);
filterRegistrationBean.addUrlPatterns("/*");
return filterRegistrationBean;
}
}
-> 필터를 등록하는 방법은 여러가지가 있지만, 스프링 부트를 사용한다면 FilterRegistraionBean을 사용해서 등록하면 된다.
setFilter(new LogFilter()) : 등록할 필터를 지정한다
setOrder(1) : 필터는 체인으로 동작한다. 따라서 '순서'가 필요하다. 낮을수록 먼저 동작한다.
addUrlPatterns("/*") : 필터를 적용할 URL 패턴을 지정한다. 한번에 여러 패턴을 지정할 수 있다.
참고
URL 패턴에 대한 룰은 필터도 서블릿과 동일하다. 자세한 내용은 서블릿 URL 패턴으로 검색해보자.
참고
@ServletComponentScan @WebFilter(filterName = "logFilter", urlPatterns = "/*"로 '필터 등록'이 가능하지만 '필터 순서 조절'이 안된다. 따라서 FilterRegistraionBean을 사용하자
실행로그
hello.login.web.filter.LogFilter: REQUEST [0a2249f2-cc70-4db4-98d1-492ccf5629dd][/items]
hello.login.web.filter.LogFilter: RESPONSE [0a2249f2-cc70-4db4-98d1-492ccf5629dd][/items]-> 필터를 등록할때 urlPattern을 /*로 등록했기 때문에 모든 요청에 '해당 필터'가 적용된다
참고
실무에서 HTTP 요청시 같은 요청의 로그에 모두 같은 식별자를 자동으로 남기는 방법은 logback mdc로 검색해보자
< 3. 서블릿 필터 - 인증 체크 >
드디어 '인증 체크 필터'를 개발해보자. 로그인 되지 않은 사용자는 상품 관리 뿐만 아니라 미래에 개발될 페이지에도 접근하지 못하도록 하자.
LoginCheckFilter - 인증 체크 필터
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 = {"/", "/members/add", "login", "/logout", "/css/*"};
-> '인증 필터'를 적용해도 홈, 회원가입, 로그인 화면, css같은 리소스에는 접근할 수 있어야 한다. 이렇게 '화이트 리스트' 경로는 인증과 무관하게 항상 허용한다. '화이트 리스트'를 제외한 나머지 모든 경로에는 '인증 체크 로직'을 적용한다.
isLoginCheckPath(requestURI)
-> 화이트 리스트를 제외한 모든 경우에 '인증 체크 로직'을 적용한다
httpResponse.sendRedirect("/login?redirectURL=" + requestURI);
-> '미인증 사용자'는 로그인 화면으로 '리다이렉트'한다. 그런데 로그인 이후에 다시 홈으로 이동해버리면, 원하는 경로를 다시 찾아가야 하는 불편함이 있다. 예를 들어서 '상품 관리 화면'을 보려고 들어갔다가 '로그인 화면'으로 이동하면, 로그인 이후에 다시 '상품관리화면'으로 들어가는 것이 좋다. 이런 부분이 개발자 입장에서는 좀 귀찮을 수 있어도 사용자 입장에서는 편리한 기능이다. 이러한 기능을 위해 현재 요청한 경로인. requestURI를 /login에 '쿼리 파라미터'로 함께 전달한다. 물론 /login 컨트롤러에서 '로그인 성공'시 해당 경로로 이동하는 기능은 추가로 개발해야 한다.
return;
-> 여기가 중요하다. '필터'를 더는 진행하지 않는다. 이후 필터는 물론 서블릿, 컨트롤러가 더는 호출되지 않는다. 앞서 redirect를 사용했기 때문에 redirect가 응답으로 적용되고 요청이 끝난다.
WebConfig - loginCheckFilter() 추가
package hello.login.web;
import hello.login.web.filter.LogFilter;
import hello.login.web.filter.LoginCheckFilter;
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(){ //Was띄울때 필터를 넣어준다.
FilterRegistrationBean<Filter> filterRegistrationBean = new FilterRegistrationBean<>();
filterRegistrationBean.setFilter(new LogFilter());
filterRegistrationBean.setOrder(1);
filterRegistrationBean.addUrlPatterns("/*");
return filterRegistrationBean;
}
@Bean
public FilterRegistrationBean logCheckFilter(){ //Was띄울때 필터를 넣어준다.
FilterRegistrationBean<Filter> filterRegistrationBean = new FilterRegistrationBean<>();
filterRegistrationBean.setFilter(new LoginCheckFilter());
filterRegistrationBean.setOrder(2);
filterRegistrationBean.addUrlPatterns("/*");
return filterRegistrationBean;
}
}
setFilter(new LoginCheckFilter()) : 로그인 필터를 등록한다.
setOrder(2) : 순서를 2번으로 잡았다. '로그 필터' 다음에 로그인 필터가 적용된다.
addUrlPatterns("/*") : 모든 요청에 '로그인 필터'를 적용한다.
RedirectURL 처리
-> 로그인에 성공하면 처음 요청한 URL로 이동하는 기능을 개발해보자
LoginController - loginV4()
@PostMapping("/login")
public String loginV4(@Valid @ModelAttribute LoginForm form, BindingResult bindingResult,
@RequestParam(defaultValue = "/") String redirectURL, //새롭게 추가
HttpServletRequest request) {
if (bindingResult.hasErrors()) {
return "login/loginForm";
}
Member loginMember = loginService.login(form.getLoginId(), form.getPassword());
if (loginMember == null) { //reject는 글로벌 오류이다.
bindingResult.reject("loginFail", "아이디 또는 비밀번호가 맞지 않습니다.");
return "login/loginForm"; //틀리면 사용자가 다시 id,비밀번호 입력하게 만들어야 한다
}
//로그인 성공 처리 TODO
//세션이 있으면 있는 세션 반환, 없으면 신규 세션을 생성
HttpSession session = request.getSession(); //디폴트값 자체가 true
//세션에 로그인 회원 정보 보관
session.setAttribute(SessionConst.LOGIN_MEMBER, loginMember);
//세션 관리자를 통해 세션을 생성하고, 회원 데이터 보관
//sessionManager.createSession(loginMember, response);
return "redirect:" + redirectURL;
}-> loginV3()의 @PostMapping("/login") 제거
-> 로그인 체크 필터에서, 미인증 사용자는 '요청 경로'를 포함해서 /login에 redirectURL 요청 파라미터를 추가해서 요청했다.
이 값을 사용해서 로그인 성공시 해당 경로로 고객을 redirect한다
실행
http://localhost:8080/items
정리
'서블릿 필터'를 잘 사용한 덕분에 로그인 하지 않은 사용자는 나머지 경로에 들어갈 수 없게 되었다. '공통 관심사'를 서블릿 필터를 사용해서 해결한 덕분에 향후 '로그인 관련 정책'이 변경되어도 이 부분만 변경하면 된다.
참고
'필터'에는 다음에 설명할 '스프링 인터셉터'는 제공하지 않는 , 아주 강력한 기능이 있는데
chain.doFilter(request, response); 를 호출해서 다음 필터 또는 서블릿을 호출할 때 request, response를 다음 객체로 바꿀 수 있다. ServletRequest, ServletResponse를 구현한 다른 객체를 만들어서 넘기면 해당 객체가 다음 필터 또는 서블릿에서 사용된다. 잘 사용하는 기능은 아니니 참고만 해두자
< 4. 스프링 인터셉터 - 소개 >
'스프링 인터셉터'도 '서블릿 필터'와 같이 웹과 관련된 '공통 관심 사항'을 효과적으로 해결할 수 있는 기술이다.
'서블릿 필터'가 서블릿이 제공하는 기술이라면, '스프링 인터셉터'는 스프링 MVC가 제공하는 기술이다. 둘다 웹과 관련된 '공통 관심 사항'을 처리하지만, 적용되는 순서와 범위, 그리고 사용방법이 다르다
스프링 인터셉터 흐름
HTTP 요청 ->WAS-> 필터 -> 서블릿 -> 스프링 인터셉터 -> 컨트롤러-> '스프링 인터셉터'는 '디스패처 서블릿'과 '컨트롤러' 호출 직전에 호출된다.
-> 스프링 인터셉터는 스프링 MVC가 제공하는 기능이기 때문에 결국 '디스패처 서블릿'이후에 등장하게 된다.
스프링MVC의 시작점이 '디스패처 서블릿'이라고 생각해보면 이해가 될것이다.
-> 스프링 인터셉터에도 'URL 패턴'을 적용할 수 있는데, 서블릿 URL 패턴과는 다르고, 매우 정밀하게 설정할 수 있다.
스프링 인터셉터 제한
HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 스프링 인터셉터 -> 컨트롤러 //로그인 사용자
HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 스프링 인터셉터(적절하지 않은 요청이라 판단, 컨트롤러 호출 X) // 비 로그인 사용자-> 인터셉터에서 적절하지 않은 요청이라고 판단하면 거기에서 끝을 낼 수 있다. 그래서 '로그인 여부'를 체크하기에 딱 좋다
스프링 인터셉터 체인
HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 인터셉터1 -> 인터셉터2 -> 컨트롤러-> '스프링 인터셉터'는 체인으로 구성되는데, 중간에 인터셉터를 자유롭게 추가할 수 있다. 예를 들어서 '로그'를 남기는 인터셉터를 먼저 적용하고, 그 다음에 '로그인 여부'를 체크하는 인터셉터를 만들 수 있다.
-> 지금까지 내용을 보면 '서블릿 필터'와 호출되는 순서만 다르고, '제공하는 기능'은 비슷해보인다. 앞으로 설명하겠지만, 스프링 인터셉터는 서블릿 필터보다 편리하고, 더 정교하고 다양한 기능을 지원한다.
스프링 인터셉터 인터페이스
스프링의 인터셉터를 사용하려면 HandlerIntercepter 인터페이스를 구현하면 된다
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번에서 끝이 나버린다.
postHandle : 컨트롤러 호출 후에 호출된다. ( 더 정확히는 핸들러 어댑터 호출 후에 호출된다)
afterCompletion : 뷰가 렌더링 된 이후에 호출된다.
스프링 인터셉터 예외 상황
예외가 발생시
preHandle : 컨트롤러 호출 전에 호출된다
postHandle : 컨트롤러에서 예외가 발생하면 postHandle은 호출되지 않는다
afterCompletion : afterCompletion은 항상 호출된다. 이 경우 예외(ex)를 파라미터로 받아서 어떤 예외가 발생했는지 '로그'로 출력할 수 있다
afterCompletion은 예외가 발생해도 호출된다
-> 예외가 발생하면 postHandle()은 호출되지 않으므로 예외와 무관하게 '공통 처리'를 하려면 afterCompletion()을 사용해야 한다
-> 예외가 발생하면 afterCompletion()에 예외정보(ex)를 포함해서 호출된다
정리
'인터셉터'는 스프링 MVC 구조에 특화된 '필터 기능'을 제공한다고 이해하면 된다. 스프링 MVC를 사용하고, 특별히 '필터'를 꼭 사용해야 하는 상황이 아니라면 '인터셉터'를 사용하는 것이 더 편리하다
< 5. 스프링 인터셉터 - 요청 로그 >
LogInterceptor - 요청 로그 인터셉터
package hello.login.web.intercepter;
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("REQUEST [{}][{}][{}]", logId , requestURI, handler);
if (ex != null) { //예외가 null이 아니면
log.error("afterCompletion error!!", ex);
}
}
}String uuid = UUID.randomUUID().toString()
-> 요청 로그를 구분짓기 위한 uuid를 생성한다
request.setAttribute(LOG_ID, uuid)
-> 서블릿 필터의 경우 '지역 변수'로 해결이 가능하지만, 스플이 인터셉트는 호출 시점이 완전히 분리되어 있다.
-> 따라서 preHandle에서 지정한 값을 postHandle, afterCompletion 에서 함께 사용하려면 어딘가에 담아두어야 한다.
-> LogInterceptor도 싱클톤처럼 사용되기 때문에 '멤버 변수'를 사용하면 위험하다
-> 따라서 request에 담아두었다. 이 값은 afterCompletion에서 request.getAttribute(LOG_ID)로 찾아서 사용한다.
return true
-> true면 정상호출 이다. 다음 인터셉터나 컨트롤러가 호출된다
//@RequestMapping : HandlerMethod
//정적 리소스: ResourceHttpRequestHandler
if (handler instanceof HandlerMethod) {
HandlerMethod hm = (HandlerMethod) handler; //호출할 컨트롤러 메서드의 모든 정보가 포함되어 있다.
}
log.info("REQUEST [{}][{}][{}]", uuid, requestURI, handler);
return true; //중요
}
HandlerMethod
-> 핸들러 정보는 어떤 '핸들러 매핑'을 사용하는가에 따라 달라진다. 스프링을 사용하면 일반적으로 @Controller, @RequestMapping을 활용한 '핸들러 매핑'을 사용하는데, 이 경우 '핸들러 정보'로 HandlerMethod가 넘어온다.
ResourceHttpRequestHandler
-> @Controller가 아니라 /resources/static과 같은 '정적 리소스'가 호출되는 경우
ResourceHttpRequestHandler가 핸들러 정보로 넘어오기 때문에 타입에 따라서 처리가 필요하다
postHandle, afterCompletion
-> 종료 로그를 postHandle이 아니라 afterCompletion에서 실행한 이유는, '예외'가 발생한 경우 postHandle가 호출되지 않기 때문이다. afterCompletion은 예외가 발생해도 호출되는 것을 보장한다
WebConfig - 인터셉터 등록
package hello.login.web;
import hello.login.web.filter.LogFilter;
import hello.login.web.filter.LoginCheckFilter;
import hello.login.web.intercepter.LogInterceptor;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import javax.servlet.Filter;
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new LogInterceptor())
.order(1)
.addPathPatterns("/**")
.excludePathPatterns("/css/**", "/*.ico", "/error");
}
//@Bean
public FilterRegistrationBean logFilter(){ //Was띄울때 필터를 넣어준다.
FilterRegistrationBean<Filter> filterRegistrationBean = new FilterRegistrationBean<>();
filterRegistrationBean.setFilter(new LogFilter());
filterRegistrationBean.setOrder(1);
filterRegistrationBean.addUrlPatterns("/*");
return filterRegistrationBean;
}
@Bean
public FilterRegistrationBean logCheckFilter(){ //Was띄울때 필터를 넣어준다.
FilterRegistrationBean<Filter> filterRegistrationBean = new FilterRegistrationBean<>();
filterRegistrationBean.setFilter(new LoginCheckFilter());
filterRegistrationBean.setOrder(2);
filterRegistrationBean.addUrlPatterns("/*");
return filterRegistrationBean;
}
}
-> 인터셉터와 필터가 중복되지 않도록 필터를 등록하기 위한 logFilter()의 @Bean은 '주석 처리'하자
WebMvcConfigurer가 제공하는 addInterceptors()를 사용해서 '인터셉터'를 등록할 수 있다.
registry.addInterceptor(new LogInterceptor()) : 인터셉터를 등록한다
order(1) : 인터셉터의 '호출 순서'를 지정한다. 낮을 수록 먼저 호출된다
addPathPatterns("/**") : 인터셉터를 적용할 URL 패턴을 지정한다
excludePathPatterns("/css/**", "/*.ico", "/error") : 인터셉터에서 제외할 패턴을 지정한다
-> 필터와 비교해보면 '인터셉터'는 addPathPatterns, excludePathPatterns로 매우 정밀하게 'URL 패턴'을 지정할 수 있다.
실행로그
REQUEST [6234a913-f24f-461f-a9e1-85f153b3c8b2][/members/add]
[hello.login.web.member.MemberController#addForm(Member)]
postHandle [ModelAndView [view="members/addMemberForm";
model={member=Member(id=null, loginId=null, name=null, password=null),
org.springframework.validation.BindingResult.member=org.springframework.validat
ion.BeanPropertyBindingResult: 0 errors}]]
RESPONSE [6234a913-f24f-461f-a9e1-85f153b3c8b2][/members/add]스프링의 URL 경로
-> 스프링이 제공하는 URL 경로는 서블릿 기술이 제공하는 URL경로와 완전히 다르다. 더욱 자세하고, 세밀하게 설정할 수 있다.
" 자세한 내용은 다음을 참고하자 "
PathPattern 공식 문서
? 한 문자 일치
* 경로(/) 안에서 0개 이상의 문자 일치
** 경로 끝까지 0개 이상의 경로(/) 일치
{spring} 경로(/)와 일치하고 spring이라는 변수로 캡처
{spring:[a-z]+} matches the regexp [a-z]+ as a path variable named "spring"
{spring:[a-z]+} regexp [a-z]+ 와 일치하고, "spring" 경로 변수로 캡처
{*spring} 경로가 끝날 때 까지 0개 이상의 경로(/)와 일치하고 spring이라는 변수로 캡처
/pages/t?st.html — matches /pages/test.html, /pages/tXst.html but not /pages/toast.html
/resources/*.png — matches all .png files in the resources directory
/resources/** — matches all files underneath the /resources/ path, including /
resources/image.png and /resources/css/spring.css
/resources/{*path} — matches all files underneath the /resources/ path and
captures their relative path in a variable named "path"; /resources/image.png
will match with "path" → "/image.png", and /resources/css/spring.css will match
with "path" → "/css/spring.css"
/resources/{filename:\\w+}.dat will match /resources/spring.dat and assign the
value "spring" to the filename variable
< 6. 스프링 인터셉터 - 인증 체크 >
서블릿 필터에서 사용했던 '인증 체크 기능'을 '스프링 인터셉터'로 개발해보자
LoginCheckInterceptor
package hello.login.web.intercepter;
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만 구현하면 된다."
순서 주의 , 세밀한 설정 가능
@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");
}//@Bean //주석처리 하지않으면 로그인처리가 두번된다.
public FilterRegistrationBean logCheckFilter(){ //Was띄울때 필터를 넣어준다.
FilterRegistrationBean<Filter> filterRegistrationBean = new FilterRegistrationBean<>();
filterRegistrationBean.setFilter(new LoginCheckFilter());
filterRegistrationBean.setOrder(2);
filterRegistrationBean.addUrlPatterns("/*");
return filterRegistrationBean;
}-> '인터셉터'와 '필터'가 중복되지 않도록 필터를 등록하기 위한 logFilter(), loginCheckFilter()의 @Bean은 '주석 처리'하자
-> 인터셉터를 적용하거나 하지 않을 부분은 addPathPatterns와 excludePathPatterns에 작성하면된다. 기본적으로 모든 경로에 해당 인터셉터를 적용하되 (/**), 홈(/), 회원가입(/members/add), 로그인(/login), 리소스 조회(/css/**), 오류(/errors)와 같은 부분은 '로그인 체크 인터셉터'를 적용하지 않는다. 서블릿 필터와 비교해보면 매우 편리한것을 알 수 있다.
정리
'서블릿 필터'와 '스프링 인터셉터'는 웹과 관련된 '공통 관심사'를 해결하기 위한 기술이다.
서블릿 필터와 비교해서 '스프링 인터셉터'가 개발자 입장에서 훨씬 편리하다는것을 코드로 이해했을 것이다. 특별히 문제가 없다면 인터셉터를 사용하는것이 좋다.
< 7. ArgumentResolver 활용 >
MVC1편 6. 스프링 MVC - 기본기능 -> 요청 매핑 핸들러 어댑터 구조' 에서 ArgumentResolver 를 학습했다.
이번 시간에는 해당 기능을 사용해서 '로그인 회원'을 좀 더 편리하게 찾아보자
HomeController - 추가
@GetMapping("/")
public String homeLoginV3ArgumentResolver(@Login Member loginMember, Model model){
//세션에 회원 데이터가 없으면 home으로 이동
if (loginMember == null) { //실패시
return "home";
}
//세션이 유지되면 로그인으로 이동
model.addAttribute("member", loginMember); //성공시
return "loginHome"; //로그인 사용자 전용 화면을 만들어준다
}-> homeLoginV3Spring()의 @GetMapping 주석 처리
-> 다음에 설명하는 @Login 애노테이션을 만들어야 '컴파일 오류'가 사라진다
"@Login 애노테이션이 있으면 직접 만든 ArgumentResolver가 동작해서 자동으로 세션에 있는 로그인 회원을 찾아주고, 만약 세션에 없다면 null을 반환하도록 개발해보자"
@Login 애노테이션 생성
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) : 리플렉션 등을 활용할 수 있도록 런타임까지 애노테이션 정보가 남아있음
MVC1에서 학습한 HandlerMethodArgumentResolver를 구현해보자
LoginMemberArgumentResolver 생성
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 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(false);
if (session == null) {
return null;
}
Object member = session.getAttribute(SessionConst.LOGIN_MEMBER);
return member;
}
}
-> supportsParameter() : @Login 애노테이션이 있으면서 Member타입이면 해당 ArgumentResolver가 사용된다.
-> resolverArgument() : 컨트롤러 호출 직전에 호출 되어서 필요한 '파라미터 정보'를 생성해준다. 여기서는 세션에 있는 '로그인 회원 정보'인 member객체를 찾아서 반환한다. 이후 스프링 MVC는 컨트롤러의 메서드를 호출하면서 여기에서 반환된 member객체를 파라미터에 전달해준다.
WebMvcConfigurer에 설정 추가
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Override
public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
resolvers.add(new LoginMemberArgumentResolver());
}-> 앞서 개발한 LoginMemberArgumentResolver를 등록하자
실행
실행해보면, 결과는 동일하지만, 더 편리하게 '로그인 회원 정보'를 조회할 수 있다. 이렇게 ArgumentResolver를 활용하면 '공통 작업'이 필요할 때 컨트롤러를 더욱 편리하게 사용할 수 있다.