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 接口定義了三個方法:
序號 | 方法 & 描述 |
---|---|
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.yapf.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.090948.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 = 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.yapf.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.yapf.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.yapf.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.yapf.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
:如果目標資源是通過聲明式異常處理機制調用時,那么該過濾器將被調用。除此之外,過濾器不會被調用。