[Spring] 필터 & 인터셉터

인프런 김영한님 스프링 강의를 통해 정리한 학습내용 기록입니다.

 

공통 관심 사항

특정 권한이 필요한 화면 및 API의 경우 로그인하지 않은 사용자에게는 해당 기능의 컴포넌트를 숨기면 된다.

하지만 해당 URL을 통해 들어오게 될 경우 막을 수 없다.

 

단순한 해결방안으로 권한이 필요한 Endpoint에 일일이 로그인 여부 체크를 하는 로직을 추가하는 방법이 있는데 이는 적용이나 유지보수 측면에서 효율이 좋지 않은 방법이다.

 

이렇듯 여러 로직에서 공통으로 관심이 있는 것을 공통 관심사라고 부른다.

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

 

처리하기 위한 HTTP의 헤더나 URL의 정보들이 필요한데, 서블릿 필터나 스프링 인터셉터는 HttpServletRequet를 제공한다.

(필터나 인터셉터는 특정 URL로 오는 요청에 대한 공통 로직을 적용시키는게 가능)

 

---

서블릿 필터

필터는 서블릿이 지원하는 수문장. (스프링의 경우 디스패처 서블릿을 의미함)

 

필터의 흐름

1. HTTP 요청
2. WAS
3. 필터
4. 서블릿
5. 컨트롤러

로그인 사용자의 경우 필터를 거쳐 컨트롤러까지 Request가 전달이 된다.

반면 로그인하지 않은 사용자의 경우 필터에서 적절하지 않은 요청이라 판단하여 서블릿 호출을 하지 않는다.

필터 단에서 끝맺음을 짓기 때문에 로그인 여부 체크 같은 경우에 사용하기 좋다.

 

---

필터 체인(Filter Chain)

1. HTTP 요청
2. WAS
3. 필터 1
4. 필터 2
5. 필터 N
6. 서블릿
7. 컨트롤러

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

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

 

---

필터 인터페이스

필터 인터페이스를 구현하고 등록하면 서블릿 컨테이너가 필터를 싱글톤 객체로 생성하고, 관리한다.

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

---

필터 구현

• public class LogFilter implements Filter {}
  • 필터를 사용하려면 필터 인터페이스를 구현해야 한다.
• doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
  • HTTP 요청이 오면 doFilter가 호출된다.
  • ServletRequest request는 HTTP요청이 아닌 경우까지 고려해서 설계된 인터페이스라서 HTTP를 사용하면 HttpServletRequest로 다운 캐스팅하여 사용하면 된다.
• chain.doFilter(request, response)
  • 이 부분이 가장 중요하다. 다음 필터가 있으면 필터를 호출한고, 필터가 없으면 서블릿을 호출한다.
  • 만약 이 로직을 호출하지 않으면 다음 단계로 진행되지 않고 필터 단에서 요청이 종료된다.

---

필터 등록

서블릿 필터를 등록하는 방법에는 4가지가 있다.

1. Configuration 어노테이션을 활용하여 별도의 설정파일로 필터를 등록하는 방식.
2. Component 어노테이션을 활용하여 컴포넌트 스캔을 하는 방식.
3. WebFilter + ServletComponentScan 어노테이션을 통한 필터 등록
4. WebFilter + Component 어노테이션을 통한 필터 등록

무난한 방식으로는 Configuration을 통한 별도의 설정 파일 생성 및 FilterRegistration을 통한 필터 등록 방식을 사용할 것 같다.

 

---

스프링 인터셉터

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

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

 

---

인터셉터의 흐름

1. HTTP 요청
2. WAS
3. 필터
4. 서블릿
5. 스프링 인터셉터
6. 컨트롤러

• 스프링 인터셉터는 디스패처 서블릿과 컨트롤러 사이에서 컨트롤러 호출 직전에 호출 된다.
• 스프링 인터셉터는 스프링 MVC가 제공하는 기능이기 때문에 결국 디스패처 서블릿 이후에 등장하게 된다. 스프링 MVC의 시작점이 디스패처 서블릿이라고 생각해보면 이해가 될 것.
• 스프링 인터셉터에도 URL 패턴을 적용할 수 있는데, 서블릿 URL 패턴과는 다르고, 매우 정밀하게 설정할 수 있다.

---

인터셉터 제한

HTTP 요청 → WAS → 필터 → 서블릿 → 스프링 인터셉터 → 컨트롤러 //로그인 사용자

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

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

 

---

인터셉터 체인

1. HTTP 요청
2. WAS
3. 필터
4. 서블릿
5. 인터셉터 1
6. 인터셉터 2
7. 인터셉터 N
8. 컨트롤러

스프링 인터셉터는 체인으로 구성되는데, 중간에 인터셉터를 자유롭게 추가할 수 있다. 예를 들어서 로그를 남기는 인터셉터를 먼저 적용하고, 그 다음에 로그인 여부를 체크하는 인터셉터를 만들 수 있다.

 

지금까지 내용을 보면 서블릿 필터와 호출되는 순서만 다르고, 제공하는 것들은 비슷해 보임…

하지만 스프링 인터셉터가 필터에 비해 편리하고, 더 정교하고 다양한 기능을 지원한다고 한다.

---

인터셉터 인터페이스

스프링의 인터셉터를 사용하려면 HandlerInterceptor 인터페이스를 구현하면 된다.

• 서블릿 필터의 경우 단순하게 doFilter()하나만 제공된다. 인터셉터는 컨트롤러 호출 전 “preHandle()”, 호출 후 “postHandle”, 요청 완료 이후 “afterCompletion”와 같이 단계적으로 잘 세분화 되어 있다.
• 서블릿 필터의 경우 단순 request, response만 제공했지만, 인터셉터는 어떤 컨트롤러 handler가 호출되는지 호출정보도 받을 수 있다. 또한 어떤 modelAndView가 반환되는지 응답 정보도 받을 수 있다.

---

인터페이스 호출 흐름도

정상 흐름

• preHandle : 컨트롤러 호출 전에 호출된다.
  • preHandle의 응답값이 true면 다음으로 진행, false면 더는 진행하지 않는다. false인 경우 나머지 인터셉터는 물론이고, 핸들러 어댑터도 호출되지 않는다. 그림에서 1번이 끝이 나버림.
• postHandle : 컨트롤러 호출 후에 호출된다.
• afterCompletion : 뷰가 렌더링 된 이후에 호출된다.

예외 상황

• preHandle : 컨트롤러 호출 전에 호출된다.
• postHandle : 컨트롤러에서 예외가 발생하면 postHandle은 호출되지 않는다.
• afterCompletion : 항상 호출된다. 이 경우 예외 (ex)를 파라메터로 받아서 로그를 출력할 수 있다.

afterCompletion은 예외가 발생해도 호출된다.

마치 finally 구문처럼.

• 예외가 발생하면 postHandle()은 호출되지 않으므로 예외와 무관하게 공통 처리를 하려면 afterCompletion()을 사용해야 한다.
• 예외가 발생하면 afterCompletion()에 예외 정보(ex)를 포함해서 호출된다.

 

---

정리

인터셉터는 스프링 MVC 구조에 특화된 필터 기능을 제공한다고 이해하면 된다. 스프링 MVC를 사용하고, 특별히 필터를 꼭 사용해야 하는 상황이 아니라면 인터셉터를 사용하는 것이 더 편리하다.