過濾器作用
- 在客戶端的請求訪問後端資源之前,攔截這些請求。
- 在服務器的響應發送回客戶端之前,處理這些響應。
過濾器類型
- 身份驗證過濾器(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 內容。
過濾器的執行過程
Servlet 過濾器方法
過濾器是一個實現了 javax.servlet.Filter 接口的 Java 類。javax.servlet.Filter 接口定義了三個方法:
序號 | 方法 & 描述 |
---|---|
1 | public void doFilter (ServletRequest, ServletResponse, FilterChain) 該方法完成實際的過濾操作,當客戶端請求方法與過濾器設置匹配的URL時,Servlet 容器將先調用過濾器的 doFilter 方法。FilterChain 用於訪問後續過濾器。 |
2 | public void init(FilterConfig filterConfig) web 應用程序啓動時,web 服務器將創建Filter 的實例對象,並調用其init方法,讀取web.xml配置,完成對象的初始化功能,從而爲後續的用戶請求作好攔截的準備工作(filter對象只會創建一次,init方法也只會執行一次)。開發人員通過init方法的參數,可獲得代表當前filter配置信息的FilterConfig對象。 |
3 | public void destroy() Servlet容器在銷燬過濾器實例前調用該方法,在該方法中釋放Servlet過濾器佔用的資源。 |
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;
@WebFilter(filterName = "Filter")
public class Filter implements javax.servlet.Filter {
public void destroy() {
}
public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
chain.doFilter(req, resp);
}
public void init(FilterConfig config) throws ServletException {
}
}
FilterConfig
Filter 的 init 方法中提供了一個 FilterConfig 對象:FilterConfig config
範例:利用FilterConfig 對象獲取web.xml配置文件中的值
web.xml
<filter>
<filter-name>LogFilter</filter-name>
<filter-class>com.test.LogFilter</filter-class>
<init-param>
<param-name>Site</param-name>
<param-value>教程</param-value>
</init-param>
</filter>
init方法
public void init(FilterConfig config) throws ServletException {
// 獲取初始化參數
String site = config.getInitParameter("Site");
// 輸出初始化參數
System.out.println("網站名稱: " + site);
}
兩種配置過濾器映射的方法:(1)web.xml、(2)註解
web.xml配置各節點說明
節點 | 子節點1 | 子節點2 | 作用 |
---|---|---|---|
|
指定一個過濾器 | ||
|
爲過濾器指定一個名字,該元素的內容不能爲空 | ||
|
指定過濾器的完整的限定類名 | ||
|
|
爲過濾器指定初始化參數,它的子元素 在過濾器中,可以使用 |
|
|
|||
<filter-mapping></filter-mapping> |
設置一個 Filter 所負責攔截的資源。一個Filter攔截的資源可通過兩種方式來指定:Servlet 名稱和資源訪問的請求路徑 | ||
|
設置filter的註冊名稱。該值必須是在<filter> 元素中聲明過的過濾器的名字 |
||
|
設置 filter 所攔截的請求路徑(過濾器關聯的URL樣式) | ||
|
指定過濾器所攔截的Servlet名稱 | ||
|
指定過濾器所攔截的資源被 Servlet 容器調用的方式,可以是REQUEST ,INCLUDE ,FORWARD 和ERROR 之一,默認REQUEST 。用戶可以設置多個<dispatcher> 子元素用來指定 Filter 對資源的多種調用方式進行攔截。 |
||
REQUEST |
當用戶直接訪問頁面時,Web容器將會調用過濾器。如果目標資源是通過RequestDispatcher的include()或forward()方法訪問時,那麼該過濾器就不會被調用。 | ||
INCLUDE |
如果目標資源是通過RequestDispatcher的include()方法訪問時,那麼該過濾器將被調用。除此之外,該過濾器不會被調用。 | ||
FORWARD |
如果目標資源是通過RequestDispatcher的forward()方法訪問時,那麼該過濾器將被調用,除此之外,該過濾器不會被調用。 | ||
ERROR |
如果目標資源是通過聲明式異常處理機制調用時,那麼該過濾器將被調用。除此之外,過濾器不會被調用。 |
(1)Web.xml 中的 配置單個Servlet 過濾器映射
定義過濾器,然後映射到一個 URL 或 Servlet,這與定義 Servlet,然後映射到一個 URL 模式方式大致相同,此種
<filter>
<!--過濾器的類名-->
<filter-name>LogFilter</filter-name>
<!--過濾器的包路徑-->
<filter-class>com.test.LogFilter</filter-class>
<!--過濾器的配置參數-->
<init-param>
<!--參數鍵-->
<param-name>Site</param-name>
<!--參數值-->
<param-value>www.baidu.com</param-value>
</init-param>
</filter>
<filter-mapping>
<!--過濾器的映射名稱-->
<filter-name>LogFilter</filter-name>
<!--過濾器要過濾的Servlet,/*表示過濾所有的Servlet-->
<url-pattern>/*</url-pattern>
</filter-mapping>
<!--Servlet的配置-->
<servlet>
<!-- 類名 -->
<servlet-name>DisplayHeader</servlet-name>
<!-- 所在的包 -->
<servlet-class>com.test.DisplayHeader</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>DisplayHeader</servlet-name>
<!-- 訪問的網址 -->
<url-pattern>DisplayHeader</url-pattern>
</servlet-mapping>
(2)Web.xml 中的 配置多個Servlet 過濾器映射
<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>
web.xml 中的 filter-mapping 元素的順序決定了 Web 容器應用過濾器到 Servlet 的順序。若要反轉過濾器的順序,只需要在 web.xml 文件中反轉 filter-mapping 元素即可。
(3)註解映射過濾器
Servlet 3.0之後可以使用註解方式使用過濾器。
@WebFilter(filterName,urlPatterns);
filterName:過濾器的名稱
urlPatterns:要攔截的資源
package cn.ccut.filter;
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;
@WebFilter(filterName = "CharacterFilter",urlPatterns = "/*")
public class CharacterFilter extends Filter {
public void destroy() {
}
public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
}
public void init(FilterConfig config) throws ServletException {
}
}