#17 Servlet Filter

# Filter

서블릿 2.3부터 추가된 기능으로 클라이언트(브라우저)가 서버로 요청을 보냈을 때, 요청이 서블릿으로 가기전에 필터링을 하는 기술이다. JSP/Servlet 스펙에서는 javax.servlet.Filter 인터페이스로 구현하여 web.xml에 등록하여 사용한다.

Filter도 싱글톤을 구현하나요? (X)

// Filter 인터페이스는 Servlet과 비슷하게 사용할 수 있다.
package javax.servlet;
 
import java.io.IOException;
 
public interface Filter {
 
    // 싱글턴을 구현하지는 않으나, 보통 1개의 객체만을 생성해서 사용한다.
    // web.xml의 설정에 따라 여러개의 인스턴스를 가질 수도 있다.
    public void init(FilterConfig filterConfig) throws ServletException;
    
    // 클라이언트의 요청이 들어오면, 요청/응답을 조작하고
    // FilterChain을 이용해 조작 이후 원래 목적지인 서블릿으로 전달한다.
    public void doFilter(ServletRequest request, ServletResponse response,
                         FilterChain chain) throws IOException, ServletException; 
 
 
    public void destroy();
}

public class LoggingFilter implements Filter {
 
    //필터가 생성될 때 초기화시 사용
    // config 객체에서 필터 정보, 주어진 파라메타, 서블릿 정보등를 얻을 수 있다.
    public void init(FilterConfig config) throws ServletException {
        System.out.println("필터 초기화 됨");
    }
    
    //요청시마다 필터가 실행할 메서드
    public void doFilter(ServletRequest request, ServletResponse  response, FilterChain chain)
            throws IOException, ServletException {
        System.out.println("요청이 필터에서 처리됨");
        chain.doFilter(request, response); // 조작을 완료한 요청/응답을 반환.
        System.out.println("응답이 필터에서 처리됨");
    }
 
    //필터가 제거될 때 실행
    public void destroy() {
        System.out.println("필터 제거됨.");
    }
}

// web.xml
     <filter>
            <filter-name>loggingFilter</filter-name>
            <filter-class>test.LoggingFilter</filter-class>
      </filter>
 
      <filter-mapping>
            <filter-name>loggingFilter1</filter-name>
            <url-pattern>*.jsp</url-pattern>
      </filter-mapping>
      
      <filter-mapping>
            <filter-name>loggingFilter2</filter-name>
            <url-pattern>/등록할url1</url-pattern>
            <url-pattern>/등록할url2</url-pattern>
            <url-pattern>/url3</url-pattern>
            <servlet-name>등록한 서블릿 이름</servlet-name>
      </filter-mapping>

참고로 filter-mapping은 servlet-mapping과 동일하며, [ *.jsp ]로 매핑하면 모든 jsp 요청시 해당 필터가 작동한다. 등록된 필터는 적은 순서대로 실행된다. (단 어노테이션으로 필터를 지정한 경우에는 순서를 보장하지 않는다.)

# 왜 필터가 필요하죠?

웹 컴포넌트(Servlet, JSP)에서 공통적으로 처리해야 할 일을 필터를 통해 처리할 수 있다. 예를 들어 요청 데이터를 UTF-8로 인코딩하는 코드를 생각해보자. 해당 코드는 거의 대부분의 웹 컴포넌트에서 동일한 처리를 한다.

request.setCharacterEncoding("utf-8");                                                
String param = request.getParameter("param");

코드의 중복도 문제지만, 만약 전체 컴포넌트에 대해 UTF-8이 아닌 다른 문자열로 인코딩해야 하는 경우도 생길 수 있다. 즉 유지보수나 개발 측면에서도 좋지 않기에 필터라는 개념을 이용해 공통된 부분을 분리하여 사용하는 것이다.

# 필터의 주요 기능

로그인 여부확인, 요청/응답 로그기록, 데이터 오류처리, 데이터 압축&변환 (인코딩)등을 보통 필터로 처리한다.

• 서블릿이 호출되기 전에 요청(request)를 가로채어 조작한다.
• 서블릿이 호출되기 전에 요청을 가로채어 점검할 수 있다.
• 서블릿이 호출되기 전에 HTTP 요청의 헤더를 조작할 수 있다.
• 서블릿이 호출된 이후 응답(response)를 출력하기 전에 가로채어 조작한다.
• 서블릿이 호출된 이후 응답 헤더를 조작할 수 있다.

# @WebFilter 어노테이션으로 필터 설정하기

서블릿 스펙 3.0 (Tomcat 7.0 이상)부터 어노테이션을 통한 맵핑(web.xml 설정)을 지원하는데, 필터도 비슷하게 지정할 수 있다. 필터 실행순서는 보장하지 않는데, 만약 순서가 필요하다면 필터 이름만 등록해두고기존의 web.xml 에서 등록하던 방법으로 적어주면 된다.

// web.xml에 필터를 등록하는것과 동일한 코드이다.
 
@WebFilter(filterName ="loggingFilter")
public class LoggingFilter3 implements Filter {...}

// 매핑을 아래와 같이 사용할 수 있다.
@WebFilter("*.jsp")
public class LoggingFilter1 implements Filter {...}
 
@WebFilter("/target") // 매핑 URL 입력
public class LoggingFilter2 implements Filter {...}
 
// URL 패턴 지정. 여러개일 땐 {}사용
@WebFilter(urlPatterns= {"/target", "/target2"})
public class LoggingFilter3 implements Filter {...}
 
// 마찬가지로 서블릿 지정. 여러개일 땐 {} 사용
@WebFilter(servletNames= {"boardController", "boardController2"})
public class LoggingFilter4 implements Filter {...}

# 필터에 입력 값 넣기

필요하다면 필터를 실행할 떄 입력 파라메타를 줄 수 있다.

      <filter>
            <filter-name>helloFilter</filter-name>
            <filter-class>test.HelloFilter</filter-class>
            
            <init-param>
                  <param-name>encoding</param-name>
                  <param-value>UTF-8</param-value>
            </init-param>
            
            <init-param>
                  <param-name>encoding2</param-name>
                  <param-value>hi hello 안녕!</param-value>
            </init-param>
      </filter>

@WebFilter(
    value = {"/target", "/target2"},
    initParams = @WebInitParam(name = "encoding", value = "UTF-8")
)
public class EncodingFilter1 implements Filter {...}
 
// 입력하고 싶은 파라메타가 여러 개인경우
@WebFilter(
    initParams = {
        @WebInitParam(name = "encoding", value = "UTF-8"),
        @WebInitParam(name = "encoding2", value = "EUC-KR")
    }
)
public class EncodingFilter2 implements Filter {...}

이렇게 주어진 파라메타는 Filter 인터페이스안에있는 init() 메서드에서 사용할 수 있다.

    public void init(FilterConfig config) throws ServletException {
        String encoding1 = config.getInitParameter("encoding1");
        String encoding2 = config.getInitParameter("encoding2");
        
        if(encoindg1 != null){
        	// 필터가 생성될 때 할 작업..
        }
    }

# @WebFilter 의 load-on-startup 속성 

서블릿은 브라우저의 최초 요청시에 init()메서드를 실행하여 WAS 메모리에 객체를 로드한다.

그래서 서버를 제일 처음에 가동할 때, 속도가 상당히 느린데 이를 보완하기 위해 load-on-startup 속성을 이용 하여 호출 되기전에 미리 초기화(=메모리에 적재) 해둘 수 있다. 

• 톰캣 컨테이너가 실행되면서 해당 서블릿을 미리 초기화 해둔다.
• 지정한 숫자는 우선순위를 의미하며, 작은숫자부터 먼저 초기화 된다. 
• 해당 옵션의 기본 값은 0으로, 지정한 숫자가 0 보다 크면 컨테이너가 실행되면서 서블릿이 초기화 되는 구조.

web.xml에 다음과 같이 속성부여가능.
 
<servlet>
    <servelt-name>loadConfig</servelt-name>
    <sevlert-class>LoadAppconfig</sevlert-class>
    <load-on-startup> 1 </load-on-startup>
</servlet>

// 서블릿 스펙 3.0부터 제공하는 어노테이션을 이용하는 방법.
@WebServlet(name = "loadAppConfig", urlPatterns = { "/loadConfig" }, loadOnStartup = 1)
public class LoadAppConfig extends HttpServlet {
 
	private ServletContext context; 
	
	@Override
	public void init(ServletConfig config) throws ServletException {
		// loadOnStartup 속성 때문에 init()이 서버시작과 함께 같이 호출됩니다.
        ...
	}
 
	@Override
	protected void doGet(HttpServletRequest request, HttpServletResponse response) 
			throws ServletException, IOException {
		request.setCharacterEncoding("utf-8");
		response.setContentType("text/html;charset=utf-8");
		PrintWriter out = response.getWriter();
		...
	}
}