Filter簡介

Filter也稱之為過濾器给猾，它是Servlet技術(shù)中最實用的技術(shù)，Web開發(fā)人員通過Filter技術(shù)轿曙，對web服務(wù)器管理的所有web資源：例如Jsp, Servlet, 靜態(tài)圖片文件或靜態(tài) html 文件等進行攔截，從而實現(xiàn)一些特殊的功能。例如實現(xiàn)URL級別的權(quán)限訪問控制屎飘、過濾敏感詞匯、壓縮響應(yīng)信息等一些高級功能贾费。
它主要用于對用戶請求進行預(yù)處理钦购，也可以對HttpServletResponse進行后處理。使用Filter的完整流程：Filter對用戶請求進行預(yù)處理褂萧，接著將請求交給Servlet進行處理并生成響應(yīng)押桃，最后Filter再對服務(wù)器響應(yīng)進行后處理。

Filter功能

在HttpServletRequest到達 Servlet 之前导犹，攔截客戶的HttpServletRequest 唱凯。根據(jù)需要檢查HttpServletRequest羡忘，也可以修改HttpServletRequest 頭和數(shù)據(jù)。
在HttpServletResponse到達客戶端之前磕昼，攔截HttpServletResponse 卷雕。根據(jù)需要檢查HttpServletResponse，也可以修改HttpServletResponse頭和數(shù)據(jù)票从。

如何借助Filter實現(xiàn)攔截功能

Filter接口中有一個doFilter方法漫雕，當(dāng)開發(fā)人員編寫好Filter，并配置對哪個web資源進行攔截后纫骑，Web服務(wù)器每次在調(diào)用web資源的service方法之前蝎亚，都會先調(diào)用一下filter的doFilter方法，因此先馆，在該方法內(nèi)編寫代碼可達到如下目的：

調(diào)用目標(biāo)資源之前发框，讓一段代碼執(zhí)行。
是否調(diào)用目標(biāo)資源（即是否讓用戶訪問web資源）煤墙。
web服務(wù)器在調(diào)用doFilter方法時梅惯，會傳遞一個filterChain對象進來，filterChain對象是filter接口中最重要的一個對象仿野，它也提供了一個doFilter方法铣减，開發(fā)人員可以根據(jù)需求決定是否調(diào)用此方法，調(diào)用該方法脚作，則web服務(wù)器就會調(diào)用web資源的service方法葫哗，即web資源就會被訪問，否則web資源不會被訪問球涛。

Filter開發(fā)兩步走

編寫java類實現(xiàn)Filter接口劣针，并實現(xiàn)其doFilter方法。
在web.xml文件中對編寫的filter類進行注冊亿扁，并設(shè)置它所能攔截的資源捺典。

web.xml配置各節(jié)點介紹：

<filter>指定一個過濾器。
<filter-name>用于為過濾器指定一個名字从祝，該元素的內(nèi)容不能為空襟己。
<filter-class>元素用于指定過濾器的完整的限定類名。
<init-param>元素用于為過濾器指定初始化參數(shù)牍陌，它的子元素<param-name>指定參數(shù)的名字擎浴，<param-value>指定參數(shù)的值。
在過濾器中毒涧，可以使用FilterConfig接口對象來訪問初始化參數(shù)贮预。
<filter-mapping>元素用于設(shè)置一個 Filter 所負(fù)責(zé)攔截的資源。一個Filter攔截的資源可通過兩種方式來指定：Servlet 名稱和資源訪問的請求路徑
<filter-name>子元素用于設(shè)置filter的注冊名稱。該值必須是在<filter>元素中聲明過的過濾器的名字
<url-pattern>設(shè)置 filter 所攔截的請求路徑(過濾器關(guān)聯(lián)的URL樣式)
<servlet-name>指定過濾器所攔截的Servlet名稱萌狂。
<dispatcher>指定過濾器所攔截的資源被 Servlet 容器調(diào)用的方式，可以是REQUEST,INCLUDE,FORWARD和ERROR之一怀泊，默認(rèn)REQUEST茫藏。用戶可以設(shè)置多個<dispatcher>子元素用來指定 Filter 對資源的多種調(diào)用方式進行攔截。
<dispatcher>子元素可以設(shè)置的值及其意義
REQUEST：當(dāng)用戶直接訪問頁面時霹琼，Web容器將會調(diào)用過濾器务傲。如果目標(biāo)資源是通過RequestDispatcher的include()或forward()方法訪問時，那么該過濾器就不會被調(diào)用枣申。
INCLUDE：如果目標(biāo)資源是通過RequestDispatcher的include()方法訪問時售葡，那么該過濾器將被調(diào)用。除此之外忠藤，該過濾器不會被調(diào)用挟伙。
FORWARD：如果目標(biāo)資源是通過RequestDispatcher的forward()方法訪問時，那么該過濾器將被調(diào)用模孩，除此之外尖阔，該過濾器不會被調(diào)用。
ERROR：如果目標(biāo)資源是通過聲明式異常處理機制調(diào)用時榨咐，那么該過濾器將被調(diào)用介却。除此之外，過濾器不會被調(diào)用块茁。

Filter鏈

在一個web應(yīng)用中齿坷，可以開發(fā)編寫多個Filter，這些Filter組合起來稱之為一個Filter鏈数焊。

web服務(wù)器根據(jù)Filter在web.xml文件中的注冊順序永淌，決定先調(diào)用哪個Filter，當(dāng)?shù)谝粋€Filter的doFilter方法被調(diào)用時昌跌，web服務(wù)器會創(chuàng)建一個代表Filter鏈的FilterChain對象傳遞給該方法仰禀。在doFilter方法中，開發(fā)人員如果調(diào)用了FilterChain對象的doFilter方法蚕愤，則web服務(wù)器會檢查FilterChain對象中是否還有filter答恶，如果有，則調(diào)用第2個filter萍诱，如果沒有悬嗓，則調(diào)用目標(biāo)資源。

Filter的生命周期

public void init(FilterConfig filterConfig) throws ServletException;//初始化
和我們編寫的Servlet程序一樣裕坊，F(xiàn)ilter的創(chuàng)建和銷毀由WEB服務(wù)器負(fù)責(zé)包竹。 web 應(yīng)用程序啟動時，web 服務(wù)器將創(chuàng)建Filter 的實例對象，并調(diào)用其init方法周瞎，讀取web.xml配置苗缩，完成對象的初始化功能，從而為后續(xù)的用戶請求作好攔截的準(zhǔn)備工作（filter對象只會創(chuàng)建一次声诸，init方法也只會執(zhí)行一次）酱讶。開發(fā)人員通過init方法的參數(shù)，可獲得代表當(dāng)前filter配置信息的FilterConfig對象彼乌。

public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException;//攔截請求
這個方法完成實際的過濾操作泻肯。當(dāng)客戶請求訪問與過濾器關(guān)聯(lián)的URL的時候，Servlet過濾器將先執(zhí)行doFilter方法慰照。FilterChain參數(shù)用于訪問后續(xù)過濾器灶挟。

public void destroy();//銷毀
Filter對象創(chuàng)建后會駐留在內(nèi)存，當(dāng)web應(yīng)用移除或服務(wù)器停止時才銷毀毒租。在Web容器卸載 Filter 對象之前被調(diào)用稚铣。該方法在Filter的生命周期中僅執(zhí)行一次。在這個方法中墅垮，可以釋放過濾器使用的資源榛泛。

FilterConfig接口

用戶在配置filter時，可以使用為filter配置一些初始化參數(shù)噩斟，當(dāng)web容器實例化Filter對象曹锨，調(diào)用其init方法時，會把封裝了filter初始化參數(shù)的filterConfig對象傳遞進來剃允。因此開發(fā)人員在編寫filter時沛简，通過filterConfig對象的方法，就可獲得以下內(nèi)容：

String getFilterName();//得到filter的名稱斥废。 
String getInitParameter(String name);//返回在部署描述中指定名稱的初始化參數(shù)的值椒楣。如果不存在返回null. 
Enumeration getInitParameterNames();//返回過濾器的所有初始化參數(shù)的名字的枚舉集合。 
public ServletContext getServletContext();//返回Servlet上下文對象的引用牡肉。

Filter使用案例

使用Filter驗證用戶登錄安全控制

前段時間參與維護一個項目捧灰，用戶退出系統(tǒng)后，再去地址欄訪問歷史统锤，根據(jù)url毛俏，仍然能夠進入系統(tǒng)響應(yīng)頁面。我去檢查一下發(fā)現(xiàn)對請求未進行過濾驗證用戶登錄饲窿。添加一個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><!-- 只對指定過濾參數(shù)后綴進行過濾 -->
        <param-value>.do;.jsp</param-value>
    </init-param>
    <init-param>
        <param-name>redirectPath</param-name><!-- 未通過跳轉(zhuǎn)到登錄界面 -->
        <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;

/**
 *    判斷用戶是否登錄,未登錄則退出系統(tǒng)
 */
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");    // 過濾資源后綴參數(shù)
        String redirectPath = hrequest.getContextPath() + config.getInitParameter("redirectPath");// 沒有登陸轉(zhuǎn)向頁面
        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)) {// 只對指定過濾參數(shù)后綴進行過濾
            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;
    }
}

這樣既可完成對用戶所有請求，均要經(jīng)過這個Filter進行驗證用戶登錄逾雄。

防止中文亂碼過濾器

項目使用spring框架時腻脏。當(dāng)前臺JSP頁面和Java代碼中使用了不同的字符集進行編碼的時候就會出現(xiàn)表單提交的數(shù)據(jù)或者上傳/下載中文名稱文件出現(xiàn)亂碼的問題，那就可以使用這個過濾器银锻。

<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>

歡迎加入學(xué)習(xí)交流群569772982，大家一起學(xué)習(xí)交流帖池。