[Spring] 로그인 처리2 - 필터, 인터셉터 - 1

내가 공부한것을 올리며, 중요한 단원은 저 자신도 곱씹어 볼겸 상세히 기록하고 얕은부분들은 가겹게 포스팅 하겠습니다.

 

1. 서블릿 필터 - 요청 로그

필터를 사용하여 사용자의 모든 요청에 로그를 남겨보자.

 

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

 

사용자 정의 필터를 만들기 위해서는 Filter 인터페이스를 구현해야 한다.

Filter 인터페이스를 구현할때는 init(), doFilter(), destroy()를 오버라이딩 하게 된다.

 

Http 요청이 오면 다음 doFilter가 호출되게 된다.

public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)

 

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

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

 

- UUID 생성

또한 사용자를 구분해주기 위해서 UUID를 할당받았다.

나중에 log를 출력할때 이를 활용하면 사용자를 구별하기가 쉬워진다.

log.info("REQUEST [{}][{}]", uuid, requestURI);

 

- chain.doFilter(request, response);

가장 중요한 부분인데, 위 코드의 try 문 안에서 호출되는 doFilter는 필터가 있으면 호출하고, 없으면 서블릿을 호출하게 된다.

만약 이부분을 호출해주지 않는다면 다음 단계로 진행할수가 없다.

 

● 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 패턴을 지정한다. 한번에 여러 패턴을 지정할 수 있다.

 

실행시 다음과 같이 로그를 확인할수가 있다.

 

2. 서블릿 필터 - 인증 체크

우리의 상품등록 싸이트는 로그인하지 않은 사용자가 접근 가능한 상황이다.

인증 체크 필터를 구현하여 로그인 되지 않은 사용자가 상품관리나 다른 인증이 필요한 페이지에 접근하려 할때 로그인을 하도록 구현해 보자.

 

● LoginCheckFilter - 인증 체크 필터

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

 

- 화이트 리스트를 다음과 같이 지정하였다.

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

 

위 URI에는 인증 없이도 접근이 가능해야 한다. 로그인을 안해도 홈, 회원가입, 로그인 화면, css 같은 리소스에는 접근이 가능해야 하기 때문이다.

화이트 리스트는 항상 접근이 가능하도록 허용한다. 화이트 리스트를 제외한 나머지 경로에만 인증체크 로직을 적용하면 된다.

 

- 화이트 리스트 체크

private boolean isLoginCheckPath(String requestURI){
    return !PatternMatchUtils.simpleMatch(whitelist, requestURI);
}

 

- 로그인 성공후 redirect하기

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

 

어떤 사용자가 items 페이지에 접근하려 했다고 하자. 필터에 걸려 로그인 페이지로 이동하게 되었고, 로그인을 한 후, home 화면으로 돌아가게 되버리면 사용자 입장에서는 불편하다.

로그인을 했으면 원래 이동하려 했던 items 페이지로 이동해주어야 사용자 입장에서 사용하기 편하다.

 

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

이후 /login 컨트롤러에서 이를 활용하여 해당 경로로 이동해주어야 한다.

 

- return

여기가 중요하다. 필터를 더는 진행하지 않는다. 이후 필터는 물론 서블릿, 컨트롤러가 더는 호출되지 않는다.

앞서 redirect 를 사용했기 때문에 redirect 가 응답으로 적용되고 요청이 끝난다.

 

● WebConfig - loginCheckFilter() 추가

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

    return filterRegistrationBean;
}

 

 

● RedirectURL

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

 

위에서 말한 쿼리 파라미터를 활용하여 redirect하는 부분이 필요하다.

@RequestParam(defaultValue = "/") String redirectURL

 

우선 위와 같이 redirectURL을 추출했다. 이후 redirect를 다음과 같이 지정하여 이동하게 된다.

return "redirect:" + redirectURL;

 

로그인 체크 필터에서, 미인증 사용자는 요청 경로를 포함해서 /login 에 redirectURL 요청 파라미터를 추가해서 요청했다.

이 값을 사용해서 로그인 성공시 해당 경로로 고객을 redirect 한다.

 

● 정리

서블릿 필터를 사용한 덕분에 로그인 하지 않은 사용자는 인증이 필요한 경로에 들어갈 수 없게 되었다.

공통 관심사를 서블릿 필터를 사용해서 해결한 덕분에 향후 로그인 관련 정책이 변경되어도 이 부분만 변경하면 된다.