一、Filter簡介
　　Filter也稱之為過濾器，它是Servlet技術中最激動人心的技術之一，WEB開發人員通過Filter技術，對web伺服器管理的所有web資源：例如Jsp,Servlet, 靜態圖片檔案或靜態html檔案等進行攔截，從而實現一些特殊的功能。例如實現URL級別的許可權訪問控制、過濾敏感詞彙、壓縮響應資訊等一些高階功能。
　　Servlet API中提供了一個Filter介面，開發web應用時，如果編寫的Java類實現了這個介面，則把這個java類稱之為過濾器Filter。通過Filter技術，開發人員可以實現使用者在訪問某個目標資源之前，對訪問的請求和響應進行攔截，Filter介面原始碼：

[java] view plain copy

1. public abstract interface Filter{  
2.     public abstract void init(FilterConfig paramFilterConfig) throws ServletException;  
3.     public abstract void doFilter(ServletRequest paramServletRequest, ServletResponse paramServletResponse, FilterChain   
4.         paramFilterChain) throws IOException, ServletException;  
5.     public abstract void destroy();  
6. }  

二、Filter是如何實現攔截的？(Filter的工作原理)
　　Filter介面中有一個doFilter方法，當我們編寫好Filter，並配置對哪個web資源進行攔截後，WEB伺服器每次在呼叫web資源的service方法之前，都會先呼叫一下filter的doFilter方法，因此，在該方法內編寫程式碼可達到如下目的：
    呼叫目標資源之前，讓一段程式碼執行。
    是否呼叫目標資源（即是否讓使用者訪問web資源）。
    呼叫目標資源之後，讓一段程式碼執行。
　　web伺服器在呼叫doFilter方法時，會傳遞一個filterChain物件進來，filterChain物件是filter介面中最重要的一個物件，它也提供了一個doFilter方法，開發人員可以根據需求決定是否呼叫此方法，呼叫該方法，則web伺服器就會呼叫web資源的service方法，即web資源就會被訪問，否則web資源不會被訪問。

三、Filter開發流程

3.1、Filter開發步驟
Filter開發分為2步：
 * 編寫java類實現Filter介面，並實現其doFilter方法。
 * 在web.xml 檔案中使用<filter>和<filter-mapping>元素對編寫的filter類進行註冊，並設定它所能攔截的資源。

過濾器範例：

[java] view plain copy

1. import java.io.IOException;  
2. import javax.servlet.Filter;  
3. import javax.servlet.FilterChain;  
4. import javax.servlet.FilterConfig;  
5. import javax.servlet.ServletException;  
6. import javax.servlet.ServletRequest;  
7. import javax.servlet.ServletResponse;  
8. /** 
9.  * @author yangcq 
10.  * @description 過濾器Filter的工作原理 
11.  */  
12. public class FilterTest implements Filter{  
13.   
14.     public void destroy() {  
15.         System.out.println("----Filter銷燬----");  
16.     }  
17.   
18.     public void doFilter(ServletRequest request, ServletResponse response,FilterChain filterChain) throws IOException, ServletException {  
19.         // 對request、response進行一些預處理  
20.         request.setCharacterEncoding("UTF-8");  
21.         response.setCharacterEncoding("UTF-8");  
22.         response.setContentType("text/html;charset=UTF-8");  
23.         System.out.println("----呼叫service之前執行一段程式碼----");  
24.         filterChain.doFilter(request, response); // 執行目標資源，放行  
25.         System.out.println("----呼叫service之後執行一段程式碼----");  
26.     }  
27.   
28.     public void init(FilterConfig arg0) throws ServletException {  
29.         System.out.println("----Filter初始化----");  
30.     }  
31. }  

在web. xml中配置過濾器：

[html] view plain copy

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <web-app version="3.0"   
3.     xmlns="http://java.sun.com/xml/ns/javaee"   
4.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"   
5.     xsi:schemaLocation="http://java.sun.com/xml/ns/javaee   
6.     http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">  
7.   <display-name></display-name>      
8.   <welcome-file-list>  
9.     <welcome-file>index.jsp</welcome-file>  
10.   </welcome-file-list>  
11.   <!--配置過濾器-->  
12.   <filter>  
13.       <filter-name>FilterTest</filter-name>  
14.       <filter-class>com.yangcq.filter.FilterTest</filter-class>  
15.   </filter>  
16.   <!--對映過濾器-->  
17.   <filter-mapping>  
18.       <filter-name>FilterTest</filter-name>  
19.       <!--“/*”表示攔截所有的請求 -->  
20.       <url-pattern>/*</url-pattern>  
21.   </filter-mapping>  
22. </web-app>  

3.2、Filter鏈
　　在一個web應用中，可以開發編寫多個Filter，這些Filter組合起來稱之為一個Filter鏈。web伺服器根據Filter在web.xml檔案中的註冊順序，決定先呼叫哪個Filter，當第一個Filter的doFilter方法被呼叫時，web伺服器會建立一個代表Filter鏈的FilterChain物件傳遞給該方法。在doFilter方法中，開發人員如果呼叫了FilterChain物件的doFilter方法，則web伺服器會檢查FilterChain物件中是否還有filter，如果有，則呼叫第2個filter，如果沒有，則呼叫目標資源。

四，Spring框架下，過濾器的配置
    如果專案中使用了Spring框架，那麼，很多過濾器都不用自己來寫了，Spring為我們寫好了一些常用的過濾器。下面我們就以字元編碼的
過濾器CharacterEncodingFilter為例，來看一下Spring框架下，如果配置過濾器。

[html] view plain copy

1. <filter>  
2.     <filter-name>encodingFilter</filter-name>  
3.     <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>  
4.     <init-param>  
5.         <param-name>encoding</param-name>  
6.         <param-value>UTF-8</param-value>  
7.     </init-param>  
8.     <init-param>  
9.         <param-name>forceEncoding</param-name>  
10.         <param-value>true</param-value>  
11.     </init-param>  
12. </filter>  
13.   
14. <filter-mapping>  
15.     <filter-name>encodingFilter</filter-name>  
16.     <url-pattern>/*</url-pattern>  
17. </filter-mapping>  

很簡單吧，這樣幾行配置程式碼，就完成了從全域性控制字元編碼的功能。接下來，我們看一下CharacterEncodingFilter這個過濾器的關鍵程式碼，感受一下，大師的風采，如果我們寫過濾器的話，可以以此為範例。

[java] view plain copy

1. package org.springframework.web.filter;  
2. import java.io.IOException;  
3. import javax.servlet.FilterChain;  
4. import javax.servlet.ServletException;  
5. import javax.servlet.http.HttpServletRequest;  
6. import javax.servlet.http.HttpServletResponse;  
7. import org.springframework.util.ClassUtils;  
8. public class CharacterEncodingFilter extends OncePerRequestFilter{  
9.     private static final boolean responseSetCharacterEncodingAvailable = ClassUtils.hasMethod(  
10.         class$javax$servlet$http$HttpServletResponse, "setCharacterEncoding", new Class[] { String.class });  
11.     // 需要設定的編碼方式，為了支援可配置，Spring把編碼方式設定成了一個變數  
12.     private String encoding;  
13.     // 是否強制使用統一編碼，也是為了支援可配置  
14.     private boolean forceEncoding;  
15.     // 構造器，在這裡，Spring把forceEncoding的值預設設定成了false  
16.     public CharacterEncodingFilter(){  
17.         this.forceEncoding = false;  
18.     }  
19.     // encoding/forceEncoding的setter方法  
20.     public void setEncoding(String encoding){  
21.         this.encoding = encoding;  
22.     }  
23.     public void setForceEncoding(boolean forceEncoding){  
24.         this.forceEncoding = forceEncoding;  
25.     }  
26.     // Spring通過GenericFilterBean抽象類，對Filter介面進行了整合，  
27.     protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)  
28.         throws ServletException, IOException{  
29.         if ((this.encoding != null) && (((this.forceEncoding) || (request.getCharacterEncoding() == null)))) {  
30.             request.setCharacterEncoding(this.encoding);  
31.             if ((this.forceEncoding) && (responseSetCharacterEncodingAvailable)) {  
32.                 response.setCharacterEncoding(this.encoding);  
33.             }  
34.         }  
35.         filterChain.doFilter(request, response);  
36.     }  
37. }  

GenericFilterBean類：
public abstract class GenericFilterBean implements Filter, BeanNameAware, ServletContextAware, InitializingBean, DisposableBean
還沒有過癮，那就再看一個專案中使用過的一個過濾器：InvilidCharacterFilter（防止指令碼攻擊的過濾器）

[java] view plain copy

1. import java.io.IOException;  
2. import java.util.Enumeration;  
3. import javax.servlet.FilterChain;  
4. import javax.servlet.RequestDispatcher;  
5. import javax.servlet.ServletException;  
6. import javax.servlet.http.HttpServletRequest;  
7. import javax.servlet.http.HttpServletResponse;  
8. import org.apache.commons.lang.StringUtils;  
9. import org.springframework.web.filter.CharacterEncodingFilter;  
10. /* 
11.  * InvalidCharacterFilter：過濾request請求中的非法字元，防止指令碼攻擊 
12.  * InvalidCharacterFilter繼承了Spring框架的CharacterEncodingFilter過濾器，當然，我們也可以自己實現這樣一個過濾器 
13.  */  
14. public class InvalidCharacterFilter extends CharacterEncodingFilter{  
15.     // 需要過濾的非法字元  
16.     private static String[] invalidCharacter = new String[]{  
17.         "script","select","insert","document","window","function",  
18.         "delete","update","prompt","alert","create","alter",  
19.         "drop","iframe","link","where","replace","function","onabort",  
20.         "onactivate","onafterprint","onafterupdate","onbeforeactivate",  
21.         "onbeforecopy","onbeforecut","onbeforedeactivateonfocus",  
22.         "onkeydown","onkeypress","onkeyup","onload",  
23.         "expression","applet","layer","ilayeditfocus","onbeforepaste",  
24.         "onbeforeprint","onbeforeunload","onbeforeupdate",  
25.         "onblur","onbounce","oncellchange","oncontextmenu",  
26.         "oncontrolselect","oncopy","oncut","ondataavailable",  
27.         "ondatasetchanged","ondatasetcomplete","ondeactivate",  
28.         "ondrag","ondrop","onerror","onfilterchange","onfinish","onhelp",  
29.         "onlayoutcomplete","onlosecapture","onmouse","ote",  
30.         "onpropertychange","onreadystatechange","onreset","onresize",  
31.         "onresizeend","onresizestart","onrow","onscroll",  
32.         "onselect","onstaronsubmit","onunload","IMgsrc","infarction"  
33.     };  
34.   
35.     protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)  
36.             throws ServletException, IOException{     
37.         String parameterName = null;  
38.         String parameterValue = null;  
39.         // 獲取請求的引數  
40.         @SuppressWarnings("unchecked")  
41.         Enumeration<String> allParameter = request.getParameterNames();  
42.         while(allParameter.hasMoreElements()){  
43.             parameterName = allParameter.nextElement();  
44.             parameterValue = request.getParameter(parameterName);  
45.             if(null != parameterValue){  
46.                 for(String str : invalidCharacter){  
47.                     if (StringUtils.containsIgnoreCase(parameterValue, str)){  
48.                         request.setAttribute("errorMessage", "非法字元：" + str);  
49.                         RequestDispatcher requestDispatcher = request.getRequestDispatcher("/error.jsp");  
50.                         requestDispatcher.forward(request, response);  
51.                         return;  
52.                     }  
53.                 }  
54.             }  
55.         }  
56.         super.doFilterInternal(request, response, filterChain);  
57.     }  
58. }  

接下來需要在web.xml中進行配置：

[html] view plain copy

1. <filter>  
2.     <filter-name>InvalidCharacterFilter</filter-name>  
3.     <filter-class>com.yangcq.filter.InvalidCharacterFilter</filter-class>  
4. </filter>  
5. <filter-mapping>  
6.     <filter-name>InvalidCharacterFilter</filter-name>  
7.     <url-pattern>/*</url-pattern>  
8. </filter-mapping>  

如果我們不使用Spring的CharacterEncodingFilter類，可以自己來寫。

[java] view plain copy

1. import java.io.IOException;  
2. import java.util.Enumeration;  
3. import javax.servlet.Filter;  
4. import javax.servlet.FilterChain;  
5. import javax.servlet.FilterConfig;  
6. import javax.servlet.RequestDispatcher;  
7. import javax.servlet.ServletException;  
8. import javax.servlet.ServletRequest;  
9. import javax.servlet.ServletResponse;  
10. import org.apache.commons.lang.StringUtils;  
11. /** 
12.  * SelfDefineInvalidCharacterFilter：過濾request請求中的非法字元，防止指令碼攻擊 
13.  */  
14. public class SelfDefineInvalidCharacterFilter implements Filter{  
15.   
16.     public void destroy() {  
17.           
18.     }  
19.   
20.     public void doFilter(ServletRequest request, ServletResponse response, FilterChain filterChain) throws IOException, ServletException {  
21.         String parameterName = null;  
22.         String parameterValue = null;  
23.         // 獲取請求的引數  
24.         @SuppressWarnings("unchecked")  
25.         Enumeration<String> allParameter = request.getParameterNames();  
26.         while(allParameter.hasMoreElements()){  
27.             parameterName = allParameter.nextElement();  
28.             parameterValue = request.getParameter(parameterName);  
29.             if(null != parameterValue){  
30.                 for(String str : invalidCharacter){  
31.                     if (StringUtils.containsIgnoreCase(parameterValue, str)){  
32.                         request.setAttribute("errorMessage", "非法字元：" + str);  
33.                         RequestDispatcher requestDispatcher = request.getRequestDispatcher("/error.jsp");  
34.                         requestDispatcher.forward(request, response);  
35.                         return;  
36.                     }  
37.                 }  
38.             }  
39.         }  
40.         filterChain.doFilter(request, response); // 執行目標資源，放行  
41.     }  
42.   
43.     public void init(FilterConfig filterConfig) throws ServletException {  
44.           
45.     }  
46.     // 需要過濾的非法字元  
47.     private static String[] invalidCharacter = new String[]{  
48.         "script","select","insert","document","window","function",  
49.         "delete","update","prompt","alert","create","alter",  
50.         "drop","iframe","link","where","replace","function","onabort",  
51.         "onactivate","onafterprint","onafterupdate","onbeforeactivate",  
52.         "onbeforecopy","onbeforecut","onbeforedeactivateonfocus",  
53.         "onkeydown","onkeypress","onkeyup","onload",  
54.         "expression","applet","layer","ilayeditfocus","onbeforepaste",  
55.         "onbeforeprint","onbeforeunload","onbeforeupdate",  
56.         "onblur","onbounce","oncellchange","oncontextmenu",  
57.         "oncontrolselect","oncopy","oncut","ondataavailable",  
58.         "ondatasetchanged","ondatasetcomplete","ondeactivate",  
59.         "ondrag","ondrop","onerror","onfilterchange","onfinish","onhelp",  
60.         "onlayoutcomplete","onlosecapture","onmouse","ote",  
61.         "onpropertychange","onreadystatechange","onreset","onresize",  
62.         "onresizeend","onresizestart","onrow","onscroll",  
63.         "onselect","onstaronsubmit","onunload","IMgsrc","infarction"  
64.     };  
65.   
66. }  

接下來需要在web.xml中進行配置：

[html] view plain copy

1. <filter>  
2.     <filter-name>SelfDefineInvalidCharacterFilter</filter-name>  
3.     <filter-class>com.yangcq.filter.SelfDefineInvalidCharacterFilter</filter-class>  
4. </filter>  
5. <filter-mapping>  
6.     <filter-name>SelfDefineInvalidCharacterFilter</filter-name>  
7.     <url-pattern>/*</url-pattern>  
8. </filter-mapping>  

五、Filter的生命週期
5.1、Filter的建立
　　Filter的建立和銷燬由web伺服器負責。 web應用程式啟動時，web伺服器將建立Filter的例項物件，並呼叫其init方法，完成物件的初始化功能，從而為後續的使用者請求作好攔截的準備工作，filter物件只會建立一次，init方法也只會執行一次。通過init方法的引數，可獲得代表當前filter配置資訊的FilterConfig物件。
5.2、Filter的銷燬
　　web容器呼叫destroy方法銷燬Filter。destroy方法在Filter的生命週期中僅執行一次。在destroy方法中，可以釋放過濾器使用的資源。
5.3、FilterConfig介面
　　使用者在配置filter時，可以使用<init-param>為filter配置一些初始化引數，當web容器例項化Filter物件，呼叫其init方法時，會把封裝了filter初始化引數的filterConfig物件傳遞進來。因此開發人員在編寫filter時，通過filterConfig物件的方法，就可獲得：
　　String getFilterName()：得到filter的名稱。
　　String getInitParameter(String name)： 返回在部署描述中指定名稱的初始化引數的值。如果不存在返回null.
　　Enumeration getInitParameterNames()：返回過濾器的所有初始化引數的名字的列舉集合。
　　public ServletContext getServletContext()：返回Servlet上下文物件的引用。
示例：利用FilterConfig得到filter配置資訊

[java] view plain copy

1. package com.yangcq.filter;  
2. import java.io.IOException;  
3. import java.util.Enumeration;  
4. import javax.servlet.Filter;  
5. import javax.servlet.FilterChain;  
6. import javax.servlet.FilterConfig;  
7. import javax.servlet.ServletException;  
8. import javax.servlet.ServletRequest;  
9. import javax.servlet.ServletResponse;  
10. public class FilterTest implements Filter {  
11.   
12.     /* 過濾器初始化 
13.      * @see javax.servlet.Filter#init(javax.servlet.FilterConfig) 
14.      */  
15.     @Override  
16.     public void init(FilterConfig filterConfig) throws ServletException {  
17.         System.out.println("----過濾器初始化----");  
18.         /** 
19.          *  <filter> 
20.                   <filter-name>FilterTest</filter-name> 
21.                   <filter-class>com.yangcq.filter.FilterTest</filter-class> 
22.                   <!--配置FilterTest過濾器的初始化引數--> 
23.                   <init-param> 
24.                       <description>FilterTest</description> 
25.                       <param-name>name</param-name> 
26.                       <param-value>gacl</param-value> 
27.                   </init-param> 
28.                   <init-param> 
29.                       <description>配置FilterTest過濾器的初始化引數</description> 
30.                       <param-name>like</param-name> 
31.                       <param-value>java</param-value> 
32.                   </init-param> 
33.             </filter> 
34.              
35.              <filter-mapping> 
36.                   <filter-name>FilterDemo02</filter-name> 
37.                   <!--“/*”表示攔截所有的請求 --> 
38.                   <url-pattern>/*</url-pattern> 
39.              </filter-mapping> 
40.          */  
41.         //得到過濾器的名字  
42.         String filterName = filterConfig.getFilterName();  
43.         //得到在web.xml檔案中配置的初始化引數  
44.         String initParam1 = filterConfig.getInitParameter("name");  
45.         String initParam2 = filterConfig.getInitParameter("like");  
46.         //返回過濾器的所有初始化引數的名字的列舉集合。  
47.         Enumeration<String> initParameterNames = filterConfig.getInitParameterNames();  
48.           
49.         System.out.println(filterName);  
50.         System.out.println(initParam1);  
51.         System.out.println(initParam2);  
52.         while (initParameterNames.hasMoreElements()) {  
53.             String paramName = (String) initParameterNames.nextElement();  
54.             System.out.println(paramName);  
55.         }  
56.     }  
57.   
58.     @Override  
59.     public void doFilter(ServletRequest request, ServletResponse response,  
60.             FilterChain chain) throws IOException, ServletException {  
61.         System.out.println("FilterDemo02執行前！！！");  
62.         chain.doFilter(request, response);  //讓目標資源執行，放行  
63.         System.out.println("FilterDemo02執行後！！！");  
64.     }  
65.   
66.     @Override  
67.     public void destroy() {  
68.         System.out.println("----過濾器銷燬----");  
69.     }  
70. }  

六、Filter的部署時的一些引數的含義
Filter的部署分為兩個步驟：
　　1、註冊Filter
　　2、對映Filter
6.1、註冊Filter
　　開發好Filter之後，需要在web.xml檔案中進行註冊，這樣才能夠被web伺服器呼叫。在web.xml檔案中註冊Filter範例：

[html] view plain copy

1. <filter>  
2.     <description>過濾器名稱</description>  
3.     <filter-name>自定義的名字</filter-name>  
4.     <filter-class>com.yangcq.filter.FilterTest</filter-class>  
5.     <!--配置FilterTest過濾器的初始化引數-->  
6.     <init-param>  
7.         <description>配置過濾器的初始化引數</description>  
8.         <param-name>name</param-name>  
9.         <param-value>gacl</param-value>  
10.     </init-param>  
11.     <init-param>  
12.         <description>配置FilterTest過濾器的初始化引數</description>  
13.         <param-name>like</param-name>  
14.         <param-value>java</param-value>  
15.     </init-param>  
16. </filter>  

    <description>用於新增描述資訊，該元素的內容可為空，<description>可以不配置。
　　<filter-name>用於為過濾器指定一個名字，該元素的內容不能為空。
　　<filter-class>元素用於指定過濾器的完整的限定類名。
　　<init-param>元素用於為過濾器指定初始化引數，它的子元素<param-name>指定引數的名字，<param-value>指定引數的值。在過濾器中，可以使用FilterConfig介面物件來訪問初始化引數。如果過濾器不需要指定初始化引數，那麼<init-param>元素可以不配置。
6.2、對映Filter
　　在web.xml檔案中註冊了Filter之後，還要在web.xml檔案中對映Filter
<!--對映過濾器-->
  <filter-mapping>
      <filter-name>FilterTest</filter-name>
      <!--“/*”表示攔截所有的請求 -->
      <url-pattern>/*</url-pattern>
  </filter-mapping>
<filter-mapping>元素用於設定一個 Filter 所負責攔截的資源。一個Filter攔截的資源可通過兩種方式來指定：Servlet 名稱和資源訪問的請求路徑
　　<filter-name>子元素用於設定filter的註冊名稱。該值必須是在<filter>元素中宣告過的過濾器的名字
　　<url-pattern>設定 filter 所攔截的請求路徑(過濾器關聯的URL樣式)
　　<servlet-name>指定過濾器所攔截的Servlet名稱。
　　<dispatcher>指定過濾器所攔截的資源被 Servlet 容器呼叫的方式，可以是REQUEST,INCLUDE,FORWARD和ERROR之一，預設REQUEST。使用者可以設定多個<dispatcher> 子元素用來指定 Filter 對資源的多種呼叫方式進行攔截。如下：
<filter-mapping>
    <filter-name>testFilter</filter-name>
    <url-pattern>/index.jsp</url-pattern>
    <dispatcher>REQUEST</dispatcher>
    <dispatcher>FORWARD</dispatcher>
</filter-mapping>
　<dispatcher> 子元素可以設定的值及其意義：
    REQUEST：當用戶直接訪問頁面時，Web容器將會呼叫過濾器。如果目標資源是通過RequestDispatcher的include()或forward()方法訪問時，那麼該過濾器就不會被呼叫。
    INCLUDE：如果目標資源是通過RequestDispatcher的include()方法訪問時，那麼該過濾器將被呼叫。除此之外，該過濾器不會被呼叫。
    FORWARD：如果目標資源是通過RequestDispatcher的forward()方法訪問時，那麼該過濾器將被呼叫，除此之外，該過濾器不會被呼叫。
    ERROR：如果目標資源是通過宣告式異常處理機制呼叫時，那麼該過濾器將被呼叫。除此之外，過濾器不會被呼叫。