Java Web -- Filter過濾器

　　Filter也稱之爲過濾器，它是Servlet技術中最激動人心的技術，WEB開發人員經過Filter技術，對web服務器管理的全部web資源：例如Jsp, Servlet, 靜態圖片文件或靜態 html 文件等進行攔截，從而實現一些特殊的功能。例如實現設置統一字符集，實現URL級別的權限訪問控制、過濾敏感詞彙、壓縮響應信息等一些高級功能。
　　Servlet API中提供了一個Filter接口，開發web應用時，若是編寫的Java類實現了這個接口，則把這個java類稱之爲過濾器Filter。經過Filter技術，開發人員能夠實現用戶在訪問某個目標資源以前，對訪問的請求和響應進行攔截，以下所示：

　　

2、Filter是如何實現攔截的？

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

1. 調用目標資源以前，讓一段代碼執行。
2. 是否調用目標資源（便是否讓用戶訪問web資源）。
3. 調用目標資源以後，讓一段代碼執行。

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

3、Filter開發入門

3.一、Filter開發步驟

　　Filter開發分爲二個步驟：

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

3.二、Filter鏈

　　在一個web應用中，能夠開發編寫多個Filter，這些Filter組合起來稱之爲一個Filter鏈。
　　web服務器根據Filter在web.xml文件中的註冊順序，決定先調用哪一個Filter，當第一個Filter的doFilter方法被調用時，web服務器會建立一個表明Filter鏈的FilterChain對象傳遞給該方法。在doFilter方法中，開發人員若是調用了FilterChain對象的doFilter方法，則web服務器會檢查FilterChain對象中是否還有filter，若是有，則調用第2個filter，若是沒有，則調用目標資源。

3.三、Filter示例

示例1：利用Filter設置統一字符集

public class CharacterEncodingFilter implements Filter {

    //編碼類型
    private String encoding = "UTF-8";
    
    //強制設置編碼，若是爲真，則同時設置response的encoding
    private boolean forceEncoding = false;
    
    @Override
    public void destroy() {

    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, 
            FilterChain filterChain) throws IOException, ServletException {
        
        if (this.encoding != null && 
                (this.forceEncoding || request.getCharacterEncoding() == null)) {
            
            request.setCharacterEncoding(this.encoding);
            if (this.forceEncoding) {
                response.setCharacterEncoding(this.encoding);
            }
            
        }
        filterChain.doFilter(request, response);
    }

    @Override
    public void init(FilterConfig config) throws ServletException {
        String encoding = config.getInitParameter("encoding");
        String forceEncoding = config.getInitParameter("forceEncoding");
        
        if( encoding != null && encoding.length() > 0 ){
            this.encoding = encoding;
        }
        if( forceEncoding!=null && "true".equals(forceEncoding)){
            this.forceEncoding = true;
        }
    }

}

 

註冊filter

<description>用於添加描述信息，該元素的內容可爲空，<description>能夠不配置。
<filter-name>用於爲過濾器指定一個名字，該元素的內容不能爲空。
<filter-class>元素用於指定過濾器的完整的限定類名。
<init-param>元素用於爲過濾器指定初始化參數，它的子元素<param-name>指定參數的名字，<param-value>指定參數的值。

在過濾器中，可使用FilterConfig接口對象來訪問初始化參數。若是過濾器不須要指定初始化參數，那麼<init-param>元素能夠不配置。

 

 

  <!-- Character Encoding Filter -->
  <filter>
        <filter-name>encodingFilter</filter-name>
        <filter-class>com.hand.jeb.core.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>
            <param-value>true</param-value>
        </init-param>
  </filter>

映射filter

<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-mapping>
    <filter-name>encodingFilter</filter-name>
    <!-- '/*'表示攔截全部請求 -->
    <url-pattern>/*</url-pattern>
</filter-mapping>

 

過濾前：

 

過濾後：