Filter的介紹及使用

轉：http://blog.csdn.net/zhaozheng7758/article/details/6105749

1、Filter的介紹及使用

什麼是過濾器？

與Servlet類似，過濾器是一些web應用程序組件，能夠綁定到一個web應用程序中。可是與其餘web應用程序組件不一樣的是，過濾器是"鏈"在容器的處理過程當中的。這就意味着它們會在servlet處理器以前訪問一個進入的請求，而且在外發響應信息返回到客戶前訪問這些響應信息。這種訪問使得過濾器能夠檢查並修改請求和響應的內容。

過濾器適用於那些地方？

l  爲一個web應用程序的新功能創建模型(可被添加到web應用程序中或者從web應用程序中刪除而不須要重寫基層應用程序代碼)；

l  向過去的代碼添加新功能。

過濾器放在容器結構的什麼位置？

過濾器放在web資源以前，能夠在請求抵達它所應用的web資源(能夠是一個Servlet、一個Jsp頁面，甚至是一個HTML頁面)以前截獲進入的請求，而且在它返回到客戶以前截獲輸出請求。Filter：用來攔截請求，處於客戶端與被請求資源之間，目的是重用代碼。Filter鏈，在web.xml中哪一個先配置，哪一個就先調用。在filter中也能夠配置一些初始化參數。

Java中的Filter 並非一個標準的Servlet ，它不能處理用戶請求，也不能對客戶端生成響應。 主要用於對HttpServletRequest 進行預處理，也能夠對HttpServletResponse 進行後處理，是個典型的處理鏈。 

Filter 有以下幾個用處：

l  在HttpServletRequest 到達Servlet 以前，攔截客戶的HttpServletRequest 。 

l  根據須要檢查HttpServletRequest ，也能夠修改HttpServletRequest 頭和數據。 

l  在HttpServletResponse 到達客戶端以前，攔截HttpServletResponse 。 

l  根據須要檢查HttpServletResponse ，能夠修改HttpServletResponse 頭和數據。

Filter 有以下幾個種類：

l  用戶受權的Filter: Filter 負責檢查用戶請求，根據請求過濾用戶非法請求。 

l  日誌Filter: 詳細記錄某些特殊的用戶請求。 

l  負責解碼的Filter: 包括對非標準編碼的請求解碼。 

l  能改變XML 內容的XSLTFilter 等。 

一個Filter 可負責攔截多個請求或響應:一個請求或響應也可被多個請求攔截。 

建立一個Filter 只需兩個步驟: 
(1)建立Filter 處理類: 

(2)在web.xml 文件中配置Filter 。 
建立Filter 必須實現javax.servlet.Filter 接口，在該接口中定義了三個方法。 
• void init(FilterConfig config): 用於完成Filter 的初始化。 
• void destroy(): 用於Filter 銷燬前，完成某些資源的回收。 
• void doFilter(ServletRequest request, ServletResponse response,FilterChain chain): 實現過濾功能，該方法就是對每一個請求及響應增長的額外處理。 

過濾器Filter也具備生命週期：init()->doFilter()->destroy()，由部署文件中的filter元素驅動。在servlet2.4中，過濾器一樣能夠用於請求分派器，但須在web.xml中聲明，<dispatcher>INCLUDE或FORWARD或REQUEST或ERROR</dispatcher>該元素位於filter-mapping中。 

Filter經常使用的場景：

例1、  日誌的記錄，當有請求到達時，在該過濾器中進行日誌的記錄。處理完成後，進入後續的Filter或者處理。

步驟1：編寫Filter類

package test.filter;

 

import javax.servlet.Filter;

import javax.servlet.FilterChain;

import javax.servlet.FilterConfig;

import javax.servlet.ServletContext;

import javax.servlet.ServletRequest;

import javax.servlet.ServletResponse;

import javax.servlet.http.HttpServletRequest;

 

public class LogFilter implements Filter { 

    private FilterConfig config; 

    // 實現初始化方法 

    public void init(FilterConfig config) { 

        this.config = config; 

    } 

    // 實現銷燬方法 

    public void destroy() { 

        this.config = null; 

    } 

    public void doFilter(ServletRequest request, ServletResponse response, 

            FilterChain chain) { 

        // 獲取ServletContext 對象，用於記錄日誌 

        ServletContext context = this.config.getServletContext(); 

        long before = System.currentTimeMillis(); 

        System.out.println("開始過濾... "); 

        // 將請求轉換成HttpServletRequest 請求 

        HttpServletRequest hrequest = (HttpServletRequest) request; 

        // 記錄日誌 

        context.log("Filter已經截獲到用戶的請求的地址: " + hrequest.getServletPath()); 

        try { 

            // Filter 只是鏈式處理，請求依然轉發到目的地址。 

            chain.doFilter(request, response); 

        } catch (Exception e) { 

            e.printStackTrace(); 

        } 

        long after = System.currentTimeMillis(); 

        // 記錄日誌 

        context.log("過濾結束"); 

        // 再次記錄日誌 

        context.log(" 請求被定位到" + ((HttpServletRequest) request).getRequestURI() 

                + "所花的時間爲: " + (after - before)); 

    } 

} 

在上面的請求Filter中，僅在日誌中記錄請求的URL，對全部的請求都執行chain.doFilter(request，reponse)方法，當Filter 對請求過濾後，依然將請求發送到目的地址。

步驟2：在web.xml中配置Filter

<!-- 定義Filter --> 

<filter> 

    <!-- Filter 的名字 --> 

    <filter-name>log</filter-name> 

    <!-- Filter 的實現類 --> 

    <filter-class> test.filter.LogFilter</filter-class> 

</filter> 

<!-- 定義Filter 攔截地址 --> 

<filter-mapping> 

    <!-- Filter 的名字 --> 

    <filter-name>log</filter-name> 

    <!-- Filter 負責攔截的URL --> 

    <url-pattern>/filter/*</url-pattern>

</filter-mapping> 

經過上述步驟的操做，此時就能夠經過URI進行訪問。具體訪問後會在log文件中的localhost文件中產生具體的訪問日誌。以下所示：

2010-12-28 21:12:50 org.apache.catalina.core.ApplicationContext log

信息:  請求被定位到/examples/jsp/jsp2/el/basic-arithmetic.jsp所花的時間爲: 0

2010-12-28 21:14:55 org.apache.catalina.core.ApplicationContext log

信息: Filter已經截獲到用戶的請求的地址: /jsp/jsp2/el/basic-comparisons.jsp

2010-12-28 21:14:56 org.apache.catalina.core.ApplicationContext log

信息: 過濾結束

例2、      進行編碼的修正，當有新的請求時，須要將用戶傳送過來的字符進行從新編碼，以使其能夠知足服務器的編碼格式。

一、   編寫EncodingFilter類

package test.filter;

import java.io.IOException;

import javax.servlet.Filter;

import javax.servlet.FilterChain;

import javax.servlet.FilterConfig;

import javax.servlet.ServletContext;

import javax.servlet.ServletException;

import javax.servlet.ServletRequest;

import javax.servlet.ServletResponse;

 

public class EncodingFilter implements Filter {   

    private FilterConfig filterConfig = null;

    private String encoding = null;   

    //實現銷燬方法

    public void destroy() {   

         encoding = null;   

     }   

    //進行具體的過濾

    public void doFilter(ServletRequest request, ServletResponse response,   

             FilterChain chain) throws IOException, ServletException {

        // 獲取ServletContext 對象，用於記錄日誌 

         ServletContext context =this.filterConfig.getServletContext(); 

         context.log("開始設置編碼格式");

         String encoding = getEncoding();   

         if (encoding == null){   

             encoding = "gb2312";   

         }

         // 在請求裏設置上指定的編碼

         request.setCharacterEncoding(encoding);

         chain.doFilter(request, response);  

         context.log("成功設置了編碼格式");

     }   

    //初始化配置

    public void init(FilterConfig filterConfig) throwsServletException {

        this.filterConfig = filterConfig;

        this.encoding = filterConfig.getInitParameter("encoding");   

     }   

   

    private String getEncoding() {   

        return this.encoding;   

     }   

} 

步驟2：在web.xml中配置Filter

<!-- 定義Filter --> 

<filter> 

    <!-- Filter 的名字 --> 

    <filter-name>encoding</filter-name> 

    <!-- Filter 的實現類 --> 

<filter-class> test.filter.EncodingFilter</filter-class>

<init-param>   

<param-name>encoding</param-name>   

<param-value>gb2312</param-value>   

</init-param>   

</filter> 

<!-- 定義Filter 攔截地址 --> 

<filter-mapping> 

    <!-- Filter 的名字 --> 

    <filter-name> encoding </filter-name> 

    <!-- Filter 負責攔截的URL --> 

    <url-pattern>/encode/*</url-pattern> 

</filter-mapping> 

經過上述步驟的操做，此時就能夠經過URI進行訪問。

例3、用戶權限的認證，當用戶發送請求時，能夠對用戶的身份信息進行驗證，若是可以經過驗證則接下來再進行其它操做，不然直接不進入下一步的處理。

一、   編寫身份認證SecurityFilter類

package test.filter;

import java.io.IOException;

import javax.servlet.Filter;

import javax.servlet.FilterChain;

import javax.servlet.FilterConfig;

import javax.servlet.ServletContext;

import javax.servlet.ServletException;

import javax.servlet.ServletRequest;

import javax.servlet.ServletResponse;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import javax.servlet.http.HttpSession;

 

public class SecurityFilter implements Filter {

    private FilterConfig filterConfig;

    //初始化方法實現

    @Override

    public void init(FilterConfig filterConfig) throwsServletException {

        this.filterConfig = filterConfig;

    }

    //身份認證的過濾

    @Override

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)

            throws IOException, ServletException {

        ServletContext context =this.filterConfig.getServletContext();

        HttpServletRequest req = (HttpServletRequest) request;

        HttpServletResponse res = (HttpServletResponse) response;

 

        HttpSession session = req.getSession();

        //登陸後才能進入下一步處理，不然直接進入錯誤提示頁面

        if (session.getAttribute("username") != null) {

            context.log("身份認證經過，進入下一步處理 ");

            chain.doFilter(request, response);

        } else {

            context.log("身份認證失敗，直接返回");

            res.sendRedirect("../failure.jsp");

        }

    }

    //實現銷燬方法

    @Override

    public void destroy() {

        this.filterConfig = null;

    }

}

步驟2：在web.xml中配置Filter

<!-- 定義Filter --> 

<filter> 

    <!-- Filter 的名字 --> 

    <filter-name>security</filter-name> 

    <!-- Filter 的實現類 --> 

<filter-class> test.filter.SecurityFilter</filter-class>

</filter> 

<!-- 定義Filter 攔截地址 --> 

<filter-mapping> 

    <!-- Filter 的名字 --> 

    <filter-name> security </filter-name> 

    <!-- Filter 負責攔截的URL --> 

    <url-pattern>/security/*</url-pattern> 

</filter-mapping>

經過上述步驟的操做，此時就能夠經過URI進行訪問。此時若是可以取得Session中的username值時，會直接進入下一步處理，不然直接進入錯誤頁面。

2、過濾鏈FilterChain 

兩個過濾器，EncodingFilter負責設置編碼，SecurityFilter負責控制權限，服務器會按照web.xml中過濾器定義的前後循序組裝成一條鏈，而後一次執行其中的doFilter()方法。執行的順序就以下圖所示，執行第一個過濾器的chain.doFilter()以前的代碼，第二個過濾器的chain.doFilter()以前的代碼，請求的資源，第二個過濾器的chain.doFilter()以後的代碼，第一個過濾器的chain.doFilter()以後的代碼，最後返回響應。 

 

 

執行的代碼順序是： 

l  執行EncodingFilter.doFilter()中chain.doFilter()以前的部分；request.setCharacterEncoding(encoding);

l  執行SecurityFilter.doFilter()中chain.doFilter()以前的部分：判斷用戶是否已登陸。

l  若是用戶已登陸，則訪問請求的資源。

l  若是用戶未登陸，則頁面重定向到：/failure.jsp。

l  執行SecurityFilter.doFilter()中chain.doFilter()以後的部分：這裏沒有代碼。

l  執行EncodingFilter.doFilter()中chain.doFilter()以後的部分：寫入已經完成的日誌。

過濾鏈的好處是，執行過程當中任什麼時候候均可以打斷，只要不執行chain.doFilter()就不會再執行後面的過濾器和請求的內容。而在實際使用時，就要特別注意過濾鏈的執行順序問題，像EncodingFilter就必定要放在全部Filter以前，這樣才能確保在使用請求中的數據前設置正確的編碼。