Servlet之Filter過濾器

Servlet之Filter過濾器

簡介：過濾器是在Servlet規範2.3中定義的，它可以動態的攔截請求和響應但過濾器本身不生成請求和響應，也就是說只是可以對請求和響應的對象進行檢查和修改。

 

一、過濾器的概念

過濾器是一個程序，它先於與之相關的servlet或JSP頁面運行在服務器上。過濾器可附加到一個或多個servlet或JSP頁面上，並且可以檢查進入這些資源的請求信息。在這之後，過濾器可以作如下的選擇：

①以常規的方式調用資源（即，調用servlet或JSP頁面）。

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

③調用資源，但在發送響應到客戶機前對其進行修改。

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

 

二、過濾器的使用

在客戶端的請求訪問後端資源之前，攔截這些請求。

在服務器的響應發送回客戶端之前處理這些響應。

常用的方式：

1.攔截資源（一些不合理的訪問）

2.設置字符集（設置請求和響應的字符集）

3.權限控制（常用）

根據規範建議的各種類型的過濾器：

· 身份驗證過濾器（Authentication Filters）。

· 數據壓縮過濾器（Data compression Filters）。

· 加密過濾器（Encryption Filters）。

· 觸發資源訪問事件過濾器。

· 圖像轉換過濾器（Image Conversion Filters）。

· 日誌記錄和審覈過濾器（Logging and Auditing Filters）。

· MIME-TYPE 鏈過濾器（MIME-TYPE Chain Filters）。

· 標記化過濾器（Tokenizing Filters）。

· XSL/T 過濾器（XSL/T Filters），轉換 XML 內容。

過濾器通過 Web 部署描述符（web.xml）中的 XML 標籤來聲明，然後映射到您的應用程序的部署描述符中的 Servlet 名稱或 URL 模式。

當 Web 容器啓動 Web 應用程序時，它會爲您在部署描述符中聲明的每一個過濾器創建一個實例。

Filter的執行順序與在web.xml配置文件中的配置順序一致，一般把Filter配置在所有的Servlet之前。

 

1.過濾器的實現

Servlet API中提供了一個Filter接口，開發web應用時，如果編寫的Java類實現了這個接口，則把這個java類稱之爲過濾器Filter。通過Filter技術，開發人員可以實現用戶在訪問某個目標資源之前，對訪問的請求和響應進行攔截。簡單說，就是可以實現web容器對某資源的訪問前截獲進行相關的處理，還可以在某資源向web容器返回響應前進行截獲進行處理。

Filter接口：javax.Servlet.Filtervax.servlet.Filter接口定義了三個方法：

2.Servlet 過濾器方法

Initf方法（初始化方法）

web 應用程序啓動時，web 服務器將創建Filter 的實例對象，並調用其init方法，讀取web.xml配置，完成對象的初始化功能，從而爲後續的用戶請求作好攔截的準備工作（filter對象只會創建一次，init方法也只會執行一次）。開發人員通過init方法的參數，可獲得代表當前filter配置信息的FilterConfig對象。

public void init(FilterConfig filterConfig){}

doFilter方法（過濾的關鍵）

該方法完成實際的過濾操作，當客戶端請求方法與過濾器設置匹配的URL時，Servlet容器將先調用過濾器的doFilter方法。FilterChain用

public void doFilter (ServletRequest, ServletResponse, FilterChain){}

destroy方法垃圾回收

Servlet容器在銷燬過濾器實例前調用該方法，在該方法中釋放Servlet過濾器佔用的資源。

public void destroy(){}

3.設置配置文件web.xml

 

· <filter>指定一個過濾器。

· <filter-name>用於爲過濾器指定一個名字，該元素的內容不能爲空。

· <filter-class>元素用於指定過濾器的完整的限定類名。

· <init-param>元素用於爲過濾器指定初始化參數，它的子元素<param-name>指定參數的名字，<param-value>指定參數的值。

· 在過濾器中，可以使用FilterConfig接口對象來訪問初始化參數。

· <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 對資源的多種調用方式進行攔截。

· <dispatcher>子元素可以設置的值及其意義

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

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

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

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

 

  示例：

  <!-- 設置過濾器 -->

  <filter>

<!-- 設置過濾器名稱-->

   <filter-name>MyFirstFilter</filter-name>

<!-- 設置過濾器全類名-->

   <filter-class>filter.MyFirstFilter</filter-class>

  </filter>

  

  <!-- 添加過濾的位置 -->

  <filter-mapping>

<!-- 該路徑對應的過濾器名-->

   <filter-name>MyFirstFilter</filter-name>

<!-- 需要過濾的路徑  *帶表該路徑下所有 -->

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

 </filter-mapping>

上述過濾器適用於所有的 Servlet，因爲我們在配置中指定 /* 。如果您只想在少數的 Servlet 上應用過濾器，您可以指定一個特定的 Servlet 路徑。

4.過濾器鏈

我們可以根據不同的需求定義多個過濾器，也叫做過濾器鏈

過濾器鏈的順序：web.xml 中的 filter-mapping 元素的順序決定了 Web 容器應用過濾器到 Servlet 的順序。若要反轉過濾器的順序，您只需要在 web.xml 文件中反轉 filter-mapping 元素即可。

注意：只要有一層過濾器不通過，就會被直接攔截

 

<filter>

   <filter-name>LogFilter</filter-name>

   <filter-class>com.runoob.test.LogFilter</filter-class>

   <init-param>

      <param-name>test-param</param-name>

      <param-value>Initialization Paramter</param-value>

   </init-param></filter>

<filter>

   <filter-name>AuthenFilter</filter-name>

   <filter-class>com.runoob.test.AuthenFilter</filter-class>

   <init-param>

      <param-name>test-param</param-name>

      <param-value>Initialization Paramter</param-value>

   </init-param></filter>

<filter-mapping>

   <filter-name>LogFilter</filter-name>

   <url-pattern>/*</url-pattern></filter-mapping>

<filter-mapping>

   <filter-name>AuthenFilter</filter-name>

   <url-pattern>/*</url-pattern></filter-mapping>

 

5.FilterConfig 使用

Filter 的 init 方法中提供了一個 FilterConfig 對象。

如 web.xml 文件配置如下：

<filter>

    <filter-name>LoginFilter</filter-name>

    <filter-class>com.runoob.test.LogFilter</filter-class>

    <init-param>

        <param-name>test/param-name>

        <param-value>測試</param-value>

    </init-param>

    </filter>

在 init 方法使用 FilterConfig 對象獲取參數：

public void  init(FilterConfig config) throws ServletException {

    // 獲取初始化參數

    String site= config.getInitParameter("test"); 

    // 輸出初始化參數

    System.out.println("test: " + test); }