#7 로그인 처리 - 필터, 인터셉터

로그인 처리 - 필터, 인터셉터

앞서 만들었던 상품 관리 서비스에서 상품 관리 페이지와 같은 경우 로그인 한 사용자만 이용할 수 있어야 한다.

지금까지 개발한 로그인 서비스에서는 로그인 하지않은 사용자에게는 상품 관리 버튼이 보이지 않기 때문에 문제가 없어 보인다.

 

[홈 화면 - 로그인 상태]

문제는 로그인 하지 않은 사용자도 다음 URL을 직접 호출하면 상품 관리 화면에 들어갈 수 있다는 것이다.

 

http://localhost:8080/items

 

상품 관리 컨트롤러에서 로그인 여부를 하나하나 작성하면 되지만, 등록, 수정, 삭제, 조회 등 상품관리의 모든 컨트롤러에 공통으로 로그인 여부를 확인하는것은 매우 번거롭다.

 

이러한 공통 관심사는 스프링의 AOP로도 해결할 수 있지만, 웹과 관련된 공통 관심사는 서블릿 필터 또는 스프링 인터셉터를 사용하는 것이 좋다.

웹과 관련된 공통 관심사를 처리할 때는 HTTP의 헤더나 URL의 정보들이 필요한데, 필터나 인터셉터는 HttpServletRequest를 제공한다.

 

 

 

 

1. 서블릿 필터

필터는 서블릿이 지원하는 수문장 역할을 하는 기술이다. 

 

필터의 흐름은 다음과 같다.

 

[필터 흐름]

 

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

필터를 적용하면 필터가 호출 된 다음에 서블릿(디스패처 서블릿)이 호출된다.

 

[필터 제한]

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

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

이런 특성 때문에 로그인 여부를 체크하기 적합하다.

 

[필터 체인]

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

필터는 체인으로 구성되는데, 중간에 필터를 자유롭게 추가할 수 있다. 

예를 들어 로그를 남기는 필터를 먼저 적용하고, 그 다음에 로그인 여부를 체크하는 필터를 만들 수 있다.

 

필터의 인터페이스는 다음과 같다.

 

[필터 인터페이스 - Filter]

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() : 고객의 요청이 올 때 마다 해당 메서드가 호출된다. 필터의 로직을 구현하면 된다. 

ServletRequest request는 HTTP 요청이 아닌 경우까지 고려해서 만든 인터페이스이다.

HTTP를 사용하면 (HttpServletRequest) request; 와 같이 다운 캐스팅하면 된다.

 

● destroy() : 필터 종료 메서드, 서블릿 컨테이너가 종료될 때 호출된다.

 

 

 

■ 서블릿 필터 적용 - 로그인 체크

서블릿 필터를 적용해서 로그인 체크를 구현한다.

 

[체크 인증 필터]

@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 {
			if (isLoginCheckPath(requestURI)) {
				HttpSession session = httpRequest.getSession(false);
			
				if (session == null || 
                	session.getAttribute(SessionConst.LOGIN_MEMBER) == null) {
    			//로그인으로 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 = {...}

◎ 인증 필터를 적용해도 홈, 회원가입, 로그인 화면, css같은 리소스에는 접근할 수 있어야한다. 때문에 whitelist로 별도로 해당 경로들을 모아서 whitelist에 있는 경로는 인증과 무관하게 항상 허용한다.

 

● isLoginCheckPath(requestURI)

◎ 화이트 리스트를 제외한 모든 경우에 인증 체크 로직을 적용한다.

 

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

◎ 미인증 사용자는 로그인 화면으로 리다이렉트한다. 그런데 로그인 이후에 다시 홈으로 이동해버리면 사용자가 원하는 경로를 다시 처음부터 찾아가야하는 불편함이있다. 

예를들어 상품 관리 화면을 보려고 들어갔다가 로그인 화면으로 이동해서 로그인을 하면 다시 상품 관리 화면으로 돌아가는것이 사용자 입장에서 편리할것이다.

이런 기능을 위해 현재 요청한 경로인 requestURI를 /login에 쿼리 파라미터로 함께 전달한다.

이후 /login 컨트롤러에서 로그인 성공시 해당 경로로 이동하는 기능을 추가하면 된다.

 

● return

◎ return을 하면 더이상 필터를 진행하지 않는다. 이후 필터는 물론 서블릿, 컨트롤러가 더는 호출되지 않는다.

위 예시의 필터는 redirect를 사용했기 때문에 redirect가 응답으롤 적용되고 요청이 끝난다.

 

● chain.doFilter(request, response)

◎ 다음 필터가 있으면 필터를 호출하고, 필터가 없으면 서블릿을 호출한다.

만약 이 로직을 호출하지 않으면 다음 단계로 진행되지 않는다.

 

필터를 등록하는 방법은 여러가지가 있지만, 스프링 부트를 사용한다면 FilterRegistrationBean을 사용해서 등록하면 된다.

 

[WebConfig - loginCheckFilter() 추가]

@Bean
public FilterRegistrationBean loginCheckFilter() {
	FilterRegistrationBean<Filter> filterRegistrationBean = new FilterRegistrationBean<>();
	filterRegistrationBean.setFilter(new LoginCheckFilter());
	filterRegistrationBean.setOrder(1);
	filterRegistrationBean.addUrlPatterns("/*"); 
	return filterRegistrationBean;
}

 

● setFilter(new LoginCheckFilter()) : 로그인 필터를 등록한다.

● setOrder(1) : 순서를 1번으로 한다. 숫자가 낮을수록 먼저 호출된다.

● addUrlPatterns("/*") : 모든 요청에 로그인 필터를 적용한다.

 

로그인에 성공하면 처음 요청한 URL로 이동하는 기능을 개발한다.

 

[LoginController - 회귀 기능 추가]

@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);
	
    //redirectURL 적용
	return "redirect:" + redirectURL; 
}

@RequestParam(기본 값 "/")으로 redirectURL을 받고 반환할 논리 뷰 이름에 추가해준다.

 

※ 서블릿 필터는 스프링 인터셉터에서는 제공하지 않는 추가적인 기능이있다.

chain.doFilter(request, response); 를 호출해서 다음 필터 또는 서블릿을 호출할 때 request, response를 다른 객체로 바꿀 수 있다.

ServletRequest, ServletResponse를 구현한 다른 객체를 만들어서 넘기면 해당 객체가 다음 필터 또는 서블릿에 사용된다.

 

 

 

 

2. 스프링 인터셉터

스프링 인터셉터도 서블릿 필터와 같이 웹과 관련된 공통 관심 사항을 효과적으로 해결할 수 있다.

 

[스프링 인터셉터 흐름]

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

스프링 인터셉터는 디스패처 서블릿과 컨트롤러 사이에서 컨트롤러 호출 직전에 호출 된다.

 

[스프링 인터셉터 제한]

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

인터셉터에서 적절하지 않은 요청이라고 판단하면 그 시점에서 요청을 끝낼 수 있다.

이런 특성 때문에 로그인 여부를 체크하기에 적합하다.

 

[스프링 인터셉터 체인]

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

스프링 인터셉터도 필터와 같이 체인으로 구성된다.

따라서 중간에 인터셉터를 자유롭게 추가할 수 있다.

 

스프링 인터셉터의 인터페이스는 다음과 같다.

 

[스프링 인터셉터 인터페이스 - HadlerInterceptor]

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)와 가이 단계적으로 세분화 되어 있다.

인터셉턴는 디스패처 서블릿 이후에 호출되기 때문에 어떤 컨트롤러(handler)가 호출되는지, 어떤 modelAndView가 반환되는지 응답 정보도 받을 수 있다.

 

[스프링 인터셉터 호출 흐름]

 

● preHandle

◎ 핸들러 어뎁터 호출 전에 호출된다. 

◎ 반환 값이 ture이면 다음으로 진행하고, false이면 더는 진행하지 않는다.

◎ false인 경우 나머지 인터셉턴는 물론이고, 핸들러 어댑터도 호출되지 않는다.

 

● postHandel : 컨트롤러 호출 후에 호출된다.

 

● afterCompletion : 뷰가 렌더링 된 이후에 호출된다.

 

컨트롤러에서 예외가 발생했을 경우 preHandle과 afterCompletion은 호출되는 반면, postHandle은 호출되지 않는다.

afterCompletion은 항상 호출 되기 때문에 예외와 무관하게 공통 처리를 하려면 afterCompletion을 사용해야 한다.

 

 

 

■ 스프링 인터셉터 적용 - 로그인 체크

스프링 인터셉터를 적용해 로그인 체크 서비스를 구현한다.

 

[LoginCheckInterceptor]

@Slf4j
public class LoginCheckInterceptor implements HandlerInterceptor {

@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) 
	throws Exception {
	
	String requestURI = request.getRequestURI();         
	
	HttpSession session = request.getSession(false);

	if (session == null || session.getAttribute(SessionConst.LOGIN_MEMBER) == null) {
		//로그인으로 redirect
		response.sendRedirect("/login?redirectURL=" + requestURI);
		return false; 
	}
      
	return true;
	}
}

로그인 예외 경로를 처리하지 않아서 서블릿 필터에 비해 코드가 간결하다.

로그인 체크는 컨트롤러 호출 전에만 호출하면 되기 때문에 preHandle만 구현하면 된다.

 

[WebConfig - 스프링 인터셉터]

@Configuration
public class WebConfig implements WebMvcConfigurer {
	@Override
	public void addInterceptors(InterceptorRegistry registry) {

		registry.addInterceptor(new LoginCheckInterceptor())
			.order(2)
			.addPathPatterns("/**") 
			.excludePathPatterns("/", "/members/add", "/login", "/logout", "/css/**", 
				"/*.ico", "/error");
	}
}

WebMvcConfigurer가 제공하는 addInterceptors()를 사용해서 인터셉터를 등록할 수 있다.

 

● registry.addInterceptor(new LoginCheckInterceptor()) : 인터셉터를 등록한다.

● order(1) : 인터셉터의 호출 순서를 지정한다. 낮을 수록 먼저 호출된다.

● addPathPatterns(...) : 인터셉터를 적용할 URL 패턴을 지정한다.

● excludePathPtterns(...) : 인터셉터에서 제와할 패턴을 지정한다.

 

 

 

 

3. ArgumentResolver 활용

컨트롤러에서 다양한 매개변수를 받게 해주는 ArgumentResolver를 사용해 로그인 회원을 좀 더 편하게 찾을 수 있다.

 

첫 번째로, @Login 애노테이션을 개발한다.

 

두 번째로, @Login 애노테이션이 있으면 직접 만든 ArgumentResolver가 동작해서 자동으로 세션에 있는 로그인 회원을 찾아서 반환하고, 만약 세션이 없거나 회원이 없다면 null을 반환하도록 개발한다.

 

[@Login 애노테이션 생성]

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME) 
public @interface Login {
}

 

● @Target(ElementType.PARAMETER) : 파라미터에서만 사용

● @Retention(RetentionPolicy.RUNTIME) : 리플렉션 등을 활용할 수 있는 런타임까지 애노테이션 정보가 남아있는다.

 

[LoginMemberArgumentResolver 생성]

@Slf4j
public class LoginMemberArgumentResolver implements HandlerMethodArgumentResolver {
	
	@Override
	public boolean supportsParameter(MethodParameter parameter) {
   
		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 {

		HttpServletRequest request = (HttpServletRequest) webRequest.getNativeRequest();
		HttpSession session = request.getSession(false);

		if (session == null) {
			return null; 
		}

		return session.getAttribute(SessionConst.LOGIN_MEMBER); 
	}
}

 

● supportsParameter()

◎ @Login 애노테이션이 있으면서 Member 타입이면 해당 ArgumentResolver가 사용된다.

 

● resolveArgument()

◎ 컨트롤러 호출 직전에 호출 되어서 필요한 파라미터 정보를 생성해준다.

◎ 스프링 MVC는 컨트롤러의 메서드를 호출하면서 여기에서 반환된 member 객체를 파라미터에 전달해준다.

 

[WebMvcConfigurer 추가]

@Configuration
public class WebConfig implements WebMvcConfigurer {
	
	@Override
	public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
		resolvers.add(new LoginMemberArgumentResolver());
	}

	//...
}

앞서 개발한 LoginMemberArgumentResolver()는 WebMvcConfigurer을 상속받아 addArgumentResolvers에 추가하면 된다.