[ 김영한 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 #7 ] 로그인 처리2 - 필터, 인터셉터 (1)

김수호·2023년 9월 20일
김영한 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술
0
post-thumbnail

이번 섹션에서는 [로그인 처리2 - 필터, 인터셉터]에 대해서 알아보자.

👉 목차는 다음과 같다.

1) 서블릿 필터 - 소개
2) 서블릿 필터 - 요청 로그
3) 서블릿 필터 - 인증체크
4) 스프링 인터셉터 - 소개
5) 스프링 인터셉터 - 요청 로그
6) 스프링 인터셉터 - 인증 체크
7) ArgumentResolver 활용
8) 정리

일곱 번째 섹션은 1) ~ 3), 4) ~ 8) 로 나눠서 포스팅하고자 한다.

바로 하나씩 확인해보자.

1) 서블릿 필터 - 소개

🤔 먼저, 서블릿 필터가 왜 필요할까 ?

공통 관심 사항을 처리할 수 있다.

요구사항을 보면 로그인 한 사용자만 상품 관리 페이지에 들어갈 수 있어야 한다.
앞에서 로그인을 하지 않은 사용자에게는 상품 관리 버튼이 보이지 않기 때문에 문제가 없어 보인다. 그런데 문제는 로그인 하지 않은 사용자가 상품 관리 URL을 직접 호출하면 상품 관리 화면에 들어갈 수 있다는 점이다. ( http://localhost:8080/items )

상품 관리 컨트롤러에서 로그인 여부를 체크하는 로직을 하나하나 작성하면 되겠지만, 등록, 수정, 삭제, 조회 등등 상품관리의 모든 컨트롤러 로직에서 공통으로 로그인 여부를 확인해야 한다. 더 큰 문제는 향후 로그인과 관련된 로직이 변경될 때 이다. 작성한 모든 로직을 다 수정해야 할 수 있다.

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

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

 

서블릿 필터 소개

필터는 서블릿이 지원하는 수문장이다. 필터의 특성은 다음과 같다.

  • 필터 흐름
    • 필터를 적용하면 필터가 호출 된 다음에 서블릿이 호출된다. 그래서 모든 고객의 요청 로그를 남기는 요구사항이 있다면, 필터를 사용하면 된다. 참고로 필터는 특정 URL 패턴에 적용할 수 있다. ( /* 이라고 하면 모든 요청에 필터가 적용된다. )
    • 참고로 스프링을 사용하는 경우 여기서 말하는 서블릿은 스프링의 디스패처 서블릿으로 생각하면 된다.
  • 필터 제한
    필터에서 적절하지 않은 요청이라고 판단하면 거기에서 끝을 낼 수도 있다. 그래서 로그인 여부를 체크하기에 딱 좋다.
    • 로그인 사용자
    • 비 로그인 사용자
  • 필터 체인
    • 필터는 체인으로 구성되는데, 중간에 필터를 자유롭게 추가할 수 있다. 예를 들어서 로그를 남기는 필터를 먼저 적용하고, 그 다음에 로그인 여부를 체크하는 필터를 만들 수 있다. (체인이 가능하도록 만들 수 있다.)
  • 필터 인터페이스
    • 필터 인터페이스를 구현하고 등록하면 서블릿 컨테이너가 필터를 싱글톤 객체로 생성하고, 관리한다.
      • init(): 필터 초기화 메서드, 서블릿 컨테이너가 생성될 때 호출된다.
      • doFilter(): 고객의 요청이 올 때 마다 해당 메서드가 호출된다. 여기에 필터의 로직을 구현하면 된다.
      • destroy(): 필터 종료 메서드, 서블릿 컨테이너가 종료될 때 호출된다.

 

✔️ References

2) 서블릿 필터 - 요청 로그

필터가 정말 수문장 역할을 잘 하는지 확인하기 위해 가장 단순한 필터인, 모든 요청을 로그로 남기는 필터를 개발하고 적용해보자.

👉 코드로 바로 확인해보자.

  • LogFilter 생성: src > main > java > hello > login > web > filter 패키지를 생성하고, 내부에 LogFilter 클래스를 생성하자.
  • WebConfig - 필터 설정: src > main > java > hello > login 패키지 내부에 WebConfig 클래스를 생성하자.
    • 필터를 등록할 때 urlPattern 을 /* 로 등록했기 때문에 모든 요청에 해당 필터가 적용된다.
  • 실행해보자.
    • init가 호출되어 내부에서 남긴 로그가 출력됨을 확인할 수 있다.
  • 홈 화면에 접근해보자.
    • doFilter가 호출되어 내부에서 남긴 로그가 출력됨을 확인할 수 있다.
  • 상품 관리 페이지에 접근해보자.
    • doFilter가 호출되어 내부에서 남긴 로그가 정상적으로 출력됨을 확인할 수 있다.

 

로직 분석 (LogFilter)

  • public class LogFilter implements Filter {}
    • 필터를 사용하려면 필터 인터페이스를 구현해야 한다.
  • doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
    • HTTP 요청이 오면 doFilter 가 호출된다.
    • ServletRequest request 는 HTTP 요청이 아닌 경우까지 고려해서 만든 인터페이스이다. 따라서 HTTP를 사용하면 HttpServletRequest httpRequest = (HttpServletRequest) request; 와 같이 다운 캐스팅 하면 된다.
  • String uuid = UUID.randomUUID().toString();
    • HTTP 요청을 구분하기 위해 요청당 임의의 uuid 를 생성해둔다. (이런걸 보통 트랜잭션 아이디라고 표현하기도 한다. 이는 DB 트랜잭션과는 관련 없으며, 고객 요청에 대한 id를 남기는 개념이다.)
  • log.info("REQUEST [{}][{}]", uuid, requestURI);
    • uuid 와 requestURI 를 출력한다.
  • chain.doFilter(request, response);
    • 이 부분이 가장 중요하다. 다음 필터가 있으면 필터를 호출하고, 필터가 없으면 서블릿을 호출한다. 만약 이 로직을 호출하지 않으면 다음 단계로 진행되지 않는다.

로직 분석 (WebConfig)

  • 필터를 등록하는 방법은 여러가지가 있지만, 스프링 부트를 사용한다면 FilterRegistrationBean 을 사용해서 등록하면 된다.
  • setFilter(new LogFilter()) : 등록할 필터를 지정한다.
  • setOrder(1) : 필터는 체인으로 동작한다. 따라서 순서가 필요하다. 낮을수록 먼저 동작한다.
  • addUrlPatterns("/*") : 필터를 적용할 URL 패턴을 지정한다. 한번에 여러 패턴을 지정할 수 있다.

 

✔️ 참고

  • URL 패턴에 대한 룰은 필터도 서블릿과 동일하다. 자세한 내용은 서블릿 URL 패턴으로 검색해보자.

  • @ServletComponentScan @WebFilter(filterName = "logFilter", urlPatterns = "/*") 로 필터 등록이 가능하지만 필터 순서 조절이 안된다. 따라서 FilterRegistrationBean 을 사용하자.

  • 실무에서 HTTP 요청시 같은 요청의 로그에 모두 같은 식별자를 자동으로 남기는 방법은 logback mdc로 검색해보자.

    • 하나의 HTTP 요청이 들어와서 응답이 나갈때까지 남기는 로그에는 전부 식별자를 자동으로 포함하고자 하는 경우. (그러면 해당 요청에 대한 로그만 보거나 추적하기에 용이해진다.)
    • (참고) 위 예시에서는 Filter에서 남기는 로그에만 UUID가 남겨지고, 컨트롤러에서 남기는 로그 등에는 UUID가 나오지 않는다.

3) 서블릿 필터 - 인증 체크

드디어 인증 체크 필터를 개발해보자.
로그인되지 않은 사용자는 상품 관리 뿐만 아니라 미래에 개발될 페이지에도 접근하지 못하도록 하자.

👉 코드로 바로 적용해보자.

  • LoginCheckFilter 생성: src > main > java > hello > login > web > filter 패키지 내부에 LoginCheckFilter 클래스를 생성하자.
  • LoginCheckFilter - doFilter(): 다음과 같이 작성하자.
  • LoginCheckFilter - isLoginCheckPath(): 다음과 같이 작성하자.
  • WebConfig - loginCheckFilter() 추가: src > main > java > hello > login 패키지 내부 WebConfig 클래스에 다음과 같이 작성하자.
    • 물론 위 addUrlPatterns에 특정 경로(상품 관리)만 넣을 수 있지만, 지금 우리가 원하는 기능은, 현재 whiteList 경로를 제외하고, 앞으로 미래에 추가로 개발될 페이지까지 전부 포함해서, 로그인한 사용자만 접근하도록 적용하고자 하기에, 필터 자체는 모든 경로를 다 적용하고, 내부에서 체크하도록 하였다.
    • (참고) 필터 추가로 인해 성능이 저하될까 우려할 수 있지만, 필터 추가로 메서드 하나 더 호출하는 수준에서는 그런 걱정까지는 하지 않아도 된다.
  • 실행해보자. (비 로그인 상태에서 최초 홈 화면 접근시)
    • 로그를 보면, 필터 우선순위에 맞게 LogFilter -> LoginCheckFilter 순으로 실행된 것을 확인할 수 있다.
  • 실행해보자. (비 로그인 상태에서 https://localhost:8080/items 접근 시)
    • 홈 화면에서 직접 상품 관리 URL 경로를 호출했다.
    • 따라서 LoginCheckFilter에서 정상적으로 걸러져서, 로그인 페이지로 리다이렉트 되었다. (그리고 URL 쿼리 파라미터에 처음 요청한 URL 경로가 나오는 것을 확인할 수 있다. http://localhost:8080/login?redirectURL=/items)
    • 로그를 보면, 필터 우선순위에 맞게 LogFilter -> LoginCheckFilter 순으로 실행된 것을 확인할 수 있다.

 

로직 분석 - LoginCheckFilter

  • whitelist = {"/", "/members/add", "/login", "/logout","/css/*"};
    • 인증 필터를 적용해도 홈, 회원가입, 로그인 화면, css 같은 리소스에는 접근할 수 있어야 한다. 이렇게 화이트 리스트 경로는 인증과 무관하게 항상 허용한다. 화이트 리스트를 제외한 나머지 모든 경로에는 인증 체크 로직을 적용한다.
  • isLoginCheckPath(requestURI)
    • 화이트 리스트를 제외한 모든 경우에 인증 체크 로직을 적용한다.
  • httpResponse.sendRedirect("/login?redirectURL=" + requestURI);
    • 미인증 사용자는 로그인 화면으로 리다이렉트 한다. 그런데 로그인 이후에 다시 홈으로 이동해버리면, 원하는 경로를 사용자가 다시 찾아가야 하는 불편함이 있다. 예를 들어서 상품 관리 화면을 보려고 들어갔다가 로그인 화면으로 이동하면, 로그인 이후에 다시 상품 관리 화면으로 들어가는 것이 좋다.
    • 이런 부분이 개발자 입장에서는 좀 귀찮을 수 있어도 사용자 입장으로 보면 편리한 기능이다. 이러한 기능을 위해 현재 요청한 경로인 requestURI 를 /login 에 쿼리 파라미터로 함께 전달한다. 물론 /login 컨트롤러에서 로그인 성공시 해당 경로로 이동하는 기능은 추가로 개발해야 한다.
  • return;
    • 여기가 중요하다. 필터를 더는 진행하지 않는다. 이후 필터는 물론 서블릿, 컨트롤러가 더는 호출되지 않는다. 앞서 redirect 를 사용했기 때문에 redirect 가 응답으로 적용되고 요청이 끝난다.

로직 분석 - WebConfig (loginCheckFilter())

  • setFilter(new LoginCheckFilter()) : 로그인 필터를 등록한다.
  • setOrder(2) : 순서를 2번으로 잡았다. 로그 필터 다음에 로그인 필터가 적용된다.
  • addUrlPatterns("/*") : 모든 요청에 로그인 필터를 적용한다.

 

👉 이제 로그인에 성공하면 처음 요청한 URL로 이동하는 기능을 개발해보자. (RedirectURL 처리)

  • 기존 코드를 유지하기 위해, LoginController 컨트롤러에 있는 loginV3() 의 @PostMapping("/login") 을 주석 처리하자.
  • LoginController - loginV4(): 주석 처리한 loginV3() 메서드를 복사해서 loginV4() 메서드를 생성하자.
    • LoginCheckFilter 에서, 미인증 사용자는 요청 경로를 포함해서 /login 에 redirectURL 요청 파라미터를 추가해서 요청했다. 이 값을 사용해서 로그인 성공시 해당 경로로 고객을 redirect 한다.
  • 실행해보자.
    • 비 로그인 상태에서 상품 관리 URL을 직접 호출한 경우
      • 정상적으로 로그인 페이지로 redirect 된다.
    • 로그인 페이지에서 로그인 후
      • 로그인 페이지에서 로그인에 성공하면, 처음 요청했던 상품 관리 URL로 이동됨을 확인할 수 있다.

 

✔️ 정리

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

✔️ 참고

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

강의를 듣고 정리한 글입니다. 코드와 그림 등의 출처는 김영한 강사님께 있습니다.

profile
김수호
현실에서 한 발자국
이전 포스트

[ 김영한 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 #6 ] 로그인 처리1 - 쿠키, 세션 (2)

다음 포스트

[ 김영한 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 #7 ] 로그인 처리2 - 필터, 인터셉터 (2)

0개의 댓글