JSP過濾器

在本章中，我們將討論JSP中的過濾器。Servlet和JSP過濾器是可以在Servlet和JSP程式設計中用於以下目的的Java類：

• 在用戶端存取後端的資源之前攔截請求。
• 在伺服器傳送回用戶端之前操縱響應。

有各種型別的過濾器由規格建議 -

• 驗證過濾器
• 資料壓縮過濾器
• 加密過濾器
• 觸發資源存取事件的過濾器
• 影象轉換過濾器
• 記錄和稽核過濾器
• MIME型別鏈式過濾器
• 令牌過濾器
• 轉換XML內容的XSL/T過濾器

過濾器部署在部署描述符檔案web.xml中，然後對映到應用程式部署描述符中的servlet或JSP名稱或URL模式。部署描述符檔案web.xml可以在<Tomcat-installation-directory>\conf目錄中或在專案的WEB-INF目錄下找到。

Servlet過濾器方法

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

JSP過濾器範例

以下範例顯示了如何在客戶存取任何JSP檔案時，列印用戶端的IP地址和當前日期時間。 這個例子將讓您對JSP過濾器有一個基本的了解，基於這個範例，您可以使用相同的概念編寫更複雜的過濾器應用程式。

開啟Eclipse，建立一個動態Web專案：Filter，其專案的結構如下所示 -

下面來看看這個應用的具體實現。

檔案：LogFilter.java

package com.yiibai;

//Import required java libraries
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
import java.util.*;

//Implements Filter class
public class LogFilter implements Filter {
    public void init(FilterConfig config) throws ServletException {
        // Get init parameter
        String testParam = config.getInitParameter("test-param");
        // Print the init parameter
        System.out.println("Test Param: " + testParam);
    }

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws java.io.IOException, ServletException {

        // Get the IP address of client machine.
        String ipAddress = request.getRemoteAddr();

        // Log the IP address and current timestamp.
        System.out.println("IP " + ipAddress + ", Time " + new Date().toString());

        // Pass request back down the filter chain
        chain.doFilter(request, response);
    }

    public void destroy() {
        /*
         * Called before the Filter instance is removed from service by the web
         * container
         */
    }
}

Web.xml中的JSP過濾器對映

過濾器需要先定義，然後對映到URL或JSP檔案名，與Servlet定義的方式大致相同，然後對映到web.xml檔案中的URL模式。在部署描述符檔案web.xml中為過濾器標籤建立以下標籤項 -

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

上述過濾器將適用於所有servlet和JSP，因為我們在組態中指定了/*。如果要僅在少數servlet或JSP上應用過濾器，則可以指定特定的servlet或JSP路徑。

現在嘗試呼叫任意一個servlet或JSP，將看到有生成紀錄檔到Web伺服器紀錄檔。可以使用Log4J記錄器記錄以上紀錄檔在單獨的檔案中。

在終端輸出結果如下 -

......
資訊: Starting Servlet Engine: Apache Tomcat/8.5.23
十月 20, 2017 2:22:55 上午 org.apache.catalina.util.SessionIdGeneratorBase createSecureRandom
警告: Creation of SecureRandom instance for session ID generation using [SHA1PRNG] took [110] milliseconds.
Test Param: Initialization Paramter
十月 20, 2017 2:22:55 上午 org.apache.coyote.AbstractProtocol start
資訊: Starting ProtocolHandler ["http-nio-8080"]
十月 20, 2017 2:22:55 上午 org.apache.coyote.AbstractProtocol start
資訊: Starting ProtocolHandler ["ajp-nio-8009"]
十月 20, 2017 2:22:55 上午 org.apache.catalina.startup.Catalina start
資訊: Server startup in 717 ms
IP 0:0:0:0:0:0:0:1, Time Fri Oct 20 02:22:57 BOT 2017

使用多個過濾器

Web應用程式可以定義幾個具有特定目的的不同過濾器。考慮一下，定義兩個過濾器AuthenFilter和LogFilter。其餘的過程將保持跟上面一樣，除了需要建立一個不同的對映，如下所述 -

<filter>
   <filter-name>LogFilter</filter-name>
   <filter-class>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>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中的過濾器對映元素的順序確定了Web容器將過濾器應用於servlet或JSP的順序。 要顛倒過濾器的順序，只需要反轉web.xml檔案中的過濾器對映元素即可。

例如，上面的例子將首先應用LogFilter，然後將AuthenFilter應用於任何servlet或JSP; 以下範例將顛倒順序 -

<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>