4 분 소요

 인프런 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술편을 학습하고 정리한 내용 입니다.

서블릿 필터 - 소개

공통 관심 사항

로그인하지 않은 사용자에게 상품 관리 버튼은 보이지 않는다.

하지만 url을 직접 입력하면?

접근이 가능하다.

자 그럼 이제 모든 컨트롤러에 로그인 체크 로직을 넣을까?

또 로직이 수정되면 또 다 일일이 수정할 것인가?

그건 아니다.

이렇게 애플리케이션 여러 로직에서 공통으로 관심이 있는 것을 공통 관심사(cross-cutting concern)라고 한다.

여기서는 등록, 수정, 삭제, 조회 등등 여러 로직에서 공통으로 인증에 대해서 관심을 가지고 있다.

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

웹과 관련된 공통 관심사를 처리할 때 HTTP의 헤더나 URL 정보들이 필요한데, 서블릿 필터나 스프링 인터셉터는 HttpServletRequest를 제공한다.

서블릿 필터 소개

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

필터 흐름

1

HTTP 요청 -> WAS -> 필터 -> 서블릿 -> 컨트롤러

필터를 적용하면 필터가 호출 된 다음에 서블릿이 호출된다.

모든 사용자의 요청 로그를 남기는 요구 사항이 있다면 필터를 사용하면 좋다.

참고로 모든 URL에 적용하려면 /*을 사용한다. 그리고 여기서 나오는 서블릿은 디스패쳐 서블릿 이다.

필터 제한

1
2

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

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

그래서 로그인 여부를 체크하기에 딱 좋다.

필터 체인

1

HTTP 요청 -> WAS -> 필터1 -> 필터2 -> 필터3 -> 서블릿 -> 컨트롤러

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

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

필터 인터페이스

1
2
3
4
5
6
7
8
9

public interface Filter {  
    default void init(FilterConfig filterConfig) throws ServletException {  
    }  
  
    void doFilter(ServletRequest var1, ServletResponse var2, FilterChain var3) throws IOException, ServletException;  
  
    default void destroy() {  
    }  
}

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

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

서블릿 필터 - 요청 로그

간단하게 사용자의 모든 요청을 로그로 남기는 필터를 하나 직접 만들어 보자.

로그 필터 구현

패키지는 다음과 같다.

hello.login.web.filter.LogFilter

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

@Slf4j  
public class LogFilter implements Filter {  
  
  
    @Override  
    public void init(FilterConfig filterConfig) throws ServletException {  
        log.info("log filter init");  
    }  
  
    @Override  
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {  
        log.info("log filter doFilter");  
  
        HttpServletRequest request = (HttpServletRequest) servletRequest;  
        String requestURI = request.getRequestURI();  
  
        String uuid = UUID.randomUUID().toString();  
  
        try {  
            log.info("REQUEST [{}][{}]", uuid, requestURI);  
            filterChain.doFilter(servletRequest, servletResponse);  
        } catch (Exception e) {  
            throw e;  
        } finally {  
            log.info("RESPONSE [{}][{}]", uuid, requestURI);  
        }  
    }  
  
    @Override  
    public void destroy() {  
        log.info("log filter destroy");  
    }  
}

가장 먼저 implements Filter로 필터를 구현 해준다.

init, doFilter, destroy를 구현해 주면 되는데, doFilter에 로직을 구현해 보자.

1
2
3
4

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

String uuid = UUID.randomUUID().toString();

접근한 URI와 누군지 구분하기 위해 랜덤 값을 하나 만들었다.

그 후 try-catch-finally 에서 로그를 남기자.

  • log.info("REQUEST [{}][{}]", uuid, requestURI) : 메서드를 실행하기 전에 실행 될 것이다.
  • filterChain.doFilter(servletRequest, servletResponse) : 무조건 해줘야 한다. 안그러면 다음 필터로 안 넘어 간다.
  • log.info("RESPONSE [{}][{}]", uuid, requestURI) : finally에 넣어 놨기 때문에 메서드가 끝나고 실행될 것이다.

필터 등록

필터를 구현만 했다고 해서 끝이 아니다. 이제 등록을 해야 한다.

스프링 부트를 사용한다면 여러 방법이 있지만

이번엔 FilterRegistrationBean을 사용해서 등록한다.

hello.login.WebConfig

1
2
3
4
5
6
7
8
9
10
11
12

@Configuration  
public class WebConfig {  
  
    @Bean  
    public FilterRegistrationBean<Filter> logFilter() {  
        FilterRegistrationBean<Filter> filterRegistrationBean = new FilterRegistrationBean<>();  
        filterRegistrationBean.setFilter(new LogFilter());  
        filterRegistrationBean.setOrder(1); // 필터 순서  
        filterRegistrationBean.addUrlPatterns("/*"); // 모든 URL  
        return filterRegistrationBean;  
    }  
}

하나 하나 봐보자.

  • @Configuration : Bean을 등록하기 위해 사용
  • @Bean : 스프링이 관리할 객체
  • FilterRegistrationBean<Filter> : 필터를 서블릿 컨텍스트에 등록하기 위한 클래스
  • setFilter(new LogFilter()) : 내가 만든 로그 필터를 세팅
  • setOrder(1) : 이 필터가 몇 번째에 사용될 지 결정
  • addUrlPatterns("/*") : 모든 URL에서 필터가 적용되도록 설정

자 이제 결과를 보자.

지금 상품 등록을 하려고 했고, 일부로 아무것도 입력 안 해서 오류를 남기게 했다.

보면 request 로그가 먼저 나가고, 그 다음 글 등록을 위한 로직이 실행 됐다.

마지막으로 필터 finally 에 있던 response 로그가 나갔다. 내가 원하는 방향으로 잘 설계가 되었다.

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

다른 필터 등록 방법

필터 등록하는 방법은 여러 개가 있다.

@Configuration + FilterRegistrationBean 조합 방법이 있고

또 @WebFilter + @Component 조합이 있다.

간단하게 구현 해 놓은 로그 필터를 이용해서 @WebFilter + @Component 조합을 사용해 보자.

그러기 위해서 먼저 WebConfig 의 @Configuration을 주석 처리하자. (즉 이 방법에선 WebConfig가 필요 없다.)

그 후 로그 필터 클래스를 조금 수정한다.

1
2
3
4
5
6
7
8
9

@Slf4j  
@WebFilter("/*")  
@Order(1)  
@Component  
public class LogFilter implements Filter {

  ... 

}
  • @WebFilter("/*") : url 패턴 지정 가능.
  • @Order(1) : 필터가 동작할 순서
  • @Component : 스프링이 Bean으로 등록하고 관리

이렇게 애노테이션을 사용해서 간단하게 등록해 봤다. 결과를 보자.

잘 동작한다.

자 그럼 이 두 가지 방법의 장 단점을 정리해 보자.

@Configuration + FilterRegistrationBean 조합

  • 장점
    • 유연한 설정 : 필터의 URL 패턴, 순서 등을 set 메서드로 유연하고 세밀하게 설정 가능
    • 여러 필터를 한 곳에서 관리 가능하다. WebConfig에 메서드로 쭉쭉 등록하면 된다.
  • 단점
    • 설정이 다소 복잡하다. 간단한 필터만 있다면 불필요하게 복잡하다.

@WebFilter + @Component 조합

  • 장점
    • 간단한 설정 : 필터에 직접 애노테이션으로 등록 해서 간단하고 보기도 좋다.
    • 의존성 주입 : @Component이기 때문에 스프링 빈으로 등록되어 다른 곳에서 의존성 주입을 받을 수 있다.
  • 단점
    • 제한된 설정 : FilterRegistrationBean에 set 메서드보다 여러 설정하기 어려움
    • 필터 관리가 어렵다. 필터가 여러 개라면, 그 필터 마다 에노테이션을 붙여서 설정 해야 하는데 관리하기 편리하진 않다.


참고 및 출처 : Filter를 등록하는 4가지 방법

댓글남기기

참고