Java Web Filter 過濾器學習教程(推薦)_java

一、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類進行註冊，並設定它所能攔截的資源。

　　過濾器範例：

package me.gacl.web.filter;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;/*** @ClassName: FilterDemo* @Description:filter的三種典型應用：* 、可以在filter中根據條件決定是否調用chain.doFilter(request, response)方法，* 即是否讓目標資源執行* 、在讓目標資源執行之前，可以對request\response作預先處理，再讓目標資源執行* 、在目標資源執行之後，可以捕獲目標資源的執行結果，從而實現一些特殊的功能* @author: 孤傲蒼狼* @date: -- 下午::*/ public class FilterDemo implements Filter {@Overridepublic void init(FilterConfig filterConfig) throws ServletException {System.out.println("----過濾器初始化----");}@Overridepublic void doFilter(ServletRequest request, ServletResponse response,FilterChain chain) throws IOException, ServletException {//對request和response進行一些預先處理request.setCharacterEncoding("UTF-");response.setCharacterEncoding("UTF-");response.setContentType("text/html;charset=UTF-");System.out.println("FilterDemo執行前！！！");chain.doFilter(request, response); //讓目標資源執行，允許存取System.out.println("FilterDemo執行後！！！");}@Overridepublic void destroy() {System.out.println("----過濾器銷毀----");}} 

　　在web. xml中配置過濾器：

<?xml version="." encoding="UTF-"?><web-app version="." xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w.org//XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app__.xsd"><display-name></display-name> <welcome-file-list><welcome-file>index.jsp</welcome-file></welcome-file-list><!--配置過濾器--><filter><filter-name>FilterDemo</filter-name><filter-class>me.gacl.web.filter.FilterDemo</filter-class></filter><!--映射過濾器--><filter-mapping><filter-name>FilterDemo</filter-name><!--“/*”表示攔截所有的請求 --><url-pattern>/*</url-pattern></filter-mapping></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 應用程式啟動時，網頁伺服器將建立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配置資訊

package me.gacl.web.filter;import java.io.IOException;import java.util.Enumeration;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 FilterDemo implements Filter {/* 過濾器初始化* @see javax.servlet.Filter#init(javax.servlet.FilterConfig)*/@Overridepublic void init(FilterConfig filterConfig) throws ServletException {System.out.println("----過濾器初始化----");/*** <filter><filter-name>FilterDemo</filter-name><filter-class>me.gacl.web.filter.FilterDemo</filter-class><!--配置FilterDemo過濾器的初始化參數--><init-param><description>配置FilterDemo過濾器的初始化參數</description><param-name>name</param-name><param-value>gacl</param-value></init-param><init-param><description>配置FilterDemo過濾器的初始化參數</description><param-name>like</param-name><param-value>java</param-value></init-param></filter><filter-mapping><filter-name>FilterDemo</filter-name><!--“/*”表示攔截所有的請求 --><url-pattern>/*</url-pattern></filter-mapping>*///得到過濾器的名字String filterName = filterConfig.getFilterName();//得到在web.xml檔案中配置的初始化參數String initParam = filterConfig.getInitParameter("name");String initParam = filterConfig.getInitParameter("like");//返回過濾器的所有初始化參數的名字的枚舉集合。Enumeration<String> initParameterNames = filterConfig.getInitParameterNames();System.out.println(filterName);System.out.println(initParam);System.out.println(initParam);while (initParameterNames.hasMoreElements()) {String paramName = (String) initParameterNames.nextElement();System.out.println(paramName);}}@Overridepublic void doFilter(ServletRequest request, ServletResponse response,FilterChain chain) throws IOException, ServletException {System.out.println("FilterDemo執行前！！！");chain.doFilter(request, response); //讓目標資源執行，允許存取System.out.println("FilterDemo執行後！！！");}@Overridepublic void destroy() {System.out.println("----過濾器銷毀----");}}

五、Filter的部署

　　Filter的部署分為兩個步驟：

　　1、註冊Filter

　　2、映射Filter

5.1、註冊Filter

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

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

<filter><description>FilterDemo過濾器</description><filter-name>FilterDemo</filter-name><filter-class>me.gacl.web.filter.FilterDemo</filter-class><!--配置FilterDemo過濾器的初始化參數--><init-param><description>配置FilterDemo過濾器的初始化參數</description><param-name>name</param-name><param-value>gacl</param-value></init-param><init-param><description>配置FilterDemo過濾器的初始化參數</description><param-name>like</param-name><param-value>java</param-value></init-param></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

<!--映射過濾器--><filter-mapping><filter-name>FilterDemo</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> 子項目可以設定的值及其意義：

1.REQUEST：當使用者直接存取頁面時，Web容器將會調用過濾器。如果目標資源是通過RequestDispatcher的include()或forward()方法訪問時，那麼該過濾器就不會被調用。

2.INCLUDE：如果目標資源是通過RequestDispatcher的include()方法訪問時，那麼該過濾器將被調用。除此之外，該過濾器不會被調用。

3.FORWARD：如果目標資源是通過RequestDispatcher的forward()方法訪問時，那麼該過濾器將被調用，除此之外，該過濾器不會被調用。

4.ERROR：如果目標資源是通過聲明式異常處理機制調用時，那麼該過濾器將被調用。除此之外，過濾器不會被調用。