Filter(一)

原創

2020-02-22 16:39

1. Filter

1). Filter 是什麼 ?

①. JavaWEB 的一個重要組件, 可以對發送到 Servlet 的請求進行攔截, 並對響應也進行攔截.
②. Filter 是實現了 Filter 接口的 Java 類.
③. Filter 需要在 web.xml 文件中進行配置和映射.

2). 如何創建一個 Filter, 並把他跑起來

①. 創建一個 Filter 類: 實現 Filter 接口: public class HelloFilter implements Filter
②. 在 web.xml 文件中配置並映射該 Filter. 其中 url-pattern 指定該 Filter 可以攔截哪些資源, 即可以通過哪些 url 訪問到該 Filter


<filter>
   <filter-name>helloFilter</filter-name>
   <filter-class>com.atguigu.javaweb.HelloFilter</filter-class>
</filter>


<filter-mapping>
   <filter-name>helloFilter</filter-name>
   <url-pattern>/test.jsp</url-pattern>
</filter-mapping>

> public void init(FilterConfig filterConfig):類似於 Servlet 的 init 方法. 在創建 Filter 對象(Filter 對象在 Servlet 容器加載當前 WEB 應用時即被創建)後
   立即被調用, 且只被調用一次. 該方法用於對當前的 Filter 進行初始化操作. Filter 實例是單例的.

       * FilterConfig 類似於 ServletConfig

       * 可以在 web.xml 文件中配置當前 Filter 的初始化參數. 配置方式也和 Servlet 類似。
       <filter>
           <filter-name>helloFilter</filter-name>
           <filter-class>com.xiaoxiao.javaweb.HelloFilter</filter-class>
           <init-param>
               <param-name>name</param-name>
               <param-value>root</param-value>
           </init-param>
       </filter>
> public void doFilter(ServletRequest request, ServletResponse response,
           FilterChain chain):真正 Filter 的邏輯代碼需要編寫在該方法中. 每次攔截都會調用該方法.

           * FilterChain: Filter 鏈. 多個 Filter 可以構成一個 Filter 鏈.

           - doFilter(ServletRequest request, ServletResponse response): 把請求傳給 Filter 鏈的下一個 Filter,
           若當前 Filter 是 Filter 鏈的最後一個 Filter, 將把請求給到目標 Serlvet(或 JSP)

           - 多個 Filter 攔截的順序和 <filter-mapping> 配置的順序有關, 靠前的先被調用.


> public void destroy():

4). <dispatcher> 元素: 指定過濾器所攔截的資源被 Servlet 容器調用的方式，
可以是REQUEST,INCLUDE,FORWARD和ERROR之一，默認REQUEST.
可以設置多個<dispatcher> 子元素用來指定 Filter 對資源的多種調用方式進行攔截

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

通過 GET 或 POST 請求直接訪問。

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

或 <jsp:forward page="/..." /> 或通過 page 指令的 errorPage 轉發頁面. <%@ page errorPage="test.jsp" %>

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

或 <jsp:include file="/..." />

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

在 web.xml 文件中通過 error-page 節點進行聲明:

<error-page>
   <exception-type>java.lang.ArithmeticException</exception-type>
   <location>/test.jsp</location>
</error-page>

<filter-mapping>
   <filter-name>secondFilter</filter-name>
   <url-pattern>/test.jsp</url-pattern>
   <dispatcher>REQUEST</dispatcher>
   <dispatcher>FORWARD</dispatcher>
   <dispatcher>INCLUDE</dispatcher>
   <dispatcher>ERROR</dispatcher>
</filter-mapping>