[Spring MVC] 스프링 MVC - 로그인 (필터, 인터셉터)

개요

---

대부분 많은 웹 서비스는 로그인을 해야 서비스를 이용할 수 있다.

로그인을 하지 않은 사용자는 접근할 수 있는 페이지가 제한적이며, 로그인이 필요한 페이지 접근이 허용돼서는 안된다. 하지만 로그인이 필요한 모든 컨트롤러 로직에 로그인 여부를 확인하는 코드를 작성하는 것은 너무 비효율적이다.

이렇게 애플리케이션 여러 로직에서 공통으로 관심이 있는 있는 것을 공통 관심사(cross-cutting concern)라고 한다. 여기서는 등록, 수정, 삭제, 조회 등등 여러 로직에서 공통으로 인증에 대해서 관심을 가지고 있다.

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

서블릿 필터 vs 스프링 인터셉터

---

서블릿 필터와 스프링 인터셉터 모두 웹과 관련된 공통 관심사를 처리하는 데 사용되는 기술이다.

필터는 서블릿에서 제공하고 인터셉터는 스프링 MVC가 제공하는 기술인데, 적용되는 순서와 범위, 그리고 사용방법이 다르다.

필터와 인터셉터의 흐름

• 필터를 적용하면 필터가 호출된 이후 서블릿이 호출된다.
  • 여기서 서블릿은 스프링의 경우 디스패처 서블릿을 의미.

• 인터셉터를 적용하면 디스패처 서블릿과 컨트롤러 사이에서 컨트롤러 호출 직전에 호출된다.
• 인터셉터는 서블릿에서 예외가 발생한다면 호출되지 않는다.

필터와 인터셉터의 제한

• 필터와 인터셉터는 각각 요청이 적절하지 않을 경우 자신의 상태에서 종료할 수 있다.
• 필터는 서블릿까지도 가지 못하지만, 스프링 인터셉터는 서블릿까진 통과 후 제한된다.

필터와 인터셉터 체인

• 둘 다 자유롭게 필터 및 인터셉터를 추가할 수 있다.
• 로그를 남기는 필터(혹은 인터셉터)를 적용 후 그다음 로그인 여부를 체크하는 필터(혹은 인터셉터)를 만들어 적용할 수 있다.

여기까지 보면 호출 시점이 서블릿 호출 전/후의 차이를 빼면 별 차이가 없어 보인다.
하지만, 스프링 인터셉터는 좀 더 편하고 정교하며 다양한 기능을 제공한다.

서블릿 필터

---

필터 인터페이스

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, destroy 메서드는 default 메서드 이기에 따로 구현하지 않아도 된다.

• init() : 필터 초기화 메서드로 서블릿 컨테이너가 생성될 때 호출된다.
• doFilter() : 고객의 요청이 올 때마다 해당 메서드가 호출된다.
• destroy() : 필터 종료 메서드, 서블릿 컨테이너가 종료될 때 호출된다.

API 요청 로그 필터 구현

모든 요청에 대해 로그를 남기는 필터를 구현해 보자.

@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");
    }
    
}

• Filter 인터페이스를 구현하며 init, doFilter, destroy 메서드를 재정의해 준다.

• doFilter(ServletRequest request, ServletResponse response, FilterChain chain)

  • HTTP 요청이 오면 doFilter가 호출된다.
  • ServletRequest request는 HTTP 요청이 아닌 경우도 고려해서 만든 인터페이스이다. HTTP를 사용하면 HttpServletRequest로 다운 캐스팅한 뒤 사용하면 된다.
  
  
  • UUID.randomUUID().toString()
    • HTTP 요청을 구분하기 위해 요청당 임의의 uuid를 만든다. UUID로 만드는 값이 중복될 일은 거의 없다.
  
  
  • chain.doFilter(request, response);
    • 가장 중요하다. 다음 필터가 있으면 다음 필터를 호출하고 필터가 없으면 서블릿을 호출한다. 만약 이 로직을 호출하지 않으면 다음 단계로 진행되지 않는다.

WebConfig

필터를 만들기만 한다고 자동으로 등록되지는 않기에 Configuration을 만들어 해당 필터를 등록해 주도록 하자.

@Configuration
public class WebConfig implements WebMvcConfigurer {

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

}

• setFilter(new LogFilter) : 등록할 필터를 지정한다.

• setOrder(1) : 필터는 체인으로 동작하기에 순서가 필요하다. 순서가 낮을수록 먼저 동작한다.

• addUrlPatterns("/*") : 필터를 적용할 URL 패턴을 지정하며, 하나 이상의 패턴을 지정할 수도 있다.

로그인 인증 체크 필터

이번에는 실제로 로그인 인증 체크 필터를 만들어보자.

whitelist로 지정한 경로를 제외하고는 모두 로그인 상태를 검사 후 페이지 접근 여부를 결정한다.

@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);
                    httpResponse.sendRedirect("/login?redirectURL=" + requestURI);
                    
                    return;
                }
            }
            chain.doFilter(request, response);

        } catch (Exception e) {
            throw e;
        } finally {
            log.info("인증 체크 필터 종료 {}", requestURI);
        }
    }

    // whiteList의 경우 인증 체크 X
    private boolean isLoginCheckPath(String requestURI) {
        return !PatternMatchUtils.simpleMatch(whitelist, requestURI);
    }

}

• private static final String[] whitelist = {"/", "/members/add", ...};

  • 모든 곳에 로그인이 되어있어야 하는 건 아니다. 정적 리소스와 로그인, 로그아웃의 경우 로그인을 하지 않아도 접근이 가능해야 한다. whitelist를 이용해 이러한 경로 검사를 해 준다.

• isLoginCheckPath(String requestURI)

  • 매개변수로 전달받은 requestURI가 whitelist와 일치하는지 검사한다.
    이때 PatternMatchUtils라는 정적 헬퍼 클래스를 이용하여 쉽게 경로 검사가 가능하다.

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

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

  • 예를 들어서 상품 관리 화면을 보려고 들어갔다가 로그인 화면으로 이동하면, 로그인 이후에 다시 상품 관리 화면으로 들어가는 것이 좋다. 이런 부분이 개발자 입장에서는 좀 귀찮을 수 있어도 사용자 입장으로 보면 편리한 기능이다.

  • 이러한 기능을 위해 현재 요청한 경로인 requestURI를 /login에 쿼리 파라미터로 함께 전달한다. 물론 /login 컨트롤러에서 로그인 성공 시 해당 경로로 이동하는 기능은 추가로 개발해야 한다

• return;

  • 필터가 더 이상 진행하지 않는다. redirect를 사용했기에 redirect가 응답으로 적용되고 요청이 끝난다.

WebConfig 설정

작성한 로그인 인증 검사 필터를 설정에 등록하자.

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

    return filterRegistrationBean;
}

• 허용 URL은 /*으로 전부 허용을 해 준 상태이다.
  필터 내부에 화이트리스트가 있기 때문에 검사가 불필요한 경로는 검사하지 않는다.

LoginV4 컨트롤러

로그인에 성공하면 처음 요청한 URL로 이동하는 기능을 구현해 보자.

@PostMapping("/login")
public String loginV4(@Valid @ModelAttribute LoginForm form,
					  BindingResult bindingResult,
					  @RequestParam(defaultValue = "/") String redirectURL,
					  HttpServletResponse response,
					  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);

    if (redirectURL != null) {
        return "redirect:" + redirectURL;
    }

    return "redirect:/";
}

✅ 정리

서블릿에서 제공하는 필터 기능을 사용해 로그인을 하지 않은 유저의 접근 권한을 제한시킬 수 있고,

로그인 유효성 검증이라는 공통 관심사를 묶어 중복되는 코드들을 하나로 모아 관리하기에도 편하고 가독성도 높은 간결한 코드가 완성되었다. 만약 로그인 정책이 변경되거나 새로운 whitelist가 추가되어도 이제 필터 부분만 수정하면 된다.

스프링 인터셉터

---

웹과 관련된 공통 관심 사항을 관리하기 위해 서블릿에 필터가 있다면 스프링에는 인터셉터가 있다.

스프링 인터셉터는 스프링 MVC가 제공하는 기술로 서블릿 필터와 스프링 인터셉터 둘 다 공통 관심사항을 처리한다는 공통점을 가지고 있지만 적용되는 순서와 범위, 그리고 사용 방법이 다르다.

스프링 인터셉터 인터페이스

스프링의 인터셉터를 사용하려면 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 하나로 로직을 수행하는 서블릿 필터와는 다르게 인터셉터는 다음과 같이 3가지 단계로 세분화되어 있다.

1. 컨트롤러 호출 전, preHandler
2. 컨트롤러 호출 후, postHandle
3. 요청 완료 이후, afterCompletion

스프링 인터셉터 호출 흐름

• preHandler : 컨트롤러 호출 전에 호출되며 반환 타입은 Boolean 이다.
  즉, 반환 값이 false이면 그 뒤는 진행하지 않는다.

• postHandler : 컨트롤러 호출 후 호출되며 정확히는 핸들러 어댑터 호출 후 호출된다.

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

예외 발생

스프링 인터셉터 혹은 컨트롤러에서 예외가 발생하면 각 시점에 따라 호출 여부가 달라진다.

• preHandle은 컨트롤러 호출 전에 호출된다.

• postHandler은 컨트롤러에서 예외가 발생하면 postHandler은 호출되지 않는다.

• afterCompletion은 항상 호출된다. (try-catch의 finally처럼) 그렇기에 이전에 발생한 예외가 있을 경우 이를 파라미터로 받아서 어떤 예외가 발생했는지 확인할 수 있다.

• 예외가 발생하면 postHandle()는 호출되지 않으므로 예외와 무관하게 공통 처리를 하려면
  afterCompletion()을 사용해야 한다.

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

스프링 인터셉터 구현

인터셉터 구현은 HandlerInterceptor를 구현하면 된다. 로그를 남기는 스프링 인터셉터를 구현해 보자.

@Slf4j
public class LoginInterceptor 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("pohstHandler [{}]", 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("RESPONSE [{}][{}][{}]", uuid, requestURI, handler);

        if (ex != null) {
            log.error("afterCompletion error:", ex);
        }
        
    }

• reqeust.setAttribute(LOG_ID, uuid)

  • 서블릿 필터와는 다르게 스프링 인터셉터는 호출 시점이 분리되어 있기에 각각의 메서드가 호출되는 시점에 변수들의 값 유지가 되지 않는다. 그렇기에 preHandler에서 지정한 값을 postHandler이나 * * afterCompletion에서 사용하려면 어딘가에 담아둬야 하는데, 이 인터셉터는 싱글톤처럼 사용되기에 멤버 변수를 사용하면 안 된다. 그렇기에 값을 request 인스턴스에 담아두었다.
    위 코드에서 request에 담은 LOG_ID(uuid)는 afterCompletion에서 getAttribute로 찾아 사용한다.

• HandlerMethod hm = (HandlerMethod) handler;

  • 스프링에서는 일반적으로 @Controller, @RequestMapping을 활용해 핸들러 매핑을 사용하는데, 이 경우 스프링 인터셉터의 Object handler 매개변수에는 핸들러 정보로 HandlerMethod가 넘어온다.

WebConfig

스프링 인터셉터(LogInterceptor)를 설정에 등록해 주도록 하자.

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(loginInterceptor())
                .order(1)
                .addPathPatterns("/**")
                .excludePathPatterns("/css/**", "/*.ico", "/error");
    }

    @Bean
    public LoginInterceptor loginInterceptor() {
        return new LoginInterceptor();
    }
    
}

• WebMvcConfigurer 인터페이스를 구현하여 addInterceptor 메서드를 재정의해서 인터셉터 등록이 가능하다.

• addInterceptor : 인터셉터를 등록한다.
• order(1) : 인터셉터의 호출 순서를 지정하며 낮을수록 먼저 호출된다.
• addPathPatterns("/**") : 인터셉터를 적용할 URL 패턴을 지정한다.
• excludePathPatterns("/css/**", "/*.ico", "/error") :인터셉터에서 제외할 패턴을 지정한다.

ArgumentResolver 활용

---

클라이언트로부터 받은 Request 정보에서 Session 정보를 꺼내 해당하는 세션 키로 로그인 정보를 찾는 방법을 다양하게 사용 해보았다. 기존에는 직접 HttpServletRequest 객체에서 꺼내는 방식과 애노테이션을 활용했었다.

HttpServletRequest에서 직접 꺼내기

@GetMapping("/")
public String homeLoginV3(HttpServletRequest request, Model model) {
    HttpSession session = request.getSession(false);
	// ...
    Member loginMember = (Member) session.getAttribute(SessionConst.LOGIN_MEMBER);
	// ...
}

@SessionAttribute 애노테이션 활용

public String homeLoginV3Spring(
        @SessionAttribute(name = SessionConst.LOGIN_MEMBER, required = false)Member loginMember,
        HttpServletRequest request, Model model) {

    if (loginMember == null) {
        return "home";
    }

    model.addAttribute("member", loginMember);
    
    return "loginHome";
}

애노테이션 기반의 매핑 방식도 직접 로직을 구현하는 것보다 간결하다. 하지만, 여기도 매번 속성들(name, required)를 작성해 주는 건 번거롭고 해당 애노테이션을 통해 해당 객체에 대한 명시성이 부족하다.

지금 매핑하는 객체는 로그인한 사용자의 정보(Member)인데 이를 @Login이라는 애노테이션을 직접 만들어 매핑해주는 로직을 구현하면 사용자 입장에서 사용하기도 편하고 가독성도 높아질 것이다.

이를 위해서는 요청 매핑 핸들러 어댑터에 대해 이해가 필요하다.

우리가 ArgumentResolver를 사용해서 만들 애노테이션기능은 자동으로 세션에 있는 로그인 회원을 찾아주되 만약 세션에 없을 경우 Null을 반환하도록 만들 것이다.

@Login

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

}

• @Target(ElementType.PARAMETER) : 파라미터에만 붙일 수 있는 애노테이션이다.
• @Retention(RetentionPolicy.RUNTIME) : 리플렉션 등을 활용할 수 있도록 런타임까지 애노테이션 정보가 남아있도록 해준다.

LoginMemberArgumentResolver

ArgumentResolver는 HandlerMethodArgumentResolver를 구현하면 된다.

@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("resolverArgument 실행");

        HttpServletRequest request = (HttpServletRequest) webRequest.getNativeRequest();
        HttpSession session = request.getSession(false);
        if (session == null) {
            return null;
        }

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

• supportsParameter()

  • 컨트롤러 호출 시 각 매개변수들은 ArgumentResolver에 의해 매핑이 되는데, 많은 ArgumentResolver가 각각 대응할 수 있는 객체는 제한되어 있을 것인데, 이를 책임 사슬 패턴을 이용해 처리하는데, 각각의 ArgumentResolver는 이 메서드(supportsParameter())를 이용해 매핑 가능 여부를 Boolean 타입으로 반환한다.
    여기서는 @Login 애노테이션이 붙어있고 Member 객체인 경우 지원이 가능하다고 로직을 구현했다.

• resolverArgument()

  • 실제로 컨트롤러에 필요한 파라미터 정보를 생성해 주는 메서드로, 여기서는 세션에서 로그인 회원 정보인 member 객체를 찾아 반환해 준다.

WebConfig

Filter나 Interceptor와 마찬가지로 WebMvcConfigurer에 리졸버를 등록해 줘야 한다.

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
        resolvers.add(new LoginMemberArgumentResolver());
    }

	// ...
}

✅ 정리

애노테이션을 활용하면 더 명시적이고 간결하게 회원정보를 찾아서 매핑해줄 수 있다.

만약 회원 객체(Member)의 구조가 바뀐다면 Resolver 쪽만 수정해 주면 된다. 직접 객체 매핑 로직을 구현하면 코드가 너무 길고 차후 후임자나 다른 개발자가 보기도 쉽지 않다.

@SessionAttribute 애노테이션을 활용하면 좀 나아지지만 목적 자체가 로그인 정보를 찾는다는 특정 목적의 애노테이션이 아니기 때문에 이 역시 다른 개발자가 볼 때 단번에 이해하기는 힘들고, name이 명확하지 않으면 세션의 이 정보를 어째서 조회하는지에 대해 한 번에 이해하기 어렵다.

하지만 ArgumentResolver를 이용해 애노테이션으로 요청 매핑 핸들러 어댑터를 구현해 주면 하나의 특정 애노테이션으로 가독성도 좋고 편리하게 회원 정보를 조회할 수 있다.