로그인 처리 - 필터 / 인터셉터 (1) (필터 개념 및 예제 코드)

로그인 기능이 존재하는 웹 사이트 내에서는 인증 뿐만 아니라 인가 기능이 필요하다.

인가 기능이란, 인증이 된 사용자만 특정 웹 페이지에 접근한 기능이다.

 

예를 들어보자면, 쇼핑몰 웹 사이트 내에서 로그인을 하지 않은 사용자는 상품을 주문할 수 없다. 로그인을 한 사용자만 상품을 주문할 수 있다.

 

따라서, 등록 / 수정 / 삭제 / 조회 등등 모든 컨트롤러 로직에 공통으로 로그인 여부를 확인해야 한다. 

그럼 로그인 여부를 체크하는 로직을 하나 하나 모든 페이지 내에 등록해야하는 것일까? 

만약 그렇게 한다면 향후 로그인과 관련된 로직이 변경될 때마다 모든 로직을 수정해야할 수도 있다.

 

이렇게 애플리케이션 여러 로직에서 공통으로 관심이 있는 것을 공통 관심사(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() : 필터 종료 메서드, 서블릿 컨테이너가 종료될 때 호출된다

 

 

 

 

 

[ 서블릿 필터 - 인증 체크 ]

@Log4j2
public class LoginFilter implements Filter {

    private static final String[] whiteList = {
            "/", "/members/add", "/login", "/logout", "/css/*"
    };

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain chain) throws IOException, ServletException {

        HttpServletRequest request = (HttpServletRequest) servletRequest;
        String requestURI = request.getRequestURI();

        HttpServletResponse response = (HttpServletResponse) servletResponse;

        try{
            log.info("인증 체크 필터 시작 {}", requestURI);

            if(isLoginCheckPath(requestURI)){
                log.info("인증 체크 로직 실행 {}", requestURI);
                HttpSession session = request.getSession(false);
                if(session == null || session.getAttribute(SessionConst.LOGIN_MEMBER) == null){
                    log.info("미인증 사용자 요청 {}", requestURI);

                    // 미인증 사용자 요청이기 때문에 redirect 시키면 된다.
                    response.sendRedirect("/login?redirectURL=" + requestURI);
                    return;
                }
            }

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

    }

    /**
     * 화이트 리스트의 경우 인증 체크 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() 추가 ]

@Bean
public FilterRegistrationBean loginCheckFilter(){

        FilterRegistrationBean<Filter> filterFilterRegistrationBean = new FilterRegistrationBean<>();
        
        filterFilterRegistrationBean.setFilter(new LoginFilter());
        filterFilterRegistrationBean.setOrder(1);
        filterFilterRegistrationBean.addUrlPatterns("/*");

        return filterFilterRegistrationBean;
}

• setFilter(new LoginCheckFilter()) : 로그인 필터를 등록한다.
• setOrder(1) : 필터 순서를 1번으로 지정, 가장 먼저 로그인 체크 여부를 진행한다.
• addUrlPatterns("/*") : 모든 요청에 로그인 필터를 적용한다.

 

 

 

 

[ RedirectURL 처리 ]

로그인에 성공하면 처음 요청한 URL로 이동하는 기능

@PostMapping("/login")
public String login(@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;
}

• 로그인 체크 필터에서, 미인증 사용자는 요청 경로를 포함해서 /login에 redirectURL 요청 파라미터를 추가해서 요청한다.
• 이 값을 사용해서 로그인 성공시 해당 경로로 사용자를 redirect한다.

 

 

 

[ 정리 ]

서블릿 필터를 잘 사용한 덕분에 로그인 하지 않은 사용자는 나머지 경로에 들어갈 수 없게 되었다. 공통 관심사를 서블릿 필터를 사용해서 해결한 덕분에 향후 로그인 관련 정책이 변경되어도 이 부분만 변경하면 된다.

 

 

[ 참고 ]

필터에는 다음에 설명할 스프링 인터셉터는 제공하지 않는, 아주 강력한 기능이 있는데  chain.doFilter(request, response); 를 호출해서 다음 필터 또는 서블릿을 호출할 때 request , response 를 다른 객체로 바꿀 수 있다. ServletRequest , ServletResponse 를 구현한 다른 객체를 만들어서 넘기면 해당 객체가 다음 필터 또는 서블릿에서 사용된다.잘 사용하는 기능은 아니다.