閱讀(48.7k) 書(shū)簽贊(18) 我要糾錯(cuò)

Servlet 編寫(xiě)過(guò)濾器

2022-07-23 14:32 更新

Servlet 編寫(xiě)過(guò)濾器

Servlet 過(guò)濾器是可用于 Servlet 編程的 Java 類(lèi)，有以下目的：

在客戶(hù)端的請(qǐng)求訪(fǎng)問(wèn)后端資源之前，攔截這些請(qǐng)求。
在服務(wù)器的響應(yīng)發(fā)送回客戶(hù)端之前，處理這些響應(yīng)。

根據(jù)規(guī)范建議的各種類(lèi)型的過(guò)濾器：

身份驗(yàn)證過(guò)濾器（Authentication Filters）。
數(shù)據(jù)壓縮過(guò)濾器（Data compression Filters）。
加密過(guò)濾器（Encryption Filters）。
觸發(fā)資源訪(fǎng)問(wèn)事件過(guò)濾器。
圖像轉(zhuǎn)換過(guò)濾器（Image Conversion Filters）。
日志記錄和審核過(guò)濾器（Logging and Auditing Filters）。
MIME-TYPE 鏈過(guò)濾器（MIME-TYPE Chain Filters）。
標(biāo)記化過(guò)濾器（Tokenizing Filters）。
XSL/T 過(guò)濾器（XSL/T Filters），轉(zhuǎn)換 XML 內(nèi)容。

過(guò)濾器被部署在部署描述符文件 web.xml 中，然后映射到您的應(yīng)用程序的部署描述符中的 Servlet 名稱(chēng)或 URL 模式。

當(dāng) Web 容器啟動(dòng) Web 應(yīng)用程序時(shí)，它會(huì)為您在部署描述符中聲明的每一個(gè)過(guò)濾器創(chuàng)建一個(gè)實(shí)例。該過(guò)濾器執(zhí)行的順序是按它們?cè)诓渴鹈枋龇新暶鞯捻樞颉?/p>

Servlet 過(guò)濾器方法

過(guò)濾器是一個(gè)實(shí)現(xiàn)了 javax.servlet.Filter 接口的 Java 類(lèi)。javax.servlet.Filter 接口定義了三個(gè)方法：

序號(hào)	方法 & 描述
1	public void doFilter (ServletRequest, ServletResponse, FilterChain) 該方法在每次一個(gè)請(qǐng)求/響應(yīng)對(duì)因客戶(hù)端在鏈的末端請(qǐng)求資源而通過(guò)鏈傳遞時(shí)由容器調(diào)用。
2	public void init(FilterConfig filterConfig) 該方法由 Web 容器調(diào)用，指示一個(gè)過(guò)濾器被放入服務(wù)。
3	public void destroy() 該方法由 Web 容器調(diào)用，指示一個(gè)過(guò)濾器被取出服務(wù)。

FilterConfig 使用

Filter 的 init 方法中提供了一個(gè) FilterConfig 對(duì)象。

如 web.xml 文件配置如下：

<filter>
	<filter-name>LoginFilter</filter-name>
	<filter-class>com.w3cschool.test.LogFilter</filter-class>
	<init-param>
		<param-name>Site</param-name>
		<param-value>w3cschool在線(xiàn)教程</param-value>
	</init-param>
	</filter>

在 init 方法使用 FilterConfig 對(duì)象獲取參數(shù)：

public void  init(FilterConfig config) throws ServletException {
	// 獲取初始化參數(shù)
	String site = config.getInitParameter("Site"); 
	// 輸出初始化參數(shù)
	System.out.println("網(wǎng)站名稱(chēng): " + site); 
}

Servlet 過(guò)濾器實(shí)例

以下是 Servlet 過(guò)濾器的實(shí)例，將輸出客戶(hù)端的 IP 地址和當(dāng)前的日期時(shí)間。本實(shí)例讓您對(duì) Servlet 過(guò)濾器有基本的了解，您可以使用相同的概念編寫(xiě)更復(fù)雜的過(guò)濾器應(yīng)用程序：

// 導(dǎo)入必需的 java 庫(kù)
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
import java.util.*;

// 實(shí)現(xiàn) Filter 類(lèi)
public class LogFilter implements Filter  {
   public void  init(FilterConfig config) 
                         throws ServletException{
      // 獲取初始化參數(shù)
      String testParam = config.getInitParameter("test-param"); 

      // 輸出初始化參數(shù)
      System.out.println("Test Param: " + testParam); 
   }
   public void  doFilter(ServletRequest request, 
                 ServletResponse response,
                 FilterChain chain) 
                 throws java.io.IOException, ServletException {

      // 獲取客戶(hù)機(jī)的 IP 地址   
      String ipAddress = request.getRemoteAddr();

      // 記錄 IP 地址和當(dāng)前時(shí)間戳
      System.out.println("IP "+ ipAddress + ", Time "
                                       + new Date().toString());

      // 把請(qǐng)求傳回過(guò)濾鏈
      chain.doFilter(request,response);
   }
   public void destroy( ){
      /* 在 Filter 實(shí)例被 Web 容器從服務(wù)移除之前調(diào)用 */
   }
}

這邊使用前文提到的 DisplayHeader.java 為例子：

//導(dǎo)入必需的 java 庫(kù)
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;

@WebServlet("/DisplayHeader")

//擴(kuò)展 HttpServlet 類(lèi)
public class DisplayHeader extends HttpServlet {

	// 處理 GET 方法請(qǐng)求的方法
	public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
	{
		// 設(shè)置響應(yīng)內(nèi)容類(lèi)型
		response.setContentType("text/html;charset=UTF-8");

		PrintWriter out = response.getWriter();
		String title = "HTTP Header 請(qǐng)求實(shí)例 - w3cschool教程實(shí)例";
		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 名稱(chēng)</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 方法請(qǐng)求的方法
	public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
		doGet(request, response);
	}
}

Web.xml 中的 Servlet 過(guò)濾器映射（Servlet Filter Mapping）

定義過(guò)濾器，然后映射到一個(gè) URL 或 Servlet，這與定義 Servlet，然后映射到一個(gè) URL 模式方式大致相同。在部署描述符文件 web.xml 中為 filter 標(biāo)簽創(chuàng)建下面的條目：

<?xml version="1.0" encoding="UTF-8"?>  
<web-app>  
<filter>
  <filter-name>LogFilter</filter-name>
  <filter-class>com.w3cschool.test.LogFilter</filter-class>
  <init-param>
    <param-name>Site</param-name>
    <param-value>w3cschool在線(xiàn)教程</param-value>
  </init-param>
</filter>
<filter-mapping>
  <filter-name>LogFilter</filter-name>
  <url-pattern>/*</url-pattern>
</filter-mapping>
<servlet>  
  <!-- 類(lèi)名 -->  
  <servlet-name>DisplayHeader</servlet-name>  
  <!-- 所在的包 -->  
  <servlet-class>com.w3cschool.test.DisplayHeader</servlet-class>  
</servlet>  
<servlet-mapping>  
  <servlet-name>DisplayHeader</servlet-name>  
  <!-- 訪(fǎng)問(wèn)的網(wǎng)址 -->  
  <url-pattern>/TomcatTest/DisplayHeader</url-pattern>  
</servlet-mapping>  
</web-app>

上述過(guò)濾器適用于所有的 Servlet，因?yàn)槲覀冊(cè)谂渲弥兄付?/* 。如果您只想在少數(shù)的 Servlet 上應(yīng)用過(guò)濾器，您可以指定一個(gè)特定的 Servlet 路徑。

現(xiàn)在試著以常用的方式調(diào)用任何 Servlet，您將會(huì)看到在 Web 服務(wù)器中生成的日志。您也可以使用 Log4J 記錄器來(lái)把上面的日志記錄到一個(gè)單獨(dú)的文件中。

使用多個(gè)過(guò)濾器

Web 應(yīng)用程序可以根據(jù)特定的目的定義若干個(gè)不同的過(guò)濾器。假設(shè)您定義了兩個(gè)過(guò)濾器 AuthenFilter 和 LogFilter。您需要?jiǎng)?chuàng)建一個(gè)如下所述的不同的映射，其余的處理與上述所講解的大致相同：

<filter>
   <filter-name>LogFilter</filter-name>
   <filter-class>com.w3cschool.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.w3cschool.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>

過(guò)濾器的應(yīng)用順序

web.xml 中的 filter-mapping 元素的順序決定了 Web 容器應(yīng)用過(guò)濾器到 Servlet 的順序。若要反轉(zhuǎn)過(guò)濾器的順序，您只需要在 web.xml 文件中反轉(zhuǎn) filter-mapping 元素即可。

例如，上面的實(shí)例將先應(yīng)用 LogFilter，然后再應(yīng)用 AuthenFilter，但是下面的實(shí)例將顛倒這個(gè)順序：

<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配置各節(jié)點(diǎn)說(shuō)明

<filter>指定一個(gè)過(guò)濾器。
<filter-name>用于為過(guò)濾器指定一個(gè)名字，該元素的內(nèi)容不能為空。
<filter-class>元素用于指定過(guò)濾器的完整的限定類(lèi)名。
<init-param>元素用于為過(guò)濾器指定初始化參數(shù)，它的子元素<param-name>指定參數(shù)的名字，<param-value>指定參數(shù)的值。
在過(guò)濾器中，可以使用FilterConfig接口對(duì)象來(lái)訪(fǎng)問(wèn)初始化參數(shù)。
<filter-mapping>元素用于設(shè)置一個(gè) Filter 所負(fù)責(zé)攔截的資源。一個(gè)Filter攔截的資源可通過(guò)兩種方式來(lái)指定：Servlet 名稱(chēng)和資源訪(fǎng)問(wèn)的請(qǐng)求路徑
<filter-name>子元素用于設(shè)置filter的注冊(cè)名稱(chēng)。該值必須是在<filter>元素中聲明過(guò)的過(guò)濾器的名字
<url-pattern>設(shè)置 filter 所攔截的請(qǐng)求路徑(過(guò)濾器關(guān)聯(lián)的URL樣式)
<servlet-name>指定過(guò)濾器所攔截的Servlet名稱(chēng)。
<dispatcher>指定過(guò)濾器所攔截的資源被 Servlet 容器調(diào)用的方式，可以是REQUEST,INCLUDE,FORWARD和ERROR之一，默認(rèn)REQUEST。用戶(hù)可以設(shè)置多個(gè)<dispatcher>子元素用來(lái)指定 Filter 對(duì)資源的多種調(diào)用方式進(jìn)行攔截。
<dispatcher>子元素可以設(shè)置的值及其意義
REQUEST：當(dāng)用戶(hù)直接訪(fǎng)問(wèn)頁(yè)面時(shí)，Web容器將會(huì)調(diào)用過(guò)濾器。如果目標(biāo)資源是通過(guò)RequestDispatcher的include()或forward()方法訪(fǎng)問(wèn)時(shí)，那么該過(guò)濾器就不會(huì)被調(diào)用。
INCLUDE：如果目標(biāo)資源是通過(guò)RequestDispatcher的include()方法訪(fǎng)問(wèn)時(shí)，那么該過(guò)濾器將被調(diào)用。除此之外，該過(guò)濾器不會(huì)被調(diào)用。
FORWARD：如果目標(biāo)資源是通過(guò)RequestDispatcher的forward()方法訪(fǎng)問(wèn)時(shí)，那么該過(guò)濾器將被調(diào)用，除此之外，該過(guò)濾器不會(huì)被調(diào)用。
ERROR：如果目標(biāo)資源是通過(guò)聲明式異常處理機(jī)制調(diào)用時(shí)，那么該過(guò)濾器將被調(diào)用。除此之外，過(guò)濾器不會(huì)被調(diào)用。

以上內(nèi)容是否對(duì)您有幫助：

← Servlet HTTP 狀態(tài)碼

Servlet 異常處理 →

寫(xiě)筆記

我要補(bǔ)充