Servlet Filter 사용하기

Servlet Filter 사용하기

Filter의 개념과 사용하는 이유

필터는 서블릿 실행 전, 후에 어떤 작업을 하고자 할때 사용한다. 예를 들어 클라이언트가 보낸 데이터의 암호를 해제한다거나, 서블릿이 실행되기 전에 필요한 자원을 미리 준비하거나, 서블릿이 실행될 때마다 로그를 남긴다거나 하는 작업을 필터를 통해 처리할 수 있다.

 

필터의 실행

 

만약 그런 작업들을 서블릿에 담는다면 필요한 서블릿마다 해당 코드를 삽입해야하고 필요가 없어지면 그 코드를 삽입한 서블릿을 모두 찾아서 삭제해야 하므로 관리하기가 매우 번거로워진다.

 

필터로 POST Request Parameter 문자 집합 설정하기

HTTP POST Request의 Message Body 예

POST 요청의 경우 서버로 보내는 데이터가 message body에 있고 서블릿에서 이 데이터를 꺼내려면 getParameter()를 호출한다. 만약 데이터에 한글과 같은 멀티 바이트 문자가 있을 때 그냥 getParameter()를 호출하면 한글이 깨진다. 다음과 같이 setCharacterEncoding()을 호출해서 message body의 데이터의 문자 집합을 설정해야 한다.

 

request.setCharacterEncoding("UTF-8");

 

그러나 POST 요청을 처리하는 서블릿 마다 이 코드를 작성하는 것은 매우 번거로운 작업이다. 이 때 서블릿 필터를 이용하면 간단히 처리할 수 있다.

 

필터 만들기

public class CharacterEncodingFilter implements Filter {
    FilterConfig config;
 
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        this.config = filterConfig;
    }
 
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        servletRequest.setCharacterEncoding(config.getInitParameter("encoding"));
        filterChain.doFilter(servletRequest, servletResponse);
    }
 
    @Override
    public void destroy() { }
}

클래스를 생성하고 javax.servlet.Filter 인터페이스를 구현한다. Filter 인터페이스에 선언된 init(), doFilter(), destroy()는 필터의 생명주기와 관련된 메소드이다.

 

(1) init()

init() 메소드는 필터 객체가 생성되고 준비 작업을 위해 딱 한번 호출된다. 서블릿의 init()과 같은 용도이다. 이 메소드의 매개변수는 FilterConfig의 인스턴스이다. 이 인스턴스를 통해 필터 초기화 매개변수의 값을 꺼낼수 있다. 위 코드에서는 doFilter()에서 사용하기 위해 인스턴스 변수 config에 저장한다.

 

(2) doFilter()

필터와 매핑된 URL에 요청이 들어올때마다 doFilter()가 호출된다. 이 메소드에 필터가 할 작업을 작성한다.

filterChain은 다음 필터를 가리키고 filterChain.doFilter()는 다음 필터를 호출한다. 다음 필터가 없다면 내부적으로 서블릿의 service()를 호출한다.

 

서블릿이 실행되기 전에 처리할 작업은 filterChain.doFilter() 이전에, 서블릿이 실행된 후에 처리할 작업은 filterChain.doFilter() 이후에 작성한다.

 

본 예제에서는 서블릿이 실행되기 전에 request parameter의 문자 집합을 먼저 설정하기 위해 filterChain.doFilter() 이전에 setCharacterEncoding()을 호출했다.

 

(3) destroy()

서블릿 컨테이너는 웹 어플리케이션을 종료하기 전에 필터들에 대해 destroy()를 호출해서 마무리 작업을 한다. 본 예제는 특별히 마무리할 작업이 없으므로 빈 메소드로 둔다.

 

필터의 구동 과정

① 서블릿 컨테이너는 웹 어플리케이션을 시작할 때 DD파일(web.xml)에 등록된 필터의 인스턴스를 생성하고 init()을 호출한다.

② 클라이언트 요청이 들어오면 해당하는 필터의 doFilter()를 호출한다.

③ doFilter()에서 작업을 실행하고 다음 필터의 doFilter()를 호출한다.

④ 마지막 필터까지 ③을 반복한다.

⑤ 마지막 필터는 서블릿의 service()를 호출한다.

⑥ 서블릿의 service()가 끝나면 service()를 호출했던 이전 필터로 돌아간다.

⑦ 반복해서 제일 처음 호출됐던 필터까지 돌아간다.

⑧ 마지막으로 클라이언트에게 응답 결과를 보낸다.

 

 

필터 배치(Deployment)

필터의 배치 방법은 web.xml에 설정하는 방법과 annotation에 설정하는 방법이 있다.

 

web.xml에 배치 정보 설정

서블릿의 배치 정보를 설정하는 것과 유사하다.

<!-- 필터 선언 -->
<filter>
    <filter-name>CharacterEncodingFilter</filter-name>
    <filter-class>com.atoz_develop.spms.filters.CharacterEncodingFilter</filter-class>
    <init-param>
        <param-name>encoding</param-name>
        <param-value>UTF-8</param-value>
    </init-param>
</filter>
 
<!-- 필터 URL 매핑-->
<filter-mapping>
    <filter-name>CharacterEncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

<filter-name> : 필터 별칭 설정

<filter-class> : 패키지 이름을 포함한 필터 클래스 작성

<init-param> : 필터가 사용할 정적 데이터 설정

<filter-mapping> : 필터를 사용할 URL 매핑

    <filter-name> : 필터 별칭 지정

    <url-pattern> : 필터가 적용되어야 하는 URL 지정. /*와 같이 지정하면 모든 요청에 대해 필터 적용

 

어노테이션에 배치 정보 설정

@WebFilter(
        urlPatterns = "/*",
        initParams = {
                @WebInitParam(name="encoding", value="UTF-8")
        }
)

필터 클래스에 위와 같이 @WebFilter 어노테이션을 추가한다.

urlPatterns에 지정해야 하는 값은 위 web.xml로 설정하는 것에서 <filter-mapping>부와 동일하다.

 

이렇게 필터를 구현하고 적용하면 POST 요청에서 매개변수를 꺼내는 부분에서 setCharacterEncoding() 호출부를 모두 제거해도 한글이 깨지지 않는다.

 

필터 적용 사례

이렇게 필터를 이용해 서블릿 실행 전, 후에 어떤 작업을 수행할 수 있으며 적용 예는 다음과 같다.

사전 작업(서블릿 실행 전)	사후 작업(서블릿 실행 후)
문자 집합 설정	응답 데이터 압축
압축 해제	응답 데이터 암호화
암호화된 데이터의 복호화	응답 데이터 형식 변환
로그 작성
사용자 검증
사용자 권한 확인

 

References

열혈강의 자바 웹 개발 워크북(프리렉, 2016, 엄진영)