JSP 中的 Filter 過濾器

一、什麼是過濾器

    過濾器是一個程序,它先於與之相關的 servlet 或 JSP 頁面運行在服務器上。過濾器可附加到一個或多個 servlet 或 JSP 頁面上,並且可以檢查進入這些資源的請求信息。在這之後,過濾器可以作如下的選擇:

(1)以常規的方式調用資源(即,調用 servlet 或 JSP 頁面)。

(2)利用修改過的請求信息調用資源。

(3)調用資源,但在發送響應到客戶機前對其進行修改。

(4)阻止該資源調用,代之以轉到其他的資源,返回一個特定的狀態代碼或生成替換輸出。


二、過濾器的基本原理

    過濾器可以對客戶的請求進行處理,處理完成後,它會交給下一個過濾器處理。這樣,客戶的請求在“過濾器鏈”裏逐個處理,直到請求發送到目標爲止。

    例如,某網站裏有提交“修改業務數據”的網頁,當用戶填寫完修改信息並提交後,服務器在進行處理時需要做兩項工作:判斷客戶端的會話查看該用戶是否有修改權限;對提交的數據進行統一編碼。這兩項工作可以在由兩個過濾器組成的過濾鏈裏進行處理。

    當過濾器處理成功後,把提交的數據發送到最終目標;如果過濾器處理不成功,將把視圖派發到指定的錯誤頁面。

三、過濾器的使用

    開發 Servlet 過濾器的步驟如下:

   (1)編寫實現 Filter 接口的類

    建立一個實現Filter接口的類。這個類需要三個方法,分別是:doFilter、init和destroy。doFilter方法包含主要的過濾代碼,init方法建立設置操作,而destroy方法進行清除
    在doFilter方法中放入過濾行爲。doFilter方法的第一個參數爲ServletRequest對象。此對象給過濾器提供了對進入的信息(包括表單數據、cookie和HTTP請求頭)的完全訪問。第二個參數爲ServletResponse,通常在簡單的過濾器中忽略此參數。最後一個參數爲FilterChain,如下一步所述,此參數用來調用servlet或JSP頁。
    

<span style="font-family:KaiTi_GB2312;font-size:18px;">public class CharsetEncodingFilter implements Filter {
	
	private String encoding;
	
	@Override
	public void destroy() {
		// TODO Auto-generated method stub

	}

	@Override
	public void doFilter(ServletRequest request, ServletResponse response,
			FilterChain chain) throws IOException, ServletException {
			
		//設置字符集
		request.setCharacterEncoding(encoding);
		
		//繼續執行
		chain.doFilter(request, response);
	}

	@Override
	public void init(FilterConfig filterConfig) throws ServletException {
		
	 this.encoding=filterConfig.getInitParameter("encoding");
		
	}

}</span>

    所有過濾器都必須實現javax.servlet.Filter。這個接口包含三個方法,分別爲doFilter、init和destroy。

<span style="font-family:KaiTi_GB2312;font-size:18px;">    public void doFilter(ServletRequset request, ServletResponse response,FilterChain chain) thows ServletException, IOException</span>
    每當調用一個過濾器(即,每次請求與此過濾器相關的servlet或JSP頁面)時,就執行其doFilter方法。正是這個方法包含了大部分過濾邏輯。
    第一個參數爲與傳入請求有關的ServletRequest。對於簡單的過濾器,大多數過濾邏輯是基於這個對象的。如果處理HTTP請求,並且需要訪問諸如 getHeader或getCookies等在ServletRequest中無法得到的方法,就要把此對象構造成 HttpServletRequest。
    第二個參數爲ServletResponse。除了在兩個情形下要使用它以外,通常忽略這個參數。

    首先,如果希望完全阻塞對相關servlet或JSP頁面的訪問。可調用response.getWriter並直接發送一個響應到客戶機。 

    其次,如果希望修改相關的servlet或JSP頁面的輸出,可把響應包含在一個收集所有發送到它的輸出的對象中。  

    然後,在調用serlvet或JSP頁面後,過濾器可檢查輸出,如果合適就修改它,之後發送到客戶機。 DoFilter的最後一個參數爲FilterChain對象。對此對象調用doFilter以激活與servlet或JSP頁面相關的下一個過濾器。如果沒有另一個相關的過濾器,則對doFilter的調用激活servlet或JSP本身。

<span style="font-family:KaiTi_GB2312;font-size:18px;">   public void init(FilterConfig config) thows ServletException</span>
    init 方法只在此過濾器第一次初始化時執行,不是每次調用過濾器都執行它。對於簡單的過濾器,可提供此方法的一個空體,但有兩個原因需要使用init。

    首先,FilterConfig對象提供對servlet環境及web.xml文件中指派的過濾器名的訪問。因此,普遍的辦法是利用init將 FilterConfig對象存放在一個字段中,以便doFilter方法能夠訪問servlet環境或過濾器名。

    其次,FilterConfig對象具有一個getInitParameter方法,它能夠訪問部署描述符文件(web.xml)中分配的過濾器初始化參 數。

<span style="font-family:KaiTi_GB2312;font-size:18px;">    public void destroy( )</span>
    此方法在利用一個給定的過濾器對象永久地終止服務器(如關閉服務器)時調用。大多數過濾器簡單地爲此方法提供一個空體,不過,可利用它來完成諸如關閉過濾器使用的文件或數據庫連接池等清除任務。
    doFilter 方法爲大多數過濾器地關鍵部分。每當調用一個過濾器時,都要執行doFilter。對於大多數過濾器來說,doFilter執行的步驟是基於傳入的信息的。因此,可能要利用作爲doFilter的第一個參數提供的ServletRequest。這個對象常常構造爲HttpServletRequest類型,以提供對該類的更特殊方法的訪問。
    Filter接口的 doFilter方法以一個FilterChain對象作爲它的第三個參數。在調用該對象的doFilter方法時,激活下一個相關的過濾器。這個過程一 般持續到鏈中最後一個過濾器爲止。在最後一個過濾器調用其FilterChain對象的doFilter方法時,激活servlet或頁面自身。
    但是,鏈中的任意過濾器都可以通過不調用其FilterChain的doFilter方法中斷這個過程。在這樣的情況下,不再調用JSP頁面的serlvet,並且中斷此調用過程的過濾器負責將輸出提供給客戶機。
  (2)在 web.xml 中配置 Filter

    要使得 Filter 生效,還必須在 web.xml 中對其進行配置,告知服務器,該過濾器應用在什麼模式的 URL 請求上。    

<span style="font-family:KaiTi_GB2312;font-size:18px;">        <filter>
<span style="font-family:KaiTi_GB2312;">             </span><filter-name>CharsetEncodingFilter</filter-name>
	<span style="font-family:KaiTi_GB2312;">     </span><filter-class>com.bjpowernode.drp.util.filter.CharsetEncodingFilter</filter-class>
	<span style="font-family:KaiTi_GB2312;">     </span><init-param>
		<param-name>encoding</param-name>
		<param-value>GBK</param-value>
	<span style="font-family:KaiTi_GB2312;">  </span>   </init-param>
	</filter>
	
	<filter-mapping>
	<span style="font-family:KaiTi_GB2312;">     </span><filter-name>CharsetEncodingFilter</filter-name>
	<span style="font-family:KaiTi_GB2312;">     </span><url-pattern>*.jsp</url-pattern>
	</filter-mapping></span>

    這一段 Filter 的配置和 Servlet 的配置很相似,其中“藍字”部份聲明瞭須要應用的過濾器類,“紅字”部份聲明瞭該過濾器所應用的 URL 路徑,就是說凡是後綴爲.jsp的所有請求都要經過該過濾器。 
    filter元素位於部署描述符文件(web.xml)的前部,所有filter-mapping、servlet或servlet-mapping元素之前。

    filter元素具有如下六個可能的子元素:
    icon 這是一個可選的元素,它聲明IDE能夠使用的一個圖象文件。
    filter-name 這是一個必需的元素,它給過濾器分配一個選定的名字。
    display-name 這是一個可選的元素,它給出IDE使用的短名稱。
    description 這也是一個可選的元素,它給出IDE的信息,提供文本文檔。
    filter-class 這是一個必需的元素,它指定過濾器實現類的完全限定名。
    init-param 這是一個可選的元素,它定義可利用FilterConfig的getInitParameter方法讀取的初始化參數。單個過濾器元素可包含多個init-param元素。

 
    filter-mapping元素位於web.xml文件中filter元素之後serlvet元素之前。它包含如下三個可能的子元素::
    filter-name 這個必需的元素必須與用filter元素聲明時給予過濾器的名稱相匹配。
    url-pattern 此元素聲明一個以斜槓(/)開始的模式,它指定過濾器應用的URL。所有filter-mapping元素中必須提供url-pattern或 servlet-name。但不能對單個filter-mapping元素提供多個url-pattern元素項。如果希望過濾器適用於多個模式,可重複整個filter-mapping元素。
    servlet-name 此元素給出一個名稱,此名稱必須與利用servlet元素給予servlet或JSP頁面的名稱相匹配。不能給單個filter-mapping元素提供 多個servlet-name元素項。如果希望過濾器適合於多個servlet名,可重複這個filter-mapping元素。

    基於以上的原理,在項目中遇到這樣一個問題,用戶只有登陸之後才能瀏覽resource目錄下的資源,而這些resource的地址都是靜態地址,這時候就用到了過濾器,

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章