編寫過濾器

編寫過濾器

Servlet 過濾器是Java 類，可用于 Servlet 編程中的下述目的：

• 在它們訪問后端資源之前，攔截這些來自客戶端的請求。

• 在它們發(fā)送回客戶端之前，處理這些來自服務(wù)器端的響應(yīng)。

這是規(guī)范建議的各種類型的過濾器：

• 身份驗證過濾器。

• 數(shù)據(jù)壓縮過濾器。

• 加密過濾器。

• 觸發(fā)訪問事件資源的過濾器。

• 圖像轉(zhuǎn)換過濾器。

• 日志記錄和審核過濾器。

• MIME-類型鏈過濾器。

• Tokenizing 過濾器。

• 轉(zhuǎn)換 XML 內(nèi)容的 XSL/T 過濾器。

過濾器在部署描述符文件 web.xml 中被部署，然后被映射到 servlet 名稱或你的應(yīng)用程序的部署描述符中的 URL 模式。

當(dāng) web 容器啟動你的 web 應(yīng)用程序時，它會為每個在部署描述符中已聲明的過濾器創(chuàng)建一個實例。過濾器按照它們在部署描述符中聲明的順序執(zhí)行。

Servlet 過濾器方法

過濾器僅僅是一個實現(xiàn)了 javax.servlet.Filter 接口的 Java 類。javax.servlet.Filter 接口定義了三種方法：

Servlet 過濾器實例

以下是 Servlet 過濾器的實例，將輸出客戶端的 IP 地址和當(dāng)前的日期時間。這個例子使你對 Servlet 過濾器有了基本的了解，但是你可以使用相同的概念編寫更復(fù)雜的過濾器應(yīng)用程序：

// Import required java libraries
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
import java.util.*;
// Implements Filter class
public class LogFilter implements Filter  {
   public void  init(FilterConfig config) 
                         throws ServletException{
      // Get init parameter 
      String testParam = config.getInitParameter("test-param"); 
      //Print the init parameter 
      System.out.println("Test Param: " + testParam); 
   }
   public void  doFilter(ServletRequest request, 
                 ServletResponse response,
                 FilterChain chain) 
                 throws java.io.IOException, ServletException {
      // Get the IP address of client machine.   
      String ipAddress = request.getRemoteAddr();
      // Log the IP address and current timestamp.
      System.out.println("IP "+ ipAddress + ", Time "
                                       + new Date().toString());
      // Pass request back down the filter chain
      chain.doFilter(request,response);
   }
   public void destroy( ){
      /* Called before the Filter instance is removed 
      from service by the web container*/
   }
}

用常用的方式編譯 LogFilter.java 并把你的類文件放入 /webapps/ROOT/WEB-INF/classes 中。

Web.xml 中的 Servlet 過濾器映射

過濾器被定義然后被映射到一個 URL 或 Servlet中，這與Servlet被定義然后映射到一個 URL 模式中的方法是相同的。為在部署描述符文件 web.xml 中過濾器標(biāo)簽創(chuàng)建如下所示條目：

<filter>
   <filter-name>LogFilter</filter-name>
   <filter-class>LogFilter</filter-class>
   <init-param>
      <param-name>test-param</param-name>
      <param-value>Initialization Paramter</param-value>
   </init-param>
</filter>
<filter-mapping>
   <filter-name>LogFilter</filter-name>
   <url-pattern>/*</url-pattern>
</filter-mapping>

上述過濾器可以應(yīng)用到所有的 servlet 中，因為在配置中我們指定了 /* 。如果你只想在少數(shù)的 servlet 中應(yīng)用過濾器，那么你可以指定一個特定的 servlet 路徑。

現(xiàn)在嘗試用常用的方式調(diào)用任何 servlet，然后你將會在 web 服務(wù)器日志中看到生成的日志。你也可以使用 Log4J 記錄器來在一個單獨(dú)的文件中記錄上述日志。

使用多個過濾器

Web 應(yīng)用程序可以定義多個帶有不同目的的過濾器?？紤]這種情況，你定義了兩個過濾器 AuthenFilter 和 LogFilter。除了你需要創(chuàng)建一個如下所述的不同的映射之外，其余的處理與上述解釋的一樣：

<filter>
   <filter-name>LogFilter</filter-name>
   <filter-class>LogFilter</filter-class>
   <init-param>
      <param-name>test-param</param-name>
      <param-value>Initialization Paramter</param-value>
   </init-param>
</filter>
<filter>
   <filter-name>AuthenFilter</filter-name>
   <filter-class>AuthenFilter</filter-class>
   <init-param>
      <param-name>test-param</param-name>
      <param-value>Initialization Paramter</param-value>
   </init-param>
</filter>
<filter-mapping>
   <filter-name>LogFilter</filter-name>
   <url-pattern>/*</url-pattern>
</filter-mapping>
<filter-mapping>
   <filter-name>AuthenFilter</filter-name>
   <url-pattern>/*</url-pattern>
</filter-mapping>

過濾器的應(yīng)用順序

web.xml 中的 filter-mapping 元素的順序決定了 web 容器把過濾器應(yīng)用到 servlet 的順序。若要反轉(zhuǎn)過濾器的順序，你只需要在 web.xml 文件中反轉(zhuǎn) filter-mapping 元素即可。

例如，上述實例首先應(yīng)用 LogFilter然后再應(yīng)用 AuthenFilter 到任何 servlet 中，但是下述實例將反轉(zhuǎn)這個順序：

<filter-mapping>
   <filter-name>AuthenFilter</filter-name>
   <url-pattern>/*</url-pattern>
</filter-mapping>
<filter-mapping>
   <filter-name>LogFilter</filter-name>
   <url-pattern>/*</url-pattern>
</filter-mapping>