Java Servlet 規(guī)范 2.3 版引入了一種新的組件類型，稱為過濾器。甲濾波器動態(tài)地攔截請求和響應(yīng)，以變換或使用包含在請求或響應(yīng)中的信息。過濾器本身通常不創(chuàng)建響應(yīng)，而是提供可以“附加”到任何類型的 servlet 或 JSP 頁面的通用功能。

出于多種原因，過濾器很重要。首先，它們提供了將重復(fù)性任務(wù)封裝在可重用單元中的能力。有組織的開發(fā)人員一直在尋找模塊化代碼的方法。模塊化代碼更易于管理和記錄，更易于調(diào)試，如果做得好，可以在其他設(shè)置中重用。

其次，過濾器可用于轉(zhuǎn)換來自 servlet 或 JSP 頁面的響應(yīng)。Web 應(yīng)用程序的一個常見任務(wù)是格式化發(fā)送回客戶端的數(shù)據(jù)?？蛻舳嗽絹碓叫枰?HTML 以外的格式(例如 WML)。為了適應(yīng)這些客戶，在功能齊全的 Web 應(yīng)用程序中通常有一個強大的轉(zhuǎn)換或過濾組件。許多 servlet 和 JSP 容器都引入了專有過濾器機制，這為部署在該容器上的開發(fā)人員帶來了收益，但降低了此類代碼的可重用性。隨著過濾器作為 Java Servlet 規(guī)范的一部分的引入，開發(fā)人員現(xiàn)在有機會編寫可跨容器移植的可重用轉(zhuǎn)換組件。

過濾器可以執(zhí)行許多不同類型的功能。我們將討論本文中斜體項目的示例：

基于用戶身份的身份驗證阻止請求。

日志記錄和審計 -跟蹤 Web 應(yīng)用程序的用戶。

圖像轉(zhuǎn)換-縮放貼圖等。

數(shù)據(jù)壓縮 -使下載更小。

本地化 -針對特定語言環(huán)境的請求和響應(yīng)。

XML 內(nèi)容的 XSL/T 轉(zhuǎn)換 - 將Web 應(yīng)用程序響應(yīng)定位到不止一種類型的客戶端。

這些只是過濾器的一些應(yīng)用。還有更多，例如加密、標(biāo)記化、觸發(fā)資源訪問事件、mime 類型鏈接和緩存。

在本文中，我們將首先討論如何編寫過濾器來執(zhí)行以下類型的任務(wù)：

查詢請求并采取相應(yīng)措施

阻止請求和響應(yīng)對進一步傳遞。

修改請求頭和數(shù)據(jù)。您可以通過提供請求的自定義版本來完成此操作。

修改響應(yīng)頭和數(shù)據(jù)。您可以通過提供自定義版本的響應(yīng)來完成此操作。

我們將概述過濾器 API，并描述如何開發(fā)定制的請求和響應(yīng)。

對過濾器進行編程只是使用過濾器的一半工作——當(dāng)應(yīng)用程序部署在 Web 容器中時，您還需要配置它們?nèi)绾斡成涞?servlet。編程和配置的這種分離是過濾機制的主要好處：

您無需重新編譯任何內(nèi)容即可更改 Web 應(yīng)用程序的輸入或輸出。您只需編輯文本文件或使用工具來更改配置。例如，向 PDF 下載添加壓縮只是將壓縮過濾器映射到下載 servlet 的問題。

您可以輕松地試驗過濾器，因為它們非常易于配置。

本文的最后一部分展示了如何使用非常靈活的過濾器配置機制。閱讀本文后，您將掌握實現(xiàn)自己的過濾器的知識，并掌握一些基于一些常見過濾器類型的實用技巧。

編程過濾器

該過濾器API由定義Filter，F(xiàn)ilterChain和FilterConfig在所述接口javax.servlet包。您可以通過實現(xiàn)Filter 接口來定義過濾器 。由容器傳遞給過濾器的過濾器鏈提供了調(diào)用一系列過濾器的機制。過濾器配置包含初始化數(shù)據(jù)。

Filter接口中最重要的方法是doFilter方法，它是過濾器的核心。此方法通常執(zhí)行以下一些操作：

檢查請求標(biāo)頭

如果希望修改請求標(biāo)頭或數(shù)據(jù)或完全阻止請求，則自定義請求對象

如果希望修改響應(yīng)頭或數(shù)據(jù)，則自定義響應(yīng)對象

調(diào)用過濾器鏈中的下一個實體。如果當(dāng)前過濾器是鏈中以目標(biāo) servlet 結(jié)尾的最后一個過濾器，則下一個實體是鏈末尾的資源;否則，它是在 WAR 中配置的下一個過濾器。它通過調(diào)用doFilter鏈對象上的方法來調(diào)用下一個實體(傳入調(diào)用它的請求和響應(yīng)，或者它可能創(chuàng)建的包裝版本)?；蛘撸梢赃x擇通過不調(diào)用下一個實體來阻止請求。在后一種情況下，過濾器負(fù)責(zé)填寫響應(yīng)。

在調(diào)用鏈中的下一個過濾器后檢查響應(yīng)頭

拋出異常以指示處理中的錯誤

除了doFilter，您還必須實現(xiàn)init和destroy方法。it容器在實例化過濾器時調(diào)用in方法。如果您希望將初始化參數(shù)傳遞給過濾器，您可以從FilterConfig傳遞給的對象中檢索它們init。

示例：記錄 Servlet 訪問

現(xiàn)在您已經(jīng)知道過濾器 API 的主要元素是什么，讓我們來看看一個非常簡單的過濾器，它不會阻止請求、轉(zhuǎn)換響應(yīng)或任何花哨的東西——這是開始學(xué)習(xí) API 基本概念的好地方。

考慮跟蹤用戶數(shù)量的網(wǎng)站。要將此功能添加到現(xiàn)有 Web 應(yīng)用程序而不更改任何 servlet，您可以使用日志過濾器。

HitCounterFilter在訪問 servlet 時遞增并記錄計數(shù)器的值。在該doFilter方法中，HitCounterFilter首先從過濾器配置對象中檢索 servlet 上下文，以便它可以訪問存儲為上下文屬性的計數(shù)器。在過濾器檢索、遞增并將計數(shù)器寫入日志后，它會調(diào)用doFilter傳遞給原始doFilter方法的過濾器鏈對象。省略的代碼在編程定制的請求和響應(yīng)中討論 。

public final class HitCounterFilter implements Filter {
private FilterConfig filterConfig = null;
public void init(FilterConfig filterConfig) 
throws ServletException {
this.filterConfig = filterConfig;
}
public void destroy() {
this.filterConfig = null;
}
public void doFilter(ServletRequest request,
ServletResponse response, FilterChain chain) 
throws IOException, ServletException {
if (filterConfig == null)
return;
StringWriter sw = new StringWriter();
PrintWriter writer = new PrintWriter(sw);
Counter counter = (Counter)filterConfig.
getServletContext().
getAttribute("hitCounter");
writer.println();
writer.println("===============");
writer.println("The number of hits is: " +
counter.incCounter());
writer.println("===============");
// Log the resulting string
writer.flush();
filterConfig.getServletContext().
log(sw.getBuffer().toString());
...
chain.doFilter(request, wrapper);
...
}
}

示例：修改請求字符編碼

目前，很多瀏覽器在 HTTP 請求的 Content-Type 頭中不發(fā)送字符編碼信息。如果客戶端請求未指定編碼，則容器使用默認(rèn)編碼來解析請求參數(shù)。如果客戶端沒有設(shè)置字符編碼并且請求參數(shù)的編碼與默認(rèn)編碼不同，則參數(shù)將被錯誤解析。您可以使用該方法setCharacterEncoding在ServletRequest接口設(shè)置編碼。由于必須在解析任何發(fā)布數(shù)據(jù)或從請求中讀取任何輸入之前調(diào)用此方法，因此此函數(shù)是過濾器的主要應(yīng)用程序。

這種過濾器包含在隨Tomcat 4.0 Web 容器一起分發(fā)的示例 中。過濾器從過濾器初始化參數(shù)設(shè)置字符編碼。這個過濾器可以很容易地擴展到根據(jù)傳入請求的特征設(shè)置編碼，例如 Accept-Language 和 User-Agent 標(biāo)頭的值，或者保存在當(dāng)前用戶會話中的值。

public void doFilter(ServletRequest request, 
ServletResponse response, FilterChain chain) throws
IOException, ServletException {
String encoding = selectEncoding(request);
if (encoding != null)
request.setCharacterEncoding(encoding);
chain.doFilter(request, response);
}
public void init(FilterConfig filterConfig) throws
ServletException {
this.filterConfig = filterConfig;
this.encoding = filterConfig.getInitParameter("encoding");
}
protected String selectEncoding(ServletRequest request) {
return (this.encoding);
}

編程自定義請求和響應(yīng)

到目前為止，我們已經(jīng)看過一些簡單的例子。現(xiàn)在讓我們更復(fù)雜一點，看看一個過濾器，它修改來自客戶端的請求或響應(yīng)返回給客戶端。過濾器可以通過多種方式修改請求或響應(yīng)。例如，過濾器可以向請求添加一個屬性，或者它可以在響應(yīng)中插入數(shù)據(jù)或以其他方式轉(zhuǎn)換響應(yīng)。

修改響應(yīng)的過濾器通常必須在響應(yīng)返回給客戶端之前捕獲響應(yīng)。這樣做的方法是將生成響應(yīng)的 servlet 傳遞給一個替代流。替代流可防止 servlet 在完成時關(guān)閉原始響應(yīng)流，并允許過濾器修改 servlet 的響應(yīng)。

為了將此替代流傳遞給 servlet，過濾器創(chuàng)建了一個響應(yīng)“包裝器”，該響應(yīng)“包裝器”覆蓋getWriterorgetOutputStream方法以返回此替代流。包裝器被傳遞給doFilter過濾器鏈的方法。包裝方法默認(rèn)調(diào)用包裝的請求或響應(yīng)對象。這種方法遵循設(shè)計模式，可重用面向?qū)ο筌浖脑刂忻枋龅闹陌b器或裝飾器模式。以下部分描述了前面描述的命中計數(shù)器過濾器和其他類型的過濾器如何使用包裝器。

要覆蓋請求方法，請將請求包裝在一個擴展 或的對象中。要覆蓋響應(yīng)方法，請將響應(yīng)包裝在一個擴展 或 的對象中 。 ServletRequestWrapperHttpServletRequestWrapperServletResponseWrapperHttpServletResponseWrapper編程過濾器中描述的命中計數(shù)器過濾 器將計數(shù)器的值插入到響應(yīng)中。省略的代碼HitCounterFilter是：

PrintWriter out = response.getWriter();
CharResponseWrapper wrapper = new CharResponseWrapper(
    (HttpServletResponse)response);
chain.doFilter(request, wrapper);
if(wrapper.getContentType().equals("text/html")) {
   CharArrayWriter caw = new CharArrayWriter();
   caw.write(wrapper.toString().substring(0,
       wrapper.toString().indexOf("</body>")-1));
   caw.write("<p>\nYou are visitor number 
   <font color='red'>" + counter.getCounter() + "</font>");
   caw.write("\n</body></html>");
   response.setContentLength(caw.toString().length());
   out.write(caw.toString());
} else 
   out.write(wrapper.toString());
out.close();

HitCounterFilter將響應(yīng)包裝在一個CharResponseWrapper. CharResponseWrapper覆蓋該getWriter方法以返回一個替代流，過濾器鏈末尾的 servlet 將其響應(yīng)寫入該替代流。當(dāng)chain.doFilter返回時，HitCounterFilter檢索來自servlet的響應(yīng)PrintWriter，并將其寫入緩沖區(qū)，如果它是一個HTML的響應(yīng)。過濾器將計數(shù)器的值插入緩沖區(qū)，重置響應(yīng)的內(nèi)容長度頭，最后將緩沖區(qū)的內(nèi)容寫入響應(yīng)流。

public class CharResponseWrapper extends
   HttpServletResponseWrapper {
   private CharArrayWriter output;
   public String toString() {
       return output.toString();
  }
   public CharResponseWrapper(HttpServletResponse response){
       super(response);
       output = new CharArrayWriter();
  }
   public PrintWriter getWriter(){
       return new PrintWriter(output);
  }
}

示例：壓縮響應(yīng)

修改響應(yīng)的過濾器的另一個示例是隨 Tomcat servlet 引擎分發(fā)的示例中包含的壓縮過濾器。盡管高速 Internet 連接變得越來越普遍，但仍然需要有效地使用帶寬。壓縮過濾器很方便，因為您可以將它附加到任何 servlet 以減小響應(yīng)的大小。

與命中計數(shù)器過濾器一樣，壓縮過濾器創(chuàng)建一個替代流，在本例中CompressionResponseStream，用于 servlet 寫入并包裝傳遞給 servlet 的響應(yīng)。

僅當(dāng)客戶端可以接受壓縮響應(yīng)時，過濾器才會創(chuàng)建包裝器和替代流。servlet 將其響應(yīng)寫入它從包裝器檢索的壓縮流。一旦數(shù)據(jù)大于作為初始化參數(shù)傳遞給過濾器的閾值，則CompressionResponseStream覆蓋將write響應(yīng)數(shù)據(jù)寫入 a的方法GZIPOutputStream：

public void write(int b) throws IOException {
   ...
   if ((bufferCount >= buffer.length) || 
      (count>=compressionThreshold)) {
      compressionThresholdReached = true;
   }
   if (compressionThresholdReached) {
      writeToGZip(b);
   } else {
      buffer[bufferCount++] = (byte) b;
      count++;
   }
}

示例：轉(zhuǎn)換響應(yīng)

我們將討論的最后一個過濾器是 XSLT 過濾器。XSLT 是一種用于轉(zhuǎn)換 XML 數(shù)據(jù)的語言。您可以使用 XSLT 將 XML 文檔轉(zhuǎn)換為面向最終用戶的格式，例如 HTML 或 PDF，或另一種 XML 格式。一些示例應(yīng)用包括：

將一家公司要求的格式的 XML 文檔轉(zhuǎn)換為另一家公司要求的格式。

根據(jù)用戶偏好自定義網(wǎng)頁的外觀。

通過查看 User-Agent 標(biāo)頭并選擇樣式表，使同一 Web 應(yīng)用程序能夠響應(yīng)不同類型的客戶端，例如 WML 手機和 cHTML 手機。

考慮一個響應(yīng)產(chǎn)品庫存請求的 Web 服務(wù)。以下 XML 文檔是此類響應(yīng)的示例：

<book>
<isbn>123</isbn>
<title>Web Servers for Fun and Profit</title>
<quantity>10</quantity>
<price>$17.95</price>
</book>

以下 XSL 樣式表將此 XML 文檔呈現(xiàn)為 HTML 格式的面向用戶的庫存描述和 XML 格式的面向機器的版本。

<?xml version="1.0" ?> 
<xsl:stylesheet version="1.0" 
    xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<xsl:output method="html" omit-xml-declaration="yes"/>
<xsl:template match="/">
      <xsl:apply-templates/>
</xsl:template>
         <xsl:template match="book"> <html>
<body>There are <xsl:value-of select="quantity"/> copies of 
<i><xsl:value-of select="title"/></i> available.
</body>
</html>
</xsl:template>
</xsl:stylesheet>

<?xml version="1.0" ?> 
<xsl:stylesheet version="1.0" 
     xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<xsl:output method="xml" omit-xml-declaration="no"/>
<xsl:template match="/">
     <xsl:apply-templates/>
</xsl:template>
<xsl:template match="book">
<xsl:element name="book">
<xsl:attribute name="isbn"><xsl:value-of select="isbn"/></
xsl:attribute>
<xsl:element name="quantity"><xsl:value-of select="quantity"/
></xsl:element>
</xsl:element>
</xsl:template>
</xsl:stylesheet>

以下 XSLT 過濾器使用樣式表根據(jù)請求參數(shù)的值轉(zhuǎn)換響應(yīng)。過濾器根據(jù)請求參數(shù)設(shè)置響應(yīng)的內(nèi)容類型。然后將響應(yīng)包裝在 a 中CharResponseWrapper并傳遞給doFilter過濾器鏈的方法。過濾器鏈中的最后一個元素是一個 servlet，它返回前面描述的庫存響應(yīng)。當(dāng)doFilter返回時，過濾器檢索來自包裝器和轉(zhuǎn)換所述響應(yīng)數(shù)據(jù)它使用樣式表。

public void doFilter(ServletRequest request, 
   ServletResponse response, FilterChain chain)
   throws IOException, ServletException {
   String contentType;
   String styleSheet;
   String type = request.getParameter("type");
   if (type == null || type.equals("")) {
      contentType = "text/html";
      styleSheet = "/xml/html.xsl";
   } else {
      if (type.equals("xml")) {
         contentType = "text/plain";
         styleSheet = "/xml/xml.xsl";
      } else {
         contentType = "text/html";
         styleSheet = "/xml/html.xsl";
      }
   }
   response.setContentType(contentType);
   String stylepath=filterConfig.getServletContext().
      getRealPath(styleSheet);
   Source styleSource = new StreamSource(stylePath);
   PrintWriter out = response.getWriter();
   CharResponseWrapper responseWrapper = 
      new CharResponseWrapper(
         (HttpServletResponse)response);
   chain.doFilter(request, wrapper);
   // Get response from servlet
   StringReader sr = new StringReader(
      new String(wrapper.getData()));
   Source xmlSource = new StreamSource((Reader)sr);
   try {
      TransformerFactory transformerFactory =
         TransformerFactory.newInstance();
      Transformer transformer = transformerFactory.
         newTransformer(styleSource);
      CharArrayWriter caw = new CharArrayWriter();
      StreamResult result  = new StreamResult(caw);
      transformer.transform(xmlSource, result);
      response.setContentLength(caw.toString().length());
      out.write(caw.toString());
   } catch(Exception ex) {
      out.println(ex.toString());
      out.write(wrapper.toString());
   }
}

指定過濾器配置

現(xiàn)在我們已經(jīng)了解了如何編寫過濾器，最后一步是指定如何將其應(yīng)用于一個 Web 組件或一組 Web 組件。要將過濾器映射到 servlet，您：

使用<filter>Web 應(yīng)用程序部署描述符中的元素聲明過濾器。此元素為過濾器創(chuàng)建名稱并聲明過濾器的實現(xiàn)類和初始化參數(shù)。

通過<filter-mapping>在部署描述符中定義一個元素，將過濾器映射到 servlet 。此元素通過名稱或 URL 模式將過濾器名稱映射到 servlet。

以下元素顯示了如何指定壓縮過濾器所需的元素。要定義壓縮過濾器，您需要為過濾器提供一個名稱、實現(xiàn)過濾器的類以及閾值初始化參數(shù)的名稱和值。

<filter>
   <filter-name>Compression Filter</filter-name>
   <filter-class>CompressionFilter</filter-class>
   <init-param>
     <param-name>compressionThreshold</param-name>
     <param-value>10</param-value>
  </init-param>
</filter>

該filter-mapping元素將壓縮過濾器映射到 servlet CompressionTest。映射還可以指定 URL 模式/CompressionTest。請注意filter，filter-mapping、servlet、 和servlet-mapping元素必須按此順序出現(xiàn)在 Web 應(yīng)用程序部署描述符中。

<filter-mapping>
   <filter-name>Compression Filter</filter-name>
   <servlet-name>CompressionTest</servlet-name>
</filter-mapping>
<servlet>
  <servlet-name>CompressionTest</servlet-name>
  <servlet-class>CompressionTest</servlet-class>
</servlet>
<servlet-mapping>
  <servlet-name>CompressionTest</servlet-name>
  <url-pattern>/CompressionTest</url-pattern>
</servlet-mapping>

請注意，此映射會導(dǎo)致過濾器被調(diào)用以處理對CompressionTestservlet和映射到 URL 模式的任何 servlet JSP 或靜態(tài)內(nèi)容的所有請求/CompressionTest。

如果您想記錄對 Web 應(yīng)用程序的每個請求，您可以將命中計數(shù)器過濾器映射到 URL 模式/*。這是與示例一起分發(fā)的部署描述符：

?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web 
Application 2.3//EN" "http://bit.ly/15eRp2z">
<web-app>
<filter>
  <filter-name>XSLTFilter</filter-name>
  <filter-class>XSLTFilter</filter-class>
</filter>
<filter>
  <filter-name>HitCounterFilter</filter-name>
  <filter-class>HitCounterFilter</filter-class>
</filter>
<filter-mapping>
  <filter-name>HitCounterFilter</filter-name>
  <url-pattern>/*</url-pattern>
</filter-mapping>  
<filter-mapping>
  <filter-name>XSLTFilter</filter-name>
  <servlet-name>FilteredFileServlet</servlet-name>
</filter-mapping>  
<servlet>
  <servlet-name>FilteredFileServlet</servlet-name>
  <servlet-class>FileServlet</servlet-class>
</servlet>
<servlet-mapping>
  <servlet-name>FilteredFileServlet</servlet-name>
  <url-pattern>/ffs</url-pattern>
</servlet-mapping>
</web-app>

如您所見，您可以將一個過濾器映射到一個或多個 servlet，也可以將多個過濾器映射到一個 servlet。這在圖 1中進行了說明，其中過濾器 F1 映射到 servlet S1、S2 和 S3，過濾器 F2 映射到 servlet S2，過濾器 F3 映射到 servlet S1 和 S2。