Home 필터, 인터셉터 (로그인)
Post
Cancel

필터, 인터셉터 (로그인)

필터는 서블릿이 제공하는 기능이고, 인터셉터는 스프링이 제공하는 기능이다. 둘은 각각의 장단점이 있다.

필터와 인터셉터의 필요성

홈페이지는 로그인을 한 사용자만 접근할 수 있는 페이지가 있다.

여태 해온 상품관리 프로젝트로 보면 로그인 한 사용자만 상품 관리 페이지에 들어갈 수 있는 것이다.

물론 프로젝트에서 로그인 한 사용자에게만 login_home으로 연결되어 상품 관리 버튼이 보여서 문제가 없다고 생각할 수 있다. 하지만 URL을 알고 직접 호출하면 문제없이 접근이 가능하다는 문제가 있다.

상품 관리 컨트롤러에서 로그인 여부를 체크하는 로직을 하나하나 작성하는 방식으로 해결할 수 있지만 이런 식으로 구현하려면 등록, 수정, 삭제, 조회 등등 상품관리의 모든 컨트롤러 로직에서 확인해야 한다. 향후 로그인과 관련된 로직이 변경된다면 이 모든 부분을 수정해야 한다.

공통 관심사

위와 같이 애플리케이션 여러 로직에서 공통으로 관심있는 것을 공통 관심사라고 한다.

공통 관심사는 스프링 AOP로 해결할 수도 있지만, 웹과 관련된 공통 관심사는 서블릿 필터 또는 스프링 인터셉터를 사용하는 것이 좋다. 이유는 웹과 관련된 공통 관심사를 처리할 때는 HTTP의 헤더나 URL 정보들이 필요한데, 필터와 인터셉터는 HttpServletRequest 를 제공하기 때문이다.

“필터와 인터셉터가 꼭 로그인에만 해당하는 것이 아님을 명심”

서블릿 필터

  • 필터의 흐름
    • HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 컨트롤러

필터를 적용하면 필터가 호출된 다음 서빌릇이 호출된다. 그래서 모든 고객의 요청 로그를 남기는 요구사항이 있다면 필터를 사용하면 된다.

필터는 특정 URL 패턴에 적용할 수 있다. 참고로 스프링을 사용하는 경우 여기서 말하는 서블릿은 스프링의 디스패처 서블릿으로 생각하면 된다.

  • 필터 제한
    • HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 컨트롤러 (로그인 사용자)
    • HTTP 요청 -> WAS -> 필터 = 거름 (비 로그인 사용자)

필터에서 적절하지 않은 요청이라고 판단하면 거기에서 끝을 낼 수 있다.

  • 필터 체인
    • HTTP 요청 -> WAS -> 필터1 -> 필터2 -> 필터3 -> 서블릿 -> 컨트롤러

필터는 체인으로 구성되어, 중간에 필터를 자유롭게 추가할 수 있다. 예를 들면 로그를 남기는 필터를 먼저 적용하고 그 다음 필터에 로그인 여부를 체크하는 방식으로 사용할 수도 있다.

  • 필터 인터페이스
1
2
3
4
5
6
7
8
9
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(): 필터 종료 메서드, 서블릿 컨테이너가 종료될 때 호출된다.

요청 로그 필터 적용

가장 단순한 필터인 모든 요청을 로그로 남기는 필터를 적용해본다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
// login/web/filter/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
    • 필터를 사용하려면 필터 인터페이스를 구현해야 한다.
    • FIlter (javax.servlet)
  • doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
    • HTTP 요청이 오면 호출된다.
    • ServletRequest는 HTTP 요청이 아닌 경우까지 고려해서 만든 인터페이스이다. HTTP를 사용하면 (HttpServletRequest)로 다운 캐스팅 해주면 된다.
  • chain.doFilter(request, response)
    • 다음 필터가 있으면 필터를 호출하고, 필터가 없으면 서블릿을 호출.
    • 이 로직을 호출하지 않으면 다음 단계로 진행되지 않는다.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// /login/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 패턴을 지정한다. 한 번에 여러 URL 패턴을 지정할 수 있다.

참고

@ServletComponentScan, @WebFilter(filterName = “logFilter”, urlPatterns = “/*”) 로도 필터 등록이 가능하지만 필터 순서 조절을 지원하지 않는다.

따라서 FilterRegistrationBean의 사용을 권장한다.

참고2

실무에서 HTTP 요청 시 같은 요청의 로그에 모두 같은 식별자를 자동으로 남기고 싶다면 logback mdc를 검색해보면 된다.

인증 체크 필터 적용

/add URL에 접근했을 때, 그리고 이후에 개발될 페이지들에도 로그인이 되지 않은 유저라면 로그인 창으로 넘기는 것을 구현해본다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
@Slf4j  
public class LoginCheckFilter implements Filter {  
  
	private static final String[] whitelist = {"/", "/members/add", "/login", "logout", "/css/*"};  
	  
	private boolean isLoginCheckPath(String requestURI) {  
		return !PatternMatchUtils.simpleMatch(whitelist, requestURI);  
	}  
	@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);
					  
					//로그인으로 이동
					redirecthttpResponse.sendRedirect("/login?redirectURL=" + requestURI);  
					return;  
				}  
			}  
		  
			chain.doFilter(request, response);  
		} catch (Exception e) {  
			throw e; //예외 로깅 가능하지만, 톰캣까지 예외를 보내주어야 한다.  
		} finally {  
			log.info("인증 체크 필터 종료{}", requestURI);  
		}  
	}  
}
1
2
3
4
5
6
7
8
9
10
11
//WebConfig 추가

@Bean  
public FilterRegistrationBean loginCheckFilter() {  
	FilterRegistrationBean<Filter> filterRegistrationBean = new FilterRegistrationBean<>();  
	filterRegistrationBean.setFilter(new LoginCheckFilter());  
	filterRegistrationBean.setOrder(2);  
	filterRegistrationBean.addUrlPatterns("/*");  
	  
	return filterRegistrationBean;  
}
  • whitelist
    • 인증 필터를 적용해도 홈, 회원가입, 로그인, css 같은 리소스에는 접근 가능해야 한다.
    • WebConfig의 addUrlPatterns에 하나하나 적용해도 되지만, 유지보수의 편리함을 위해 모든 URL에 해당하도록 한 다음 필터 내 구현에서 걸러준다.
      • 이 정도의 메모리 낭비는 매우 미비해 괜찮다.
  • isLoginCheckPath()
    • whitelist를 제외한 모든 경우에 인증 체크 로직을 적용한다.
  • httpResponse.sendRedirect(“/login?redirectURL=” + requestURI);
    • 미 인증 사용자는 로그인 화면으로 넘어가게 된다.
    • 하지만 로그인을 하고나서 다시 홈으로 이동하면 원했던 경로로 다시 접근해야 한다.
    • 그래서 쿼리파라미터로 전달해놓는다.
  • return;
    • 중요한 부분이다. 필터를 더는 진행하지 않는다. chain.doFilter()로 이동하지 않기 때문.
    • 이후 필터는 물론 서블릿, 컨트롤러가 더는 호출되지 않는다.
    • 응답으로 redirect를 전달했기 때문에 전달 후 요청이 끝난다.

참고로 필터 인터페이스를 보면 default 키워드가 붙은 메서드가 있다. 때문에 implements 임에도 init(), destroy()는 필수로 구현하지 않아도 된다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
@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) {  
	bindingResult.reject("loginFail", "아이디 또는 비밀번호가 맞지 않습니다.");  
	return "login/loginForm";  
	}  
	  
	//로그인 성공 처리  
	//세션이 있으면 있는 세션 반환, 없으면 신규 세션을 생성  
	HttpSession session = request.getSession();  
	//세션에 로그인 회원 정보 보관  
	session.setAttribute(SessionConst.LOGIN_MEMBER, loginMember);  
	  
	return "redirect:" + redirectURL;  
}

로그인을 한 후 파라미터로 전달했던 redirectURL로 넘어가기 위해 로그인 컨트롤러의 수정이 필요하다.

  • @RequestParam 으로 쿼리 파라미터를 받는다.
  • 바로 로그인 창으로 넘어가는 경우도 있으니 defaultValue=”/” 을 적용한다.
  • 따라서 “redirect:” + redirectURL 에서 ‘/’가 들어가면 홈으로, 쿼리파라미터가 들어온다면 그 페이지로 넘어가게 되는 것이다.

정리

공통 관심사를 서블릿 필터를 적용해 해결했기 때문에 향후 로그인 관련 정책이 변경되어도 필터 부분만 수정해주면 된다.

참고

필터에는 스프링 인터셉터에는 제공되지 않는 강력한 기능이 있다.

chain.doFilter(request, response); 를 호출해 다음 필터 또는 서블릿을 호출할 때 request, response 객체를 다른 객체로 바꿀 수 있다. ServletRequest, ServletResponse를 구현한 다른 객체를 만들어 넘기면 해당 객체가 다음 필터 또는 서블릿에서 사용된다.

잘 사용하는 기능은 아니지만 참고해둔다.

+필터도 빈으로 등록해서 사용해도 된다. (ex - 빈 등록 -> WebConfig 등록 시 사용)

스프링 인터셉터

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

서블릿 필터가 서블릿이 제공하는 기술이라면, 스프링 인터셉터는 스프링 MVC가 제공하는 기술이다.

서블릿 필터보다 조금 더 많은 기능을 제공하며 적용되는 순서와 범위, 그리고 사용방법이 다르다.

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

스프링 인터셉터는 디스패처 서블릿과 컨트롤러 사이에서 컨트롤러 호출 직전에 호출된다. 스프링 인터셉터는 스프링 MVC가 제공하는 기능이기 때문에 결국 디스패처 서블릿 이후에 등장하게 되는 것이다. (스프링 MVC의 시작점이 디스패처 서블릿이라고 생각해보면 쉽다.)

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

  • 스프링 인터셉터 제한
    • HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 스프링 인터셉터 -> 컨트롤러
    • HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 스프링 인터셉터 (비 로그인)

인터셉터에서 적절치 않은 요청이라고 판단하면 거기에서 끝을 낼 수도 있다.

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

스프링 인터셉터도 마찬가지로 체인으로 구성된다. 중간에 인터셉터를 자유롭게 추가 가능하다.

  • 스프링 인터셉터 인터페이스
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
public interface HandlerInterceptor {
	
	default boolean perHandle(HttpServletRequest request,
							  HttpServletResponse response,
							  Object handler) throws Exception {}

	default void postHandle(HttpServletReqeust request,
							HttpServletResponse response,
							Object handler,
							@Nullable ModelAndView modelAndView) throws Exception {}

	default void afterCompletion(HttpServletReqeust request,
								 HttpServletResponse response,
								 Object handler,
								 @Nullable Exception ex) throws Exception {}

서블릿 필터의 경우 단순하게 doFilter() 하나만 제공된다. 인터셉터는 컨트롤러 호출 전(preHandle), 호출 후(postHandle), 요청 완료 이후(afterCompletion)와 같이 단계적으로 잘 세분화 되어 있다.

그리고 서블릿 필터의 경우 단순히 request, response만 제공했지만, 인터셉터는 어떤 컨트롤러(handler)가 호출되는 지 호출 정보도 받을 수 있다. 그리고 어떤 modelAndView가 반환되는지 응답 정보도 받을 수 있다.

  • 스프링 인터셉터 호출 흐름

  • preHandle : 컨트롤러 호출 전에 호출된다. (정확히는 핸들러 어댑터 호출 전)
    • preHandle의 응답 값이 true이면 다음으로 진행하고 false이면 진행하지 않는다.
    • false인 경우 다음 인터셉터는 물론, 핸들러 어댑터도 호출되지 않는다.
  • postHandle : 컨트롤러 호출 후에 호출된다. (얘도 정확히는 핸들러 어댑터 호출 후)
  • afterCompletion : 뷰가 렌더링 된 이후 호출된다.

스프링 인터셉터 예외 발생 시 흐름

  • preHandle : 컨트롤러 호출 전 호출
  • postHandle : 컨트롤러에서 예외가 발생하면 postHandle은 호출되지 않는다.
  • afterCompletion : 항상 호출된다. 이 경우 예외(ex) 파라미터를 받아서 어떤 예외가 발생했는지 로그로 출력할 수 있다.

afterCompletion 왜 항상?

예외가 발생하면 postHandle()은 호출되지 않으므로 예외와 무관하게 공통 처리를 하려면 afterCompletion()이 필요하다.

예외가 발생하면 afterCompletion()에 예외 정보를 포함해 호출된다.

정리

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

요청 로그 인터셉터 적용

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
@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;  
	}  
	  
	@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)
    • 서블릿 필터의 경우 doFilter() 의 지역변수로 uuid를 사용했지만, 스프링 인터셉터는 호출 시점이 완전히 분리되어 있다.
    • 따라서 preHandle에서 지정한 값을 postHandle, afterCompletion에서 함께 사용하려면 어딘가에 담아두어야 한다.
    • LogInterceptor도 싱글톤처럼 사용되기 때문에 멤버 변수를 사용하면 위험하다. 따라서 request에 담아둔 것이다.
  • return true
    • true면 정상 호출이다. 다음 인터셉터나 컨트롤러가 호출된다.
1
2
3
4
5
6
7
8
9
10
11
@Configuration  
public class WebConfig implements WebMvcConfigurer {  
  
	@Override  
	public void addInterceptors(InterceptorRegistry registry) {  
		registry.addInterceptor(new LogInterceptor())  
			.order(1)  
			.addPathPatterns("/**")  
			.excludePathPatterns("/css/**", "/*.ico", "/error");  
	}
}

WebMvcConfigurer (implements) 가 제공하는 addInterceptors() (ctrl + o)를 사용해 인터셉터를 등록한다.

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

스프링이 제공하는 URL 경로는 서블릿이 제공하는 URL 경로와 완전히 다르다. 더욱 자세하고 세밀하게 설정할 수 있다.

*참고 : PathPattern에 관한 링크

추가

1
2
3
4
if (handler insatanceof HandlerMethod) {
	HandlerMethod hm = (HandlerMethod) handler;
	//호출할 컨트롤러 메서드의 모든 정보가 포함되어 있다.
}
  • HandlerMethod
    • 핸들러 정보는 어떤 핸들러 매핑을 사용하는가에 따라 달라진다.
    • 스프링을 사용하면 일반적으로 @Controller, @RequestMapping을 활용한 핸들러 매핑을 사용하는데, 이 경우 핸들러 정보로 HandlerMethod가 넘어온다.
  • ResourcHttpRequestHandler
    • @Controller가 아닌 /resources/static 과 같은 정적 리소스가 호출되는 경우 ResourceHttpRequestHandler가 핸들러 정보로 넘어오기 때문에 타입에 따라 처리가 필요하다.
  • postHandle, afterCompletion
    • 종료 로그를 postHandle이 아닌 afterCompletion에서 실행한 이유는 예외가 발생한 경우 postHandle이 호출되지 않기 때문이다.

인증 체크 인터셉터 활용

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
@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("미인증 사용자 요청");  
		  
			response.sendRedirect("/login?redirectURL=" + requestURI);  
			return false;  
		}  
		  
		return true;  
	}  
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
@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",  
			"/css/**", "/*.ico", "/error");  
	}
}

서블릿 필터와 비교하면 코드가 매우 간결하다.

인증은 컨트롤러 호출 전에만 호출하면 되기 때문에 preHandle만 구현하면 된다. 이렇게 호출 범위가 다양해 한 번에 다 구현해야 하는 필터에 비해 더 유연하다.

그리고 인터셉터를 적용할 부분과 아닌 부분을 따로 구현해 줄 필요 없이 편리하게 구분해 적용할 수 있다는 장점도 있다.

정리

서블릿 필터와 스프링 인터셉터는 둘 다 웹과 관련된 공통 관심사를 해결하기 위한 기술이다. 서블릿 필터와 비교해 스프링 인터셉터가 개발자 입장에서는 훨씬 편리하다는 것을 보았다.

따라서 특별한 문제가 없다면 스프링 인터셉터를 이용하자.

+ ArgumentResolver 활용

ArgumentResolver 학습

요약하자면 애노테이션 기반 컨트롤러는 다양한 파라미터를 사용할 수 있는데 이러한 파라미터를 유연하게 처리해주는 것이다.

이 RequestMapping 어댑터 내부의 ArgumentResolver를 직접 구현하여 활용해 로그인 회원을 조금 더 편리하게 찾아본다. (이렇게 로그인 관련해서 처리할 때 적절해서 설명하는 것.)

1
2
3
4
5
6
7
8
9
10
@GetMapping("/")  
public String homeLoginV4ArgumentResolver(@Login Member loginMember, Model model) {  
  
	if (loginMember == null) {  
	return "home";  
	}  
	  
	model.addAttribute("member", loginMember);  
	return "loginHome";  
}

@Login 애노테이션을 통해 로그인 된 멤버를 쉽게 가져오도록 한다. 위의 코드는 HomeController에서 활용한 것이지만 다른 로직을 구현할 때 로그인 멤버가 필요하다면 그 때 @Login 애노테이션 하나만으로 가져올 수 있다.

1
2
3
4
5
// /web/argumentresolver/Login
@Target(ElementType.PARAMETER)  
@Retention(RetentionPolicy.RUNTIME)  
public @interface Login {  
}

애노테이션을 만들었다고 적용되는 것이 아니다. 이 상태만으로 실행한다면 위 홈 컨트롤러의 loginMember는 @ModelAttribute가 생략된 버전으로 적용될 것이다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
// /web/argumentresolver/LoginMemberArgumentResolver

@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가 사용된다.
    • boolean hasLoginAnnotation = parameter.hasParameterAnnotation(Login.class);
      • @Login 애노테이션이 붙어있는지.
    • boolean hasMemberType = Member.class.isAssignableFrom(parameter.getParameterType());
      • @Login 애노테이션이 붙은 객체가 Member 객체인지.
  • resolveArgument() : 컨트롤러 호출 직전에 호출되어 파라미터 정보를 생성해준다.
    • supportsParameter()가 true일 경우 실행된다.
    • 위 코드에서는 세션에 있는 로그인 회원 정보인 member 객체를 찾아 반환해준다.
1
2
3
4
@Override  
public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {  
	resolvers.add(new LoginMemberArgumentResolver());  
}

WebConfig에 위 코드를 추가해 설정 추가해주면 사용된다.

정리

실행 결과는 동일하다. 하지만 아래 코드를 보자.

1
2
3
4
5
6
7
8
9
10
@GetMapping("/")  
public String homeLoginV3Spring(@SessionAttribute(name = SessionConst.LOGIN_MEMBER, required = false) Member loginMember, Model model) {  
  
	if (loginMember == null) {  
	return "home";  
	}  
	  
	model.addAttribute("member", loginMember);  
	return "loginHome";  
}

직접 @Login 구현 전 처리 방식이다. 훨씬 간결하게 가져올 수 있는 것을 알 수 있다. 물론 이 기능만 보면 위와 같은 전 방식이 구현에 드는 시간이나 복잡성은 줄어든다.

하지만 공통 작업이 필요하다면 이렇게 애노테이션을 직접 만들고 알맞게 구현하여 컨트롤러를 더욱 편리하게 사용할 수 있다.

충분히 많이 사용되는 기술이다. 필요하다면 응용해서 사용하자.

This post is licensed under CC BY 4.0 by the author.