Servlet和JSP中的過濾器都是Java類,它們存在的目的如下:
在請求存取後端資源時攔截它
管理從伺服器傳回給客戶端的回應
下面列出了多種常用的過濾器類型:
認證過濾器
資料壓縮過濾器
加密過濾器
觸發資源存取事件的過濾器
影像轉換濾鏡
登入和驗證過濾器
MIME類型鏈過濾器
令牌過濾器
轉換XML內容的XSL/T過濾器
過濾器將會被插入進web.xml檔案中,然後映射servlet、JSP檔案的名字,或URL模式。部署描述檔web.xml可以在<Tomcat-installation-directory>conf 目錄下找到。
當JSP容器啟動網路應用程式時,它會建立每一個過濾器的實例,這些過濾器必須在部署描述檔web.xml中聲明,並且按聲明的順序執行。
一個過濾器就是一個Java類,它實作了javax.servlet.Filter 介面。 javax.servlet.Filter介面定義了三個方法:
序號 | 方法&描述 |
---|---|
1 | public void doFilter (ServletRequest, ServletResponse, FilterChain)每當request/response要通過過濾鏈時容器會呼叫這個方法,因為客戶端請求鏈尾的資源 |
2 | public void init(FilterConfig filterConfig)容器呼叫這個方法來表示一個過濾器被安置在服務中 |
3 | public void destroy()容器呼叫這個方法來表示一個過濾器正在從服務中移除 |
這個例子將會列印IP位址和每次存取JSP檔案的日期時間。當然,這只是個簡單的例子,讓您了解一些簡單的過濾器用法,但是可以使用這些概念來自行構造更複雜的程式。
// 引入Java套件import java.io.*;import javax.servlet.*;import javax.servlet.http.*;import java.util.*; // 實作Filter 類別public class LogFilter implements Filter { public void init( FilterConfig config) throws ServletException{ // 取得初始化參數String testParam = config.getInitParameter("test-param"); //列印初始化參數System.out.println("Test Param: " + testParam); } public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws .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實例在伺服器上被移除前呼叫。 */ }}
編譯LogFilter.java文件,然後將編譯後的class檔案放在<Tomcat安裝目錄>/webapps/ROOT/WEB-INF/classes目錄下。
過濾器被定義,然後映射成一個URL或JSP檔名,與servlet被定義然後映射的方式差不多。在部署描述檔web.xml中,使用<filter>標籤來進行過濾器映射:
<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頁面,您會發現伺服器日誌中產生了關於此次存取的記錄。您也可以使用Log4J記錄器來把日誌記錄在其它檔案中。
您的網頁應用程式可以定義很多不同的篩選器。現在,您定義了兩個過濾器,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中<filter>元素的映射順序決定了容器應用這些過濾器的順序。要反轉應用的順序,您只需要反轉web.xml中<filter>元素的定義順序就行了。
例如,上面的例子會先套用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>