JSP 過濾器

JSP 過濾器

JSP 和 Servlet 中的過濾器都是 Java 類。

過濾器可以動態地攔截請求和響應,以變換或使用包含在請求或響應中的資訊。

可以將一個或多個過濾器附加到一個 Servlet 或一組 Servlet。過濾器也可以附加到 JavaServer Pages (JSP) 檔案和 HTML 頁面。

過濾器是可用於 Servlet 程式設計的 Java 類,可以實現以下目的:

  • 在客戶端的請求訪問後端資源之前,攔截這些請求。
  • 在伺服器的響應傳送回客戶端之前,處理這些響應。

根據規範建議的各種型別的過濾器:

  • 身份驗證過濾器(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 內容。

過濾器通過 Web 部署描述符(web.xml)中的 XML 標籤來宣告,然後對映到您的應用程式的部署描述符中的 Servlet 名稱或 URL 模式。

當 Web 容器啟動 Web 應用程式時,它會為您在部署描述符中宣告的每一個過濾器建立一個例項。

Filter 的執行順序與在 web.xml 配置檔案中的配置順序一致,一般把 Filter 配置在所有的 Servlet 之前。

Servlet 過濾器方法

過濾器是一個實現了 javax.servlet.Filter 介面的 Java 類。javax.servlet.Filter 介面定義了三個方法:

序號方法 & 描述
1public void doFilter (ServletRequest, ServletResponse, FilterChain)
該方法完成實際的過濾操作,當客戶端的請求與過濾器設定的 URL 匹配時,Servlet 容器將先呼叫過濾器的 doFilter 方法。FilterChain 用於訪問後續過濾器。
2public void init(FilterConfig filterConfig)
web 應用程式啟動時,web 伺服器將建立Filter 的例項物件,並呼叫其init方法,讀取web.xml配置,完成物件的初始化功能,從而為後續的使用者請求作好攔截的準備工作(filter物件只會建立一次,init方法也只會執行一次)。開發人員通過init方法的引數,可獲得代表當前filter配置資訊的FilterConfig物件。
3public void destroy()
Servlet容器在銷燬過濾器例項前呼叫該方法,在該方法中釋放Servlet過濾器佔用的資源。

FilterConfig 使用

Filter 的 init 方法中提供了一個 FilterConfig 物件。

如 web.xml 檔案配置如下:

<filter>
    <filter-name>LogFilter</filter-name>
    <filter-class>com.itread01.test.LogFilter</filter-class>
    <init-param>
        <param-name>Site</param-name>
        <param-value>入門教學</param-value>
    </init-param>
    </filter>

在 init 方法使用 FilterConfig 物件獲取引數:

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

JSP 過濾器例項

以下是 Servlet 過濾器的例項,將輸出網站名稱和地址。本例項讓您對 Servlet 過濾器有基本的瞭解,您可以使用相同的概念編寫更復雜的過濾器應用程式:

//匯入必需的 java 庫
import javax.servlet.*;
import java.util.*;

//實現 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("站點網址:http://www.itread01.com");

        // 把請求傳回過濾鏈
        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 請求例項 - 入門教學例項";
        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 = https://www.itread01.com/jsp/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>  
<filter>
  <filter-name>LogFilter</filter-name>
  <filter-class>com.itread01.test.LogFilter</filter-class>
  <init-param>
    <param-name>Site</param-name>
    <param-value>入門教學</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.itread01.test.DisplayHeader</servlet-class>  
</servlet>  
<servlet-mapping>  
  <servlet-name>DisplayHeader</servlet-name>  
  <!-- 訪問的網址 -->  
  <url-pattern>/TomcatTest/DisplayHeader</url-pattern>  
</servlet-mapping>  
</web-app>  

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

現在試著以常用的方式呼叫任何 Servlet,您將會看到在 Web 伺服器中生成的日誌。您也可以使用 Log4J 記錄器來把上面的日誌記錄到一個單獨的檔案中。

接下來我們訪問這個例項地址 http://localhost:8080/TomcatTest/DisplayHeader, 然後在控制檯看下輸出內容,如下所示:

使用多個過濾器

Web 應用程式可以根據特定的目的定義若干個不同的過濾器。假設您定義了兩個過濾器 AuthenFilterLogFilter。您需要建立一個如下所述的不同的對映,其餘的處理與上述所講解的大致相同:

<filter>
   <filter-name>LogFilter</filter-name>
   <filter-class>com.itread01.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.itread01.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 元素即可。

例如,上面的例項將先應用 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,FORWARDERROR之一,預設REQUEST。使用者可以設定多個<dispatcher>子元素用來指定 Filter 對資源的多種呼叫方式進行攔截。
  • <dispatcher>子元素可以設定的值及其意義
    • REQUEST:當用戶直接訪問頁面時,Web容器將會呼叫過濾器。如果目標資源是通過RequestDispatcher的include()或forward()方法訪問時,那麼該過濾器就不會被呼叫。
    • INCLUDE:如果目標資源是通過RequestDispatcher的include()方法訪問時,那麼該過濾器將被呼叫。除此之外,該過濾器不會被呼叫。
    • FORWARD:如果目標資源是通過RequestDispatcher的forward()方法訪問時,那麼該過濾器將被呼叫,除此之外,該過濾器不會被呼叫。
    • ERROR:如果目標資源是通過宣告式異常處理機制呼叫時,那麼該過濾器將被呼叫。除此之外,過濾器不會被呼叫。