java高效編程----Filter講解 通俗易懂！

原創 善良的healer 2019-07-31 19:18

一、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. 調用目標資源之後，讓一段代碼執行。

以上三點看起來是不是和spring的AOP（面向切面）相似？哈哈！

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

也就是說filterChain對象的doFilter方法如果被調用，就說明請求可以穿過攔截，實現服務的訪問！

 

 

3.1、Filter開發步驟

　　Filter開發分爲二個步驟：

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

　　過濾器範例：

第一步：編寫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;

public class FilterDemo implements Filter{

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        // TODO Auto-generated method stub
        
    }

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

       //對request和response進行一些預處理
         request.setCharacterEncoding("UTF-8");
         response.setCharacterEncoding("UTF-8");
         response.setContentType("text/html;charset=UTF-8");
       
         System.out.println("FilterDemo01執行前！！！");
         chain.doFilter(request, response);  //讓目標資源執行，放行
         System.out.println("FilterDemo01執行後！！！");
        
    }

    @Override
    public void destroy() {
        // TODO Auto-generated method stub
        
    }

}

 

filter中有三個方法：

1.ini（）  這個方法是filter在初始化的時候調用的方法

2.doFilter（） 這個方法是filter的核心，通過此方法可以對請求或者響應做處理，比如編碼過濾。

3.destroy（） 這個方法是和ini（）相對應的，在過濾器的聲明週期結束時，銷燬一些資源，比如IO流的關閉。

第二步：web.xml中配置攔截器（filter指定過濾器處理類(實現了Filter接口)，filter-mapping指定過濾的規則）

<filter>

<filter-name>FilterDemo </filter-name>

<filter-class>此處寫自定義的攔截器類路徑</filter-class>

</filter>

<filter-mapping>

<filter-name>FilterDemo </filter-name>

<!--表示攔截所有請求-->

<url-pattern>/*</url-pattern>

</filter-mapping>

 

 

這樣配置完，啓動項目後隨便訪問項目資源，在訪問到資源之前就調用到了doFilter方法，我們後續的一系列處理就在這個方法是做文章就可以了！

 

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上下文對象的引用。

如果我把web.xml中的配置稍微改動一下：

  <filter>
        <filter-name>RequestFilter</filter-name>
        <filter-class>com.XXX.XXX.filter.FilterDemo </filter-class>
        <init-param>
        <param-name>此處爲參數的名稱1</param-name>
        <param-value>此處爲參數的值1</param-value>
        </init-param>
        <init-param>
        <param-name>此處爲參數的名稱2</param-name>
        <param-value>此處爲參數的值2</param-value>
        </init-param>
    </filter> 

意思就是當filter被創建的時候，這些參數也會被初始化在其中，然後可以通過FilterConfig對象的方法把這些初始化的參數獲取到來使用。（下面是截取的部分代碼）

 

 

五、Filter的部署

　　Filter的部署分爲兩個步驟：

　　1、註冊Filter

　　2、映射Filter

5.1、註冊Filter

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

　　在web.xml文件中註冊Filter範例：

<filter>
        <filter-name>FilterDemo </filter-name>
        <filter-class>com.xxx.xxx.filter.FilterDemo </filter-class>
        <init-param>
        <param-name>name</param-name>
        <param-value>zhangsan</param-value>
        </init-param>
        

       <init-param>

        <description>用來描述初始化字段的</description>
        <param-name>name2</param-name>
        <param-value>lisi</param-value>
        </init-param>
    </filter> 
    
    <filter-mapping>
       <filter-name>FilterDemo </filter-name>
       <url-pattern>/*</url-pattern>  
    </filter-mapping>

 

       <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>FilterDemo </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>FilterDemo </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的講解就到這裏，小夥伴們可以邊看文章邊動手操作一下，點關注不迷路，跟我一起學技術！

 

發表評論
所有評論
還沒有人評論，想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章