Filter 過濾器

阿新 • • 發佈：2017-07-31

family false 默認數據路徑 sco 決定不同壓縮

Filter 過濾器

原文鏈接：http://tianweili.github.io/blog/2015/01/26/java-filter/

1、簡介

　　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頭和數據。

2、如何實現攔截

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

調用目標資源之前，讓一段代碼執行。
是否調用目標資源（即是否讓用戶訪問web資源）。

　　web服務器在調用doFilter方法時，會傳遞一個filterChain對象進來，filterChain對象是filter接口中最重要的一個對象，它也提供了一個doFilter方法，開發人員可以根據需求決定是否調用此方法，調用該方法，則web服務器就會調用web資源的service方法，即web資源就會被訪問，否則web資源不會被訪問。

3、Filter開發兩步走

編寫java類實現Filter接口，並實現其doFilter方法。
在 web.xml 文件中使用<filter>和<filter-mapping>元素對編寫的filter類進行註冊，並設置它所能攔截的資源。

　　web.xml配置各節點介紹：

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

4、Filter鏈

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

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

5、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的生命周期中僅執行一次。在這個方法中，可以釋放過濾器使用的資源。

6、FilterConfig接口

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

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

7、Filter使用案例

　　1、使用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進行驗證用戶登錄。

　　2、防止中文亂碼過濾器

　　項目使用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>

　　3、Spring+Hibernate的OpenSessionInViewFilter控制session的開關

　　當hibernate+spring配合使用的時候，如果設置了lazy=true（延遲加載）,那麽在讀取數據的時候，當讀取了父數據後，hibernate 會自動關閉session，這樣，當要使用與之關聯數據、子數據的時候，系統會拋出lazyinit的錯誤，這時就需要使用spring提供的OpenSessionInViewFilter過濾器。

　　OpenSessionInViewFilter主要是保持Session狀態直到request將全部頁面發送到客戶端，直到請求結束後才關閉session，這樣就可以解決延遲加載帶來的問題。

　　註意：OpenSessionInViewFilter配置要寫在struts2的配置前面。因為tomcat容器在加載過濾器的時候是按照順序加載的，如果配置文件先寫的是struts2的過濾器配置，然後才是OpenSessionInViewFilter過濾器配置，所以加載的順序導致，action在獲得數據的時候session並沒有被spring管理。

<!-- lazy loading enabled in spring -->
<filter>
    <filter-name>OpenSessionInViewFilter</filter-name>
    <filter-class>org.springframework.orm.hibernate3.support.OpenSessionInViewFilter</filter-class>
    <init-param>
        <param-name>sessionFactoryBeanName</param-name><!-- 可缺省。默認是從spring容器中找id為sessionFactory的bean，如果id不為sessionFactory，則需要配置如下，此處SessionFactory為spring容器中的bean。 -->
        <param-value>sessionFactory</param-value>
    </init-param>
    <init-param>
        <param-name>singleSession</param-name><!-- singleSession默認為true,若設為false則等於沒用OpenSessionInView -->
        <param-value>true</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>OpenSessionInViewFilter</filter-name>
    <url-pattern>*.do</url-pattern>
</filter-mapping>

　　4、Struts2的web.xml配置

　　項目中使用Struts2同樣需要在web.xml配置過濾器，用來截取請求，轉到Struts2的Action進行處理。

　　註意：如果在2.1.3以前的Struts2版本，過濾器使用org.apache.struts2.dispatcher.FilterDispatcher。否則使用org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter。從Struts2.1.3開始，將廢棄ActionContextCleanUp過濾器，而在StrutsPrepareAndExecuteFilter過濾器中包含相應的功能。

　　三個初始化參數配置：

config參數：指定要加載的配置文件。逗號分割。
actionPackages參數：指定Action類所在的包空間。逗號分割。
configProviders參數：自定義配置文件提供者，需要實現ConfigurationProvider接口類。逗號分割。

<!-- struts 2.x filter -->
<filter>
    <filter-name>struts2</filter-name>
    <filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>struts2</filter-name>
    <url-pattern>*.do</url-pattern>
</filter-mapping>

Filter 過濾器

Filter 過濾器

SSH2——filter過濾器

Filter過濾器

【Servlet】Java Servet Filter 過濾器

Filter 過濾器

Filter過濾器，xml配置與頁面不亂碼整理

javaweb的Filter過濾器設置全站編碼

Java中的Filter過濾器

Web.xml中Filter過濾器標簽幾個說明

Java Web學習總結（12）Filter過濾器

Filter過濾器(Servlet)

通過filter過濾器進行中文處理

Django(filter過濾器)

Filter過濾器與Session會話跟蹤技術

python 高階函數:filter(過濾器)

使用moment.js結合filter過濾器格式化時間

Filter過濾器（自動登陸、通用的字符集編碼的過濾【處理不同請求的亂碼問題】、。。。）

HBase - Filter - 過濾器的介紹以及使用

django filter過濾器實現顯示某個型別指定欄位不同值

Filter過濾器使用

分享JavaWeb中filter過濾器的案例妙用 - 髒話過濾/編碼過濾/程式碼過濾

Filter 過濾器

相關推薦