一、Filter簡介

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

　　

二、Filter是如何實現攔截的？

　　Filter介面中有一個doFilter方法，當我們編寫好Filter，並配置對哪個web資源進行攔截後，WEB伺服器每次在呼叫web資源的service方法之前，都會先呼叫一下filter的doFilter方法，因此，在該方法內編寫程式碼可達到如下目的：

1. 呼叫目標資源之前，讓一段程式碼執行。
2. 是否呼叫目標資源（即是否讓使用者訪問web資源）。
3. 呼叫目標資源之後，讓一段程式碼執行。

　　web伺服器在呼叫doFilter方法時，會傳遞一個filterChain物件進來，filterChain物件是filter介面中最重要的一個對 象，它也提供了一個doFilter方法，開發人員可以根據需求決定是否呼叫此方法，呼叫該方法，則web伺服器就會呼叫web資源的service方 法，即web資源就會被訪問，否則web資源不會被訪問。

三、Filter開發入門

3.1、Filter開發步驟

　　Filter開發分為二個步驟：

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

　　過濾器範例：

 1 package me.gacl.web.filter;
 2 
 3 import java.io.IOException;
 4 
 5 import javax.servlet.Filter;
 6 import javax.servlet.FilterChain;
 7 import javax.servlet.FilterConfig;
 8 import javax.servlet.ServletException;
 9 import javax.servlet.ServletRequest;
10 import javax.servlet.ServletResponse;
11 
12 /**
13 * @ClassName: FilterDemo01
14 * @Description:filter的三種典型應用：
15 *                     1、可以在filter中根據條件決定是否呼叫chain.doFilter(request, response)方法，
16 *                        即是否讓目標資源執行
17 *                     2、在讓目標資源執行之前，可以對request\response作預處理，再讓目標資源執行
18 *                     3、在目標資源執行之後，可以捕獲目標資源的執行結果，從而實現一些特殊的功能
19 * @author: 孤傲蒼狼
20 * @date: 2014-8-31 下午10:09:24
21 */ 
22 public class FilterDemo01 implements Filter {
23 
24     @Override
25     public void init(FilterConfig filterConfig) throws ServletException {
26         System.out.println("----過濾器初始化----");
27     }
28 
29     @Override
30     public void doFilter(ServletRequest request, ServletResponse response,
31             FilterChain chain) throws IOException, ServletException {
32         
33         //對request和response進行一些預處理
34         request.setCharacterEncoding("UTF-8");
35         response.setCharacterEncoding("UTF-8");
36         response.setContentType("text/html;charset=UTF-8");
37         
38         System.out.println("FilterDemo01執行前！！！");
39         chain.doFilter(request, response);  //讓目標資源執行，放行
40         System.out.println("FilterDemo01執行後！！！");
41     }
42 
43     @Override
44     public void destroy() {
45         System.out.println("----過濾器銷燬----");
46     }
47 }

　　在web. xml中配置過濾器：

 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   <!--配置過濾器-->
13   <filter>
14       <filter-name>FilterDemo01</filter-name>
15       <filter-class>me.gacl.web.filter.FilterDemo01</filter-class>
16   </filter>
17   
18   <!--對映過濾器-->
19   <filter-mapping>
20       <filter-name>FilterDemo01</filter-name>
21       <!--“/*”表示攔截所有的請求 -->
22       <url-pattern>/*</url-pattern>
23   </filter-mapping>
24   
25 </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，如果沒有，則呼叫目標資源。

四、Filter的生命週期

4.1、Filter的建立

　　Filter的建立和銷燬由WEB伺服器負責。 web 應用程式啟動時，web 伺服器將建立Filter 的例項物件，並呼叫其init方法，完成物件的初始化功能，從而為後續的使用者請求作好攔截的準備工作，filter物件只會建立一次，init方法也只會執行一次。通過init方法的引數，可獲得代表當前filter配置資訊的FilterConfig物件。

4.2、Filter的銷燬

　　Web容器呼叫destroy方法銷燬Filter。destroy方法在Filter的生命週期中僅執行一次。在destroy方法中，可以釋放過濾器使用的資源。

4.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配置資訊

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

五、Filter的部署

　　Filter的部署分為兩個步驟：

　　1、註冊Filter

　　2、對映Filter

5.1、註冊Filter

　　開發好Filter之後，需要在web.xml檔案中進行註冊，這樣才能夠被web伺服器呼叫

　　在web.xml檔案中註冊Filter範例：

 1 <filter>
 2           <description>FilterDemo02過濾器</description>
 3           <filter-name>FilterDemo02</filter-name>
 4           <filter-class>me.gacl.web.filter.FilterDemo02</filter-class>
 5           <!--配置FilterDemo02過濾器的初始化引數-->
 6           <init-param>
 7               <description>配置FilterDemo02過濾器的初始化引數</description>
 8               <param-name>name</param-name>
 9               <param-value>gacl</param-value>
10           </init-param>
11           <init-param>
12               <description>配置FilterDemo02過濾器的初始化引數</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>元素可以不配置。

5.2、對映Filter

　　在web.xml檔案中註冊了Filter之後，還要在web.xml檔案中對映Filter

1  <!--對映過濾器-->
2   <filter-mapping>
3       <filter-name>FilterDemo02</filter-name>
4       <!--“/*”表示攔截所有的請求 -->
5       <url-pattern>/*</url-pattern>
6   </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 對資源的多種呼叫方式進行攔截。如下：

1 <filter-mapping>
2     <filter-name>testFilter</filter-name>
3    <url-pattern>/index.jsp</url-pattern>
4    <dispatcher>REQUEST</dispatcher>
5    <dispatcher>FORWARD</dispatcher>
6 </filter-mapping>

　　<dispatcher> 子元素可以設定的值及其意義：

1. REQUEST：當用戶直接訪問頁面時，Web容器將會呼叫過濾器。如果目標資源是通過RequestDispatcher的include()或forward()方法訪問時，那麼該過濾器就不會被呼叫。
2. INCLUDE：如果目標資源是通過RequestDispatcher的include()方法訪問時，那麼該過濾器將被呼叫。除此之外，該過濾器不會被呼叫。
3. FORWARD：如果目標資源是通過RequestDispatcher的forward()方法訪問時，那麼該過濾器將被呼叫，除此之外，該過濾器不會被呼叫。
4. ERROR：如果目標資源是通過宣告式異常處理機制呼叫時，那麼該過濾器將被呼叫。除此之外，過濾器不會被呼叫。

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

　　

相關推薦