Java中的Filter過濾器

標籤：ini   異常處理   封裝   枚舉   ber   初始化   number   iter   war   

Filter簡介

Filter也稱之為過濾器，它是Servlet技術中最實用的技術，Web開發人員通過Filter技術，對web伺服器管理的所有web資源：例如Jsp, Servlet, 靜態圖片檔案或靜態 html 檔案等進行攔截，從而實現一些特殊的功能。例如實現URL層級的許可權存取控制、過濾禁用語、壓縮響應資訊等一些進階功能。

它主要用於對使用者請求進行預先處理，也可以對HttpServletResponse進行後處理。使用Filter的完整流程：Filter對使用者請求進行預先處理，接著將請求交給Servlet進行處理並產生響應，最後Filter再對伺服器響應進行後處理。

Filter功能

在HttpServletRequest到達 Servlet 之前，攔截客戶的HttpServletRequest 。根據需要檢查HttpServletRequest，也可以修改HttpServletRequest 頭和資料。
在HttpServletResponse到達用戶端之前，攔截HttpServletResponse 。根據需要檢查HttpServletResponse，也可以修改HttpServletResponse頭和資料。

如何藉助Filter實現攔截功能

Filter介面中有一個doFilter方法，當開發人員編寫好Filter，並配置對哪個web資源進行攔截後，Web伺服器每次在調用web資源的service方法之前，都會先調用一下filter的doFilter方法，因此，在該方法內編寫代碼可達到如下目的：

調用目標資源之前，讓一段代碼執行。是否調用目標資源（即是否讓使用者訪問web資源）。web伺服器在調用doFilter方法時，會傳遞一個filterChain對象進來，filterChain對象是filter介面中最重要的一個對象，它也提供了一個doFilter方法，開發人員可以根據需求決定是否調用此方法，調用該方法，則web伺服器就會調用web資源的service方法，即web資源就會被訪問，否則web資源不會被訪問。

Filter開發兩步走

編寫java類實現Filter介面，並實現其doFilter方法。
在web.xml檔案中對編寫的filter類進行註冊，並設定它所能攔截的資源。

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：如果目標資源是通過聲明式異常處理機制調用時，那麼該過濾器將被調用。除此之外，過濾器不會被調用。

Filter鏈

在一個web應用中，可以開發編寫多個Filter，這些Filter組合起來稱之為一個Filter鏈。

web伺服器根據Filter在web.xml檔案中的註冊順序，決定先調用哪個Filter，當第一個Filter的doFilter方法被調用時，web伺服器會建立一個代表Filter鏈的FilterChain對象傳遞給該方法。在doFilter方法中，開發人員如果調用了FilterChain對象的doFilter方法，則web伺服器會檢查FilterChain對象中是否還有filter，如果有，則調用第2個filter，如果沒有，則調用目標資源。

Filter的生命週期

public void init(FilterConfig filterConfig) throws ServletException;//初始化和我們編寫的Servlet程式一樣，Filter的建立和銷毀由WEB伺服器負責。 web 應用程式啟動時，網頁伺服器將建立Filter 的執行個體對象，並調用其init方法，讀取web.xml配置，完成對象的初始化功能，從而為後續的使用者請求作好攔截的準備工作（filter對象只會建立一次，init方法也只會執行一次）。開發人員通過init方法的參數，可獲得代表當前filter配置資訊的FilterConfig對象。public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException;//攔截請求這個方法完成實際的過濾操作。當客戶請求訪問與過濾器關聯的URL的時候，Servlet過濾器將先執行doFilter方法。FilterChain參數用於訪問後續過濾器。public void destroy();//銷毀Filter對象建立後會駐留在記憶體，當web應用移除或伺服器停止時才銷毀。在Web容器卸載 Filter 對象之前被調用。該方法在Filter的生命週期中僅執行一次。在這個方法中，可以釋放過濾器使用的資源。

FilterConfig介面

使用者在配置filter時，可以使用為filter配置一些初始化參數，當web容器執行個體化Filter對象，調用其init方法時，會把封裝了filter初始化參數的filterConfig對象傳遞進來。因此開發人員在編寫filter時，通過filterConfig對象的方法，就可獲得以下內容：

String getFilterName();//得到filter的名稱。 String getInitParameter(String name);//返回在部署描述中指定名稱的初始化參數的值。如果不存在返回null. Enumeration getInitParameterNames();//返回過濾器的所有初始化參數的名字的枚舉集合。 public ServletContext getServletContext();//返回Servlet內容物件的引用。

Filter使用案例使用Filter驗證使用者登入安全控制

前段時間參與維護一個項目，使用者退出系統後，再去地址欄訪問曆史，根據url，仍然能夠進入系統響應頁面。我去檢查一下發現對請求未進行過濾驗證使用者登入。添加一個filter搞定問題！

先在web.xml配置

<filter>    <filter-name>SessionFilter</filter-name>    <filter-class>com.action.login.SessionFilter</filter-class>    <init-param>        <param-name>logonStrings</param-name><!-- 對登入頁面不進行過濾 -->        <param-value>/project/index.jsp;login.do</param-value>    </init-param>    <init-param>        <param-name>includeStrings</param-name><!-- 只對指定過濾參數尾碼進行過濾 -->        <param-value>.do;.jsp</param-value>    </init-param>    <init-param>        <param-name>redirectPath</param-name><!-- 未通過跳轉到登入介面 -->        <param-value>/index.jsp</param-value>    </init-param>    <init-param>        <param-name>disabletestfilter</param-name><!-- Y:過濾無效 -->        <param-value>N</param-value>    </init-param></filter><filter-mapping>    <filter-name>SessionFilter</filter-name>    <url-pattern>/*</url-pattern></filter-mapping>

接著編寫FilterServlet

package com.action.login;import java.io.IOException;import javax.servlet.Filter;import javax.servlet.FilterChain;import javax.servlet.FilterConfig;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.HttpServletResponseWrapper;/** *    判斷使用者是否登入,未登入則退出系統 */public class SessionFilter implements Filter {    public FilterConfig config;    public void destroy() {        this.config = null;    }    public static boolean isContains(String container, String[] regx) {        boolean result = false;        for (int i = 0; i < regx.length; i++) {            if (container.indexOf(regx[i]) != -1) {                return true;            }        }        return result;    }    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {        HttpServletRequest hrequest = (HttpServletRequest)request;        HttpServletResponseWrapper wrapper = new HttpServletResponseWrapper((HttpServletResponse) response);        String logonStrings = config.getInitParameter("logonStrings");        // 登入登陸頁面        String includeStrings = config.getInitParameter("includeStrings");    // 過濾資源尾碼參數        String redirectPath = hrequest.getContextPath() + config.getInitParameter("redirectPath");// 沒有登陸轉向頁面        String disabletestfilter = config.getInitParameter("disabletestfilter");// 過濾器是否有效        if (disabletestfilter.toUpperCase().equals("Y")) {    // 過濾無效            chain.doFilter(request, response);            return;        }        String[] logonList = logonStrings.split(";");        String[] includeList = includeStrings.split(";");        if (!this.isContains(hrequest.getRequestURI(), includeList)) {// 只對指定過濾參數尾碼進行過濾            chain.doFilter(request, response);            return;        }        if (this.isContains(hrequest.getRequestURI(), logonList)) {// 對登入頁面不進行過濾            chain.doFilter(request, response);            return;        }        String user = ( String ) hrequest.getSession().getAttribute("useronly");//判斷使用者是否登入        if (user == null) {            wrapper.sendRedirect(redirectPath);            return;        }else {            chain.doFilter(request, response);            return;        }    }    public void init(FilterConfig filterConfig) throws ServletException {        config = filterConfig;    }}

這樣既可完成對使用者所有請求，均要經過這個Filter進行驗證使用者登入。

防止中文亂碼過濾器

項目使用spring架構時。當前台JSP頁面和Java代碼中使用了不同的字元集進行編碼的時候就會出現表單提交的資料或者上傳/下載中文名稱檔案出現亂碼的問題，那就可以使用這個過濾器。

<filter>    <filter-name>encoding</filter-name>    <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>    <init-param>        <param-name>encoding</param-name><!--用來指定一個具體的字元集-->        <param-value>UTF-8</param-value>    </init-param>    <init-param>        <param-name>forceEncoding</param-name><!--true：無論request是否指定了字元集，都是用encoding；false：如果request已指定一個字元集，則不使用encoding-->        <param-value>false</param-value>    </init-param></filter><filter-mapping>    <filter-name>encoding</filter-name>    <url-pattern>/*</url-pattern></filter-mapping>

Java中的Filter過濾器