Servlet 過濾器可以動態地攔截請求和響應，以變換或使用包含在請求或響應中的資訊。
可以將一個或多個 Servlet 過濾器附加到一個 Servlet 或一組 Servlet。Servlet 過濾器也可以附加到 JavaServer Pages (JSP) 檔案和 HTML 頁面。調用 Servlet 前調用所有附加的 Servlet 過濾器。
Servlet 過濾器是可用於 Servlet 編程的 Java 類，可以實現以下目的：
（1）在用戶端的請求訪問後端資源之前，攔截這些請求。
（2）在伺服器的響應發送回用戶端之前，處理這些響應。
根據規範建議的各種類型的過濾器：
（1）身分識別驗證過濾器（Authentication Filters）。
（2）資料壓縮過濾器（Data compression Filters）。
（3）加密過濾器（Encryption Filters）。
（4）觸發資源訪問事件過濾器。
（5）映像轉換過濾器（Image Conversion Filters）。
（6）日誌記錄和審核過濾器（Logging and Auditing Filters）。
（7）MIME-TYPE 鏈過濾器（MIME-TYPE Chain Filters）。
（8）標記化過濾器（Tokenizing Filters）。
（9）XSL/T 過濾器（XSL/T Filters），轉換 XML 內容
過濾器通過 Web 部署描述符（web.xml）中的 XML 標籤來聲明，然後映射到您的應用程式的部署描述符中的 Servlet 名稱或 URL 模式。
當 Web 容器啟動 Web 應用程式時，它會為您在部署描述符中聲明的每一個過濾器建立一個執行個體。
Filter的執行順序與在web.xml設定檔中的配置順序一致，一般把Filter配置在所有的Servlet之前。 二、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 應用程式啟動時，網頁伺服器將建立Filter 的執行個體對象，並調用其init方法，讀取web.xml配置，完成對象的初始化功能，從而為後續的使用者請求作好攔截的準備工作（filter對象只會建立一次，init方法也只會執行一次）。開發人員通過init方法的參數，可獲得代表當前filter配置資訊的FilterConfig對象。 |
| 3 | public void destroy() Servlet容器在銷毀過濾器執行個體前調用該方法，在該方法中釋放Servlet過濾器佔用的資源。 |
Filter 的 init 方法中提供了一個 FilterConfig 對象。
如 web.xml 檔案配置如下：
<filter> <filter-name>LoginFilter</filter-name> <filter-class>com.test.servlet.LogFilter</filter-class> <init-param> <param-name>Site</param-name> <param-value>Servlet過濾器測試</param-value> </init-param></filter>
在 init 方法使用 FilterConfig 對象擷取參數：
public void init(FilterConfig config) throws ServletException { // 擷取初始化參數 String site = config.getInitParameter("Site"); // 輸出初始化參數 System.out.println("網站名稱: " + site); }
三、Servlet 過濾器執行個體
package com.test.servlet;//匯入必需的 java 庫import javax.servlet.Filter;import javax.servlet.FilterChain;import javax.servlet.FilterConfig;import javax.servlet.ServletException;import javax.servlet.ServletRequest;import javax.servlet.ServletResponse;//實現 Filter 類public class LogFilter implements Filter { public void init(FilterConfig config) throws ServletException { // 擷取初始化參數 String site = config.getInitParameter("Site"); // 輸出初始化參數 System.out.println("網站名稱: " + site); } public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws java.io.IOException, ServletException { System.out.println("測試攔截器輸出"); // 把請求傳回過濾鏈 chain.doFilter(request,response); } public void destroy( ){ /* 在 Filter 執行個體被 Web 容器從服務移除之前調用 */ }}
package com.test.servlet;//匯入必需的 java 庫import java.io.IOException;import java.io.PrintWriter;import java.util.Enumeration;import javax.servlet.ServletException;import javax.servlet.annotation.WebServlet;import javax.servlet.http.HttpServlet;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;//擴充 HttpServlet 類@WebServlet("/DisplayHeader")public class DisplayHeader extends HttpServlet { // 處理 GET 方法請求的方法 public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { // 設定響應內容類型 response.setContentType("text/html;charset=UTF-8"); PrintWriter out = response.getWriter(); String title = "HTTP Header 請求執行個體"; String docType = "<!DOCTYPE html> \n"; out.println(docType + "<html>\n" + "<head><meta charset=\"utf-8\"><title>" + title + "</title></head>\n"+ "<body bgcolor=\"#f0f0f0\">\n" + "<h1 align=\"center\">" + title + "</h1>\n" + "<table width=\"100%\" border=\"1\" align=\"center\">\n" + "<tr bgcolor=\"#949494\">\n" + "<th>Header 名稱</th><th>Header 值</th>\n"+ "</tr>\n"); Enumeration headerNames = request.getHeaderNames(); while(headerNames.hasMoreElements()) { String paramName = (String)headerNames.nextElement(); out.print("<tr><td>" + paramName + "</td>\n"); String paramValue = request.getHeader(paramName); out.println("<td> " + paramValue + "</td></tr>\n"); } out.println("</table>\n</body></html>"); } // 處理 POST 方法請求的方法 public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { doGet(request, response); }}
Web.xml 中的 Servlet 過濾器映射（Servlet Filter Mapping）
定義過濾器，然後映射到一個 URL 或 Servlet，這與定義 Servlet，然後映射到一個 URL 模式方式大致相同。在部署描述符檔案 web.xml 中為 filter 標籤建立下面的條目：
<?xml version="1.0" encoding="UTF-8"?><web-app version="3.0" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"> <display-name></display-name> <welcome-file-list> <welcome-file>index.jsp</welcome-file> </welcome-file-list><filter> <filter-name>LogFilter</filter-name> <filter-class>com.test.servlet.LogFilter</filter-class> <init-param> <param-name>Site</param-name> <param-value>Servlet過濾器測試</param-value> </init-param></filter><filter-mapping> <filter-name>LogFilter</filter-name> <url-pattern>/*</url-pattern></filter-mapping><servlet> <!-- 類名 --> <servlet-name>DisplayHeader</servlet-name> <!-- 所在的包 --> <servlet-class>com.test.servlet.DisplayHeader</servlet-class> </servlet> <servlet-mapping> <servlet-name>DisplayHeader</servlet-name> <!-- 訪問的網址 --> <url-pattern>/WebProject/DisplayHeader</url-pattern> </servlet-mapping> </web-app>
上述過濾器適用於所有的 Servlet，因為我們在配置中指定 /* 。如果您只想在少數的 Servlet 上應用過濾器，您可以指定一個特定的 Servlet 路徑。
現在試著以常用的方式調用任何 Servlet，您將會看到在 Web 服務器中產生的日誌。您也可以使用 Log4J 記錄器來把上面的日誌記錄到一個單獨的檔案中。
接下來我們訪問這個執行個體地址 http://localhost:8080/WebProject/DisplayHeader, 然後在控制台看下輸出內容，如下所示：
四、使用多個過濾器
Web 應用程式可以根據特定的目的定義若干個不同的過濾器。假設您定義了兩個過濾器 AuthenFilter 和 LogFilter。您需要建立一個如下所述的不同的映射，其餘的處理與上述所講解的大致相同：
<filter> <filter-name>LogFilter</filter-name> <filter-class>com.test.servlet.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.test.servlet.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 元素即可。
例如，上面的執行個體將先應用 LogFilter，然後再應用 AuthenFilter，但是下面的執行個體將顛倒這個順序：
<filter-mapping> <filter-name>AuthenFilter</filter-name> <url-pattern>/*</url-pattern></filter-mapping><filter-mapping> <filter-name>LogFilter</filter-name> <url-pattern>/*</url-pattern></filter-mapping>六、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：如果目標資源是通過聲明式異常處理機制調用時，那麼該過濾器將被調用。除此之外，過濾器不會被調用
文章來源於菜鳥教程：Servlet 編寫過濾器|菜鳥教程
Start building with 50+ products and up to 12 months usage for Elastic Compute Service
1 on 1 presale consultation
24/7 Technical Support 6 Free Tickets per Quarter Faster Response
Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.
A comprehensive suite of global cloud computing services to power your business
Payment Methods We Support
