編寫過(guò)濾器

2018-08-12 21:20 更新

編寫過(guò)濾器

Servlet 過(guò)濾器是Java 類,可用于 Servlet 編程中的下述目的:

  • 在它們?cè)L問(wèn)后端資源之前,攔截這些來(lái)自客戶端的請(qǐng)求。

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

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

  • 身份驗(yàn)證過(guò)濾器。

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

  • 加密過(guò)濾器。

  • 觸發(fā)訪問(wèn)事件資源的過(guò)濾器。

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

  • 日志記錄和審核過(guò)濾器。

  • MIME-類型鏈過(guò)濾器。

  • Tokenizing 過(guò)濾器。

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

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

當(dāng) web 容器啟動(dòng)你的 web 應(yīng)用程序時(shí),它會(huì)為每個(gè)在部署描述符中已聲明的過(guò)濾器創(chuàng)建一個(gè)實(shí)例。過(guò)濾器按照它們?cè)诓渴鹈枋龇新暶鞯捻樞驁?zhí)行。

Servlet 過(guò)濾器方法

過(guò)濾器僅僅是一個(gè)實(shí)現(xiàn)了 javax.servlet.Filter 接口的 Java 類。javax.servlet.Filter 接口定義了三種方法:

序號(hào) 方法 & 描述
1

public void doFilter (ServletRequest, ServletResponse, FilterChain)

該方法在每次一個(gè)請(qǐng)求/響應(yīng)對(duì)因客戶端在鏈的末端請(qǐng)求資源而通過(guò)鏈傳遞時(shí)由容器調(diào)用。

2

public void init(FilterConfig filterConfig)

該方法由 Web 容器調(diào)用,指示一個(gè)過(guò)濾器被放入服務(wù)。

3

public void destroy()

該方法由 Web 容器調(diào)用,指示一個(gè)過(guò)濾器從服務(wù)被去除。

Servlet 過(guò)濾器實(shí)例

以下是 Servlet 過(guò)濾器的實(shí)例,將輸出客戶端的 IP 地址和當(dāng)前的日期時(shí)間。這個(gè)例子使你對(duì) Servlet 過(guò)濾器有了基本的了解,但是你可以使用相同的概念編寫更復(fù)雜的過(guò)濾器應(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 過(guò)濾器映射

過(guò)濾器被定義然后被映射到一個(gè) URL 或 Servlet中,這與Servlet被定義然后映射到一個(gè) URL 模式中的方法是相同的。為在部署描述符文件 web.xml 中過(guò)濾器標(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>

上述過(guò)濾器可以應(yīng)用到所有的 servlet 中,因?yàn)樵谂渲弥形覀冎付?/* 。如果你只想在少數(shù)的 servlet 中應(yīng)用過(guò)濾器,那么你可以指定一個(gè)特定的 servlet 路徑。

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

使用多個(gè)過(guò)濾器

Web 應(yīng)用程序可以定義多個(gè)帶有不同目的的過(guò)濾器??紤]這種情況,你定義了兩個(gè)過(guò)濾器 AuthenFilterLogFilter。除了你需要?jiǎng)?chuàng)建一個(gè)如下所述的不同的映射之外,其余的處理與上述解釋的一樣:

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

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

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

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

<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>
以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)