Look into it ~

servlet API中最重要的一個功能就是能夠為servlet和JSP頁面定義過濾器。過濾器提供了某些早期服務器所支持的非標準“servlet鏈接”的一種功能強大且標準的替代品。
                                                                                                
     過濾器是一個程序，它先于與之相關的servlet或JSP頁面運行在服務器上。過濾器可附加到一個或多個servlet或JSP頁面上，并且可以檢查進入這些資源的請求信息。在這之后，過濾器可以作如下的選擇：

1. 以常規(guī)的方式調用資源（即，調用servlet或JSP頁面）。

2.利用修改過的請求信息調用資源。

3. 調用資源，但在發(fā)送響應到客戶機前對其進行修改

4. 阻止該資源調用，代之以轉到其他的資源，返回一個特定的狀態(tài)代碼或生成替換輸出。

過濾器提供了幾個重要好處 ：

        首先，它以一種模塊化的或可重用的方式封裝公共的行為。你有30個不同的serlvet或JSP頁面，需要壓縮它們的內容以減少下載時間嗎？沒問題：構造一個壓縮過濾器，然后將它應用到30個資源上即可。

其次，利用它能夠將高級訪問決策與表現(xiàn)代碼相分離。這對于JSP特別有價值，其中一般希望將幾乎整個頁面集中在表現(xiàn)上，而不是集中在業(yè)務邏輯上。例如，希 望阻塞來自某些站點的訪問而不用修改各頁面（這些頁面受到訪問限制）嗎？沒問題：建立一個訪問限制過濾器并把它應用到想要限制訪問的頁面上即可。

     最后，過濾器使你能夠對許多不同的資源進行批量性的更改。你有許多現(xiàn)存資源，這些資源除了公司名要更改外其他的保持不變，能辦到么？沒問題：構造一個串替換過濾器，只要合適就使用它。

     但要注意，過濾器只在與servlet規(guī)范2.3版兼容的服務器上有作用。如果你的Web應用需要支持舊版服務器，就不能使用過濾器。

1．   建立基本過濾器

建立一個過濾器涉及下列五個步驟：
1）建立一個實現(xiàn)Filter接口的類。這個類需要三個方法，分別是：doFilter、init和destroy。
       doFilter方法包含主要的過濾代碼（見第2步），init方法建立設置操作，而destroy方法進行清楚。

2）在doFilter方法中放入過濾行為。doFilter方法的第一個參數(shù)為ServletRequest對象。此對象給過濾器提供了對進入的信息 （包括表單數(shù)據(jù)、cookie和HTTP請求頭）的完全訪問。第二個參數(shù)為ServletResponse，通常在簡單的過濾器中忽略此參數(shù)。最后一個參 數(shù)為FilterChain，如下一步所述，此參數(shù)用來調用servlet或JSP頁。

3）調用FilterChain對象的doFilter方法。Filter接口的doFilter方法取一個FilterChain對象作為它的一個參 數(shù)。在調用此對象的doFilter方法時，激活下一個相關的過濾器。如果沒有另一個過濾器與servlet或JSP頁面關聯(lián)，則servlet或JSP 頁面被激活。

4）對相應的servlet和JSP頁面注冊過濾器。在部署描述符文件（web.xml）中使用filter和filter-mapping元素。

5）禁用激活器servlet。防止用戶利用缺省servlet URL繞過過濾器設置。

1.1   建立一個實現(xiàn)Filter接口的類
      所有過濾器都必須實現(xiàn)javax.servlet.Filter。這個接口包含三個方法，分別為doFilter、init和destroy。

public void doFilter(ServletRequset request,
                     ServletResponse response,
                     FilterChain chain)
     thows ServletException, IOException

每當調用一個過濾器（即，每次請求與此過濾器相關的servlet或JSP頁面）時，就執(zhí)行其doFilter方法。正是這個方法包含了大部分過濾邏輯。 第一個參數(shù)為與傳入請求有關的ServletRequest。對于簡單的過濾器，大多數(shù)過濾邏輯是基于這個對象的。如果處理HTTP請求，并且需要訪問諸 如getHeader或getCookies等在ServletRequest中無法得到的方法，就要把此對象構造成 HttpServletRequest。

第二個參數(shù)為ServletResponse。除了在兩個情形下要使用它以外，通常忽略這個參數(shù)。首先，如果希望完全阻塞對相關servlet或JSP頁 面的訪問。可調用response.getWriter并直接發(fā)送一個響應到客戶機。其次，如果希望修改相關的servlet或JSP頁面的輸出，可把響 應包含在一個收集所有發(fā)送到它的輸出的對象中。然后，在調用serlvet或JSP頁面后，過濾器可檢查輸出，如果合適就修改它，之后發(fā)送到客戶機。

DoFilter的最后一個參數(shù)為FilterChain對象。對此對象調用doFilter以激活與servlet或JSP頁面相關的下一個過濾器。如果沒有另一個相關的過濾器，則對doFilter的調用激活servlet或JSP本身。

public void init(FilterConfig config)   thows ServletException

init方法只在此過濾器第一次初始化時執(zhí)行，不是每次調用過濾器都執(zhí)行它。對于簡單的過濾器，可提供此方法的一個空體，但有兩個原因需要使用init。 首先，F(xiàn)ilterConfig對象提供對servlet環(huán)境及web.xml文件中指派的過濾器名的訪問。因此，普遍的辦法是利用init將 FilterConfig對象存放在一個字段中，以便doFilter方法能夠訪問servlet環(huán)境或過濾器名.其次，F(xiàn)ilterConfig對象具 有一個getInitParameter方法，它能夠訪問部署描述符文件（web.xml）中分配的過濾器初始化參數(shù)。

public void destroy( )
     大多數(shù)過濾器簡單地為此方法提供一個空體，不過，可利用它來完成諸如關閉過濾器使用的文件或數(shù)據(jù)庫連接池等清除任務。

1.2   將過濾行為放入doFilter方法
     doFilter方法為大多數(shù)過濾器地關鍵部分。每當調用一個過濾器時，都要執(zhí)行doFilter。對于大多數(shù)過濾器來說，doFilter執(zhí)行的步驟是 基于傳入的信息的。因此，可能要利用作為doFilter的第一個參數(shù)提供的ServletRequest。這個對象常常構造為 HttpServletRequest類型，以提供對該類的更特殊方法的訪問。

1.3   調用FilterChain對象的doFilter方法
     Filter接口的doFilter方法以一個FilterChain對象作為它的第三個參數(shù)。在調用該對象的doFilter方法時，激活下一個相關的 過濾器。這個過程一般持續(xù)到鏈中最后一個過濾器為止。在最后一個過濾器調用其FilterChain對象的doFilter方法時，激活servlet或 頁面自身。
但是，鏈中的任意過濾器都可以通過不調用其FilterChain的doFilter方法中斷這個過程。在這樣的情況下，不再調用JSP頁面的serlvet，并且中斷此調用過程的過濾器負責將輸出提供給客戶機。

1.4   對適當?shù)膕ervlet和JSP頁面注冊過濾器
     部署描述符文件的2.3版本引入了兩個用于過濾器的元素，分別是：filter和filter-mapping。filter元素向系統(tǒng)注冊一個過濾對象，filter-mapping元素指定該過濾對象所應用的URL。

1.filter元素
filter元素位于部署描述符文件（web.xml）的前部，所有filter-mapping、servlet或servlet-mapping元素之前。filter元素具有如下六個可能的子元素：

1、 icon   這是一個可選的元素，它聲明IDE能夠使用的一個圖象文件。
2、filter-name   這是一個必需的元素，它給過濾器分配一個選定的名字。
3、display-name   這是一個可選的元素，它給出IDE使用的短名稱。
4、 description   這也是一個可選的元素，它給出IDE的信息，提供文本文檔。
5、 filter-class   這是一個必需的元素，它指定過濾器實現(xiàn)類的完全限定名。
6、 init-param   這是一個可選的元素，它定義可利用FilterConfig的getInitParameter方法讀取的初始化參數(shù)。單個過濾器元素可包含多個init-param元素。

請注意，過濾是在serlvet規(guī)范2.3版中初次引入的。因此，web.xml文件必須使用DTD的2.3版本。下面介紹一個簡單的例子：

  <xml version="1.0" encoding="ISO-8859-1"?>
    DOCTYPE web-app PUBLIC
        "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
         "http://java.sun.com/dtd/web-app_2_3.dtd">
    <web-app>
     <filter>
        <filter-name>MyFilterfilter-name>
        <filter-class>myPackage.FilterClassfilter-class>
      filter>
      
      <filter-mapping>...filter-mapping>
     <web-app>


2.filter-mapping元素
    filter-mapping元素位于web.xml文件中filter元素之后serlvet元素之前。它包含如下三個可能的子元素：

1、 filter-name   這個必需的元素必須與用filter元素聲明時給予過濾器的名稱相匹配。

2、 url-pattern   此元素聲明一個以斜杠（/）開始的模式，它指定過濾器應用的URL。所有filter-mapping元素中必須提供url-pattern或 servlet-name。但不能對單個filter-mapping元素提供多個url-pattern元素項。如果希望過濾器適用于多個模式，可重復 整個filter-mapping元素。

3、 servlet-name   此元素給出一個名稱，此名稱必須與利用servlet元素給予servlet或JSP頁面的名稱相匹配。不能給單個filter-mapping元素提供 多個servlet-name元素項。如果希望過濾器適合于多個servlet名，可重復這個filter-mapping元素。
下面舉一個例子：

xml version="1.0" encoding="ISO-8859-1"?>
    DOCTYPE web-app PUBLIC
        "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
        "http://java.sun.com/dtd/web-app_2_3.dtd">
    <web-app>
      <filter>
        <filter-name>MyFilterfilter-name>
        <filter-class>myPackage.FilterClassfilter-class>
      filter>
      
      <filter-mapping>
        <filter-name>MyFilterfilter-name>
        <url-pattern>/someDirectory/SomePage.jspurl-pattern>
      filter-mapping>
    web-app>

1.5   禁用激活器servlet
     在對資源應用過濾器時，可通過指定要應用過濾器的URL模式或servlet名來完成。如果提供servlet名，則此名稱必須與web.xml的 servlet元素中給出的名稱相匹配。如果使用應用到一個serlvet的URL模式，則此模式必須與利用web.xml的元素servlet- mapping指定的模式相匹配。但是，多數(shù)服務器使用“激活器servlet”為servlet體統(tǒng)一個缺省的URL：http: //host/WebAppPrefix/servlet/ServletName。需要保證用戶不利用這個URL訪問servlet（這樣會繞過過濾器 設置）。
例如，假如利用filter和filter-mapping指示名為SomeFilter的過濾器應用到名為SomeServlet的servlet，則如下：

<filter>
      <filter-name>SomeFilterfilter-name>
      <filter-class>somePackage.SomeFilterClassfilter-class>
   <filter>
    
    <filter-mapping>
      <filter-name>SomeFilterfilter-name>
      <servlet-name>SomeServletservlet-name>
     <filter-mapping>

接著，用servlet和servlet-mapping規(guī)定URL   http://host/webAppPrefix/Blah 應該調用SomeSerlvet，如下所示：

<filter>
      <filter-name>SomeFilterfilter-name>
      <filter-class>somePackage.SomeFilterClassfilter-class>
    filter>
    
    <filter-mapping>
      <filter-name>SomeFilterfilter-name>
      <servlet-name>/Blahservlet-name>
     <filter-mapping>

現(xiàn)在，在客戶機使用URL   http://host/webAppPrefix/Blah 時就會調用過濾器。過濾器不應用到
http://host/webAppPrefix/servlet/SomePackage.SomeServletClass。
盡管有關閉激活器的服務器專用方法。但是，可移植最強的方法時重新映射Web應用鐘的/servlet模式，這樣使所有包含此模式的請求被送到相同的 servlet中。為了重新映射此模式，首先應該建立一個簡單的servlet，它打印一條錯誤消息，或重定向用戶到頂層頁。然后，使用servlet和 servlet-mapping元素發(fā)送包含/servlet模式的請求到該servlet。程序清單9-1給出了一個簡短的例子。

程序清單9-1 web.xml（重定向缺省servlet URL的摘錄）

 xml version="1.0" encoding="ISO-8859-1"?>
    DOCTYPE web-app PUBLIC
         "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
         "http://java.sun.com/dtd/web-app_2_3.dtd">
    <web-app>
    
    <servlet>
      <servlet-name>Errorservlet-name>
      <servlet-class>somePackage.ErrorServletservlet-class>
    servlet>
    
    <servlet-mapping>
      <servlet-name>Errorservlet-name>
      <url-pattern>/servlet/*url-pattern>
    servlet-mapping>
    
    <web-app>

web.xml加配置

<!--   過濾器 -->
 <filter>
  <filter-name>Filter</filter-name>
  <filter-class>
   com.util.EncodingFilter<!-- 過濾器類 -->
  </filter-class>
  <init-param>
   <param-name>Encoding</param-name>
   <param-value>gb2312</param-value>
  </init-param>
 </filter>
 <filter-mapping>
  <filter-name>Filter</filter-name>
  <url-pattern>/*</url-pattern>
 </filter-mapping>

EncodingFilter.java

package com.hibernate.util;

import java.io.IOException;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;

public class EncodingFilter implements Filter {
 protected FilterConfig config;

 protected String Encoding = null;

 public void init(FilterConfig config) throws ServletException {

  this.config = config;
  this.Encoding = config.getInitParameter("Encoding");

 }

 public void doFilter(ServletRequest request, ServletResponse response,
   FilterChain chain) throws IOException, ServletException {

  if (request.getCharacterEncoding() == null) {
   if (Encoding != null) {
    request.setCharacterEncoding(Encoding);
    response.setCharacterEncoding(Encoding);
   }
  }
  chain.doFilter(request,response);
 }
 public void destroy() {}
}

OK!!!

1. package com.javaeye.wqf;  
2. import javax.servlet.*;  
3.   
4. public class CounterFilter implements Filter {  
5.     public void doFilter(ServletRequest request, ServletResponse response,  
6.             FilterChain chain) throws IOException, ServletException {  
7.         long start = System.currentTimeMillis();  
8.         System.out.println("Filter start at "+start);  
9.         chain.doFilter(request, response);  
10.         long end = System.currentTimeMillis();  
11.         System.out.println("Filter end at "+end);  
12.     } 
    
13. } 
    

1. <filter>  
2.     <filter-name>test</filter-name>  
3.     <filter-class>com.javaeye.wqf.CounterFilter</filter-class>  
4. </filter>  
5.   
6. <filter-mapping>  
7.     <filter-name>test</filter-name>  
8.     <url-pattern>/*</url-pattern>  
9. </filter-mapping> 
   

1. System.out.println("Filter end at "+end);