Servlet 編寫過濾器

Servlet 過濾器是可用於 Servlet 程式設計的 Java 類，有以下目的：

• 在客戶端的請求存取後端資源之前，攔截這些請求。

• 在伺服器的回應傳送回客戶端之前，處理這些回應。

根據規範建議的各種類型的過濾器：

• #認證過濾器（Authentication Filters）。

• 資料壓縮過濾器（Data compression Filters）。

• 加密過濾器（Encryption Filters）。

• 觸發資源存取事件篩選器。

• 映像轉換過濾器（Image Conversion Filters）。

• 日誌記錄和審核過濾器（Logging and Auditing Filters）。

• MIME-TYPE 鏈過濾器（MIME-TYPE Chain Filters）。

• 標記化過濾器（Tokenizing Filters）。

• XSL/T 過濾器（XSL/T Filters），轉換 XML 內容。

過濾器被部署在部署描述檔web.xml 中，然後對應到您的應用程式的部署描述符中的Servlet 名稱或URL 模式。

當 Web 容器啟動 Web 應用程式時，它會為您在部署描述符中聲明的每一個過濾器建立一個實例。該過濾器執行的順序是按它們在部署描述符中聲明的順序。

Servlet 過濾器方法

過濾器是一個實作了 javax.servlet.Filter 介面的 Java 類別。 javax.servlet.Filter 介面定義了三個方法：

Servlet 過濾器實例

以下是 Servlet 過濾器的實例，將輸出客戶端的 IP 位址和目前的日期時間。本實例讓您對Servlet 過濾器有基本的了解，您可以使用相同的概念編寫更複雜的過濾器應用程式：

// 导入必需的 java 库
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
import java.util.*;

// 实现 Filter 类
public class LogFilter implements Filter  {
   public void  init(FilterConfig config) 
                         throws ServletException{
      // 获取初始化参数
      String testParam = config.getInitParameter("test-param"); 

      // 输出初始化参数
      System.out.println("Test Param: " + testParam); 
   }
   public void  doFilter(ServletRequest request, 
                 ServletResponse response,
                 FilterChain chain) 
                 throws java.io.IOException, ServletException {

      // 获取客户机的 IP 地址   
      String ipAddress = request.getRemoteAddr();

      // 记录 IP 地址和当前时间戳
      System.out.println("IP "+ ipAddress + ", Time "
                                       + new Date().toString());

      // 把请求传回过滤链
      chain.doFilter(request,response);
   }
   public void destroy( ){
      /* 在 Filter 实例被 Web 容器从服务移除之前调用 */
   }
}

以通常的方式編譯LogFilter.java，把您的類別檔案放入<Tomcat-installation-directory>/webapps/ROOT/WEB-INF/classes 中。

Web.xml 中的Servlet 過濾器映射（Servlet Filter Mapping）

定義過濾器，然後映射到一個URL 或Servlet，這與定義Servlet，然後映射到一個URL 模式方式大致相同。在部署描述符檔案web.xml 中為filter 標籤建立下面的項目：

<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>

上述過濾器適用於所有的Servlet，因為我們在設定中指定/* 。如果您只想在少數的 Servlet 上套用篩選器，您可以指定一個特定的 Servlet 路徑。

現在試著以常用的方式呼叫任何 Servlet，您將會看到在 Web 伺服器中產生的日誌。您也可以使用 Log4J 記錄器來把上面的日誌記錄到一個單獨的檔案。

使用多個過濾器

Web 應用程式可以根據特定的目的定義若干個不同的過濾器。假設您定義了兩個過濾器 AuthenFilter 和 LogFilter。您需要建立一個如下所述的不同的映射，其餘的處理與上述所講解的大致相同：

<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>

過濾器的應用順序

web.xml 中的filter-mapping 元素的順序決定了Web 容器應用過濾器到Servlet 的順序。若要反轉過濾器的順序，您只需要在 web.xml 檔案中反轉 filter-mapping 元素即可。

例如，上面的實例將先套用 LogFilter，然後再套用 AuthenFilter，但是下面的實例將會顛倒這個順序：

<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>