一、簡介

• Filter也稱為過濾器，它是Servlet技術中最激動人心的技術，web開發人員通過Filter技術，對web服務器管理的所有web資源：例如JSP，Servlet，靜態圖片文件或靜態html文件等進行攔截，從而實現一些特殊的功能。例如實現URL級別的權限訪問控制、過濾敏感詞匯、壓縮響應信息等一些高級功能。

• ServletAPI中提供了一個Filter接口，開發web應用時，如果編寫的java類實現了這個接口，則把這個java類稱之為過濾器Filter。通過Filter技術，開發人員可以實現用于在訪問某個目標資源之前，對訪問的請求和響應進行攔截。

二、Filter是如何實現攔截的

• Filter接口中有一個doFilter方法，當開發人員編寫好Filter，并配置對哪個web資源進行攔截后，web服務器每次在調用web資源的service方法之前，都會先調用一下Filter的doFilter方法，因此，在該方法內編寫代碼可達到如下目的：
  • 調用目標資源之前，讓一段代碼執行
  • 是否調用目標資源（即是否讓用戶訪問web資源）。Web服務器在調用doFilter方法時，會傳遞一個filterChain對象進來，filterChain對象是filter接口中最重要的一個對象，它也提供了一個doFilter方法，開發人員可以根據需求決定是否調用此方法，調用該方法，則web服務器就會調用web資源的service方法，即web資源就會被訪問，否則web資源不會被訪問。
  • 調用目標資源之后，讓一段代碼執行

三、 filter開發入門

3.1 filter開發分為兩個步驟

• 編寫java類實現filter接口，并實現其doFilter方法。

• 在web.xml文件中使用<filter>和<filter-mapping>元素對編寫的filter類進行注冊，并設置它所能攔截的資源。

3.2 filter鏈

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

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

3.3 示例（工程day18）

FilterDemo1.java

package cn.itcast.web.filter;
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;

public class FilterDemo1 implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {
        //對request和response進行一些預處理
        /*request.setCharacterEncoding("UTF-8");
        response.setCharacterEncoding("UTF-8");
        response.setContentType("text/html;charset=UTF-8");*/
        
        System.out.println("filter 執行前");
        
        chain.doFilter(request, response);//讓目標資源執行，或者叫放行
        
        System.out.println("filter 執行后");
        
    }

    @Override
    public void init(FilterConfig arg0) throws ServletException {
    }
    
    @Override
    public void destroy() {
    }
}

說明：

• 1.filter的三種典型應用：

  • 可以在filter中根據條件決定是否調用chain.doFilter(request, response)方法，即是否防目標資源執行；
  • 在讓目標資源執行之前，可以對request和response做一些預處理，如上面預先設置好編碼方式，再讓目標資源執行；
  • 在目標資源執行之后，可以捕獲目標資源的執行結果，從而實現一些特殊的功能。

• 2.目標資源執行之后我們還可以執行其后的代碼，比如數據庫操作提交、取出目標資源的執行結果進行處理（如壓縮）。注意：FilterChain就是很多個filter組成的一個鏈。

在web.xml文件中對過濾器進行配置

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://xmlns.jcp.org/xml/ns/javaee"
    xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
    id="WebApp_ID" version="3.1">
    <display-name>day18</display-name>

    <filter>
        <filter-name>FilterDemo1</filter-name>
        <filter-class>cn.itcast.web.filter.FilterDemo1</filter-class>
    </filter>

    <filter-mapping>
        <filter-name>FilterDemo1</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

    <welcome-file-list>
        <welcome-file>index.jsp</welcome-file>
    </welcome-file-list>
</web-app>

說明：

• 1.過濾器復合dtd2.3規范，但是不符合dtd2.2及以下的規范
• 2.配置的過程中多個<filter>要放在一起，多個<filter-mapping>要放在一起，不能交叉放置；
• 3.對于過濾器我們需要直接先建class文件，然后繼承javax.servlet中的filter接口。

3.4 filter的聲明周期

• init(FilterConfig filterConfig)throws ServletException
  和我們編寫的Servlet程序一樣，Filter的創建和銷毀由web服務器負責。Web應用程序啟動時，web服務器將創建filter的實例對象，并調用其init方法，完成對象的初始化功能，從而為后續的用戶請求做好攔截的準備工作（注：filter對象只會創建一次，init方法也只會執行一次）

• 開發人員通過init方法的參數，可獲得代表當前filter配置信息的FilterConfig對象。

• destory()
  在web容器卸載Filter對象之前被調用。該方法在filter的聲明周期中僅執行一次。在這個方法中，可以釋放過濾器使用的資源。

3.5 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上
  下文對象的引用。

示例
FilterDemo3.java

package cn.itcast.web.filter;
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;

public class FilterDemo3 implements Filter {

    private FilterConfig config = null;//用于記住初始化參數
    
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("filter創建了！！");
        this.config = filterConfig;

    }
    
    public void destroy() {
        System.out.println("filter銷毀了！！");
    }

    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {
        
        //獲取配置的初始化參數
        System.out.println(this.config.getInitParameter("xxx"));
    }
}

配置web.xml

   <filter>
    <filter-name>FilterDemo3</filter-name>
    <filter-class>cn.itcast.web.filter.FilterDemo3</filter-class>
    <init-param>
        <param-name>xxx</param-name>
        <param-value>yyy</param-value>
    </init-param>
    
  </filter>
  
  <filter-mapping>
    <filter-name>FilterDemo3</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>

說明：如上，我們就可以獲得一些初始化參數值。