Java中的Filter過濾器

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 應用程序啓動時，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>