servlet 編寫過濾器

Servlet 過濾器是可用于 Servlet 編程的 Java 類，有以下目的：

專注于為中小企業(yè)提供成都網(wǎng)站制作、網(wǎng)站建設服務,電腦端+手機端+微信端的三站合一,更高效的管理,為中小企業(yè)江山免費做網(wǎng)站提供優(yōu)質的服務。我們立足成都，凝聚了一批互聯(lián)網(wǎng)行業(yè)人才，有力地推動了數(shù)千家企業(yè)的穩(wěn)健成長，幫助中小企業(yè)通過網(wǎng)站建設實現(xiàn)規(guī)模擴充和轉變。

• 在客戶端的請求訪問后端資源之前，攔截這些請求。
• 在服務器的響應發(fā)送回客戶端之前，處理這些響應。

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

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

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

當 Web 容器啟動 Web 應用程序時，它會為您在部署描述符中聲明的每一個過濾器創(chuàng)建一個實例。該過濾器執(zhí)行的順序是按它們在部署描述符中聲明的順序。

Servlet 過濾器方法

過濾器是一個實現(xiàn)了 javax.servlet.Filter 接口的 Java 類。javax.servlet.Filter 接口定義了三個方法：

序號	方法 & 描述
1	public void doFilter (ServletRequest, ServletResponse, FilterChain) 該方法在每次一個請求/響應對因客戶端在鏈的末端請求資源而通過鏈傳遞時由容器調用。
2	public void init(FilterConfig filterConfig) 該方法由 Web 容器調用，指示一個過濾器被放入服務。
3	public void destroy() 該方法由 Web 容器調用，指示一個過濾器被取出服務。

FilterConfig 使用

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

如 web.xml 文件配置如下：

	LoginFilter
	com.cdcxhl.com.test.LogFilter
	
		Site
		cdcxhl.com在線教程
	
	

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

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

Servlet 過濾器實例

以下是 Servlet 過濾器的實例，將輸出客戶端的 IP 地址和當前的日期時間。本實例讓您對 Servlet 過濾器有基本的了解，您可以使用相同的概念編寫更復雜的過濾器應用程序：

// 導入必需的 java 庫
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
import java.util.*;

// 實現(xiàn) Filter 類
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 {

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

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

      // 把請求傳回過濾鏈
      chain.doFilter(request,response);
   }
   public void destroy( ){
      /* 在 Filter 實例被 Web 容器從服務移除之前調用 */
   }
}

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

//導入必需的 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;

@WebServlet("/DisplayHeader")

//擴展 HttpServlet 類
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 請求實例 - cdcxhl.com教程實例";
		String docType =
			" \n";
			out.println(docType +
			"\n" +
			"\n"+
			"\n" +
			"
" + title + "
\n" +
			"\n" +
			"\n" +
			"\n"+
			"\n");

		Enumeration headerNames = request.getHeaderNames();

		while(headerNames.hasMoreElements()) {
			String paramName = (String)headerNames.nextElement();
			out.print("\n");
			String paramValue = request.getHeader(paramName);
			out.println("\n");
		}
		out.println("
Header 名稱
Header 值
" + paramName + "
 " + paramValue + "
\n");
	}
	// 處理 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 標簽創(chuàng)建下面的條目：

  
  

  LogFilter
  com.cdcxhl.com.test.LogFilter
  
    Site
    cdcxhl.com在線教程
  


  LogFilter
  /*

  
    
  DisplayHeader  
    
  com.cdcxhl.com.test.DisplayHeader  
  
  
  DisplayHeader  
    
  /TomcatTest/DisplayHeader  
  

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

現(xiàn)在試著以常用的方式調用任何 Servlet，您將會看到在 Web 服務器中生成的日志。您也可以使用 Log4J 記錄器來把上面的日志記錄到一個單獨的文件中。

使用多個過濾器

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

 LogFilter com.cdcxhl.com.test.LogFilter  test-param Initialization Paramter    AuthenFilter com.cdcxhl.com.test.AuthenFilter  test-param Initialization Paramter    LogFilter /*   AuthenFilter /* 

過濾器的應用順序

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

例如，上面的實例將先應用 LogFilter，然后再應用 AuthenFilter，但是下面的實例將顛倒這個順序：

   AuthenFilter
   /*



   LogFilter
   /*

web.xml配置各節(jié)點說明

指定一個過濾器。

用于為過濾器指定一個名字，該元素的內容不能為空。

元素用于指定過濾器的完整的限定類名。

元素用于為過濾器指定初始化參數(shù)，它的子元素指定參數(shù)的名字，指定參數(shù)的值。

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

元素用于設置一個 Filter 所負責攔截的資源。一個Filter攔截的資源可通過兩種方式來指定：Servlet 名稱和資源訪問的請求路徑

子元素用于設置filter的注冊名稱。該值必須是在元素中聲明過的過濾器的名字

設置 filter 所攔截的請求路徑(過濾器關聯(lián)的URL樣式)

指定過濾器所攔截的Servlet名稱。

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

子元素可以設置的值及其意義

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

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

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

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

分享文章：創(chuàng)新互聯(lián)Servlet教程：Servlet 編寫過濾器
分享鏈接：http://www.5511xx.com/article/cdcgdoc.html