javaweb學習總結——Filter(過濾器)學習

時間 2019-11-10

原文原文鏈接

1、Filter簡介

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

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

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

調用目標資源以前，讓一段代碼執行。web
是否調用目標資源（便是否讓用戶訪問web資源）。服務器
調用目標資源以後，讓一段代碼執行。app

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

3、Filter開發入門

3.一、Filter開發步驟

　　Filter開發分爲二個步驟：ide

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

　　過濾器範例：code

package me.gacl.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;

/**
* @ClassName: FilterDemo01
* @Description:filter的三種典型應用：
*                     一、能夠在filter中根據條件決定是否調用chain.doFilter(request, response)方法，
*                        便是否讓目標資源執行
*                     二、在讓目標資源執行以前，能夠對request\response做預處理，再讓目標資源執行
*                     三、在目標資源執行以後，能夠捕獲目標資源的執行結果，從而實現一些特殊的功能
* @author: 孤傲蒼狼
* @date: 2014-8-31 下午10:09:24
*/ 
public class FilterDemo01 implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("----過濾器初始化----");
    }

    @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("FilterDemo01執行前！！！");
        chain.doFilter(request, response);  //讓目標資源執行，放行
        System.out.println("FilterDemo01執行後！！！");
    }

    @Override
    public void destroy() {
        System.out.println("----過濾器銷燬----");
    }
}

　　在web. xml中配置過濾器：

 <?xml version="1.0" encoding="UTF-8"?>
<web-app version="3.0" 
    xmlns="http://java.sun.com/xml/ns/javaee" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
    http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">
  <display-name></display-name>    
  <welcome-file-list>
    <welcome-file>index.jsp</welcome-file>
  </welcome-file-list>
  
  <!--配置過濾器-->
  <filter>
      <filter-name>FilterDemo01</filter-name>
      <filter-class>me.gacl.web.filter.FilterDemo01</filter-class>
  </filter>
  
  <!--映射過濾器-->
  <filter-mapping>
      <filter-name>FilterDemo01</filter-name>
      <!--「/*」表示攔截全部的請求 -->
      <url-pattern>/*</url-pattern>
  </filter-mapping>
  
</web-app>

3.二、Filter鏈

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

4、Filter的生命週期

4.一、Filter的建立

　　Filter的建立和銷燬由WEB服務器負責。 web 應用程序啓動時，web 服務器將建立Filter 的實例對象，並調用其init方法，完成對象的初始化功能，從而爲後續的用戶請求做好攔截的準備工做，filter對象只會建立一次，init方法也只會執行一次。經過init方法的參數，可得到表明當前filter配置信息的FilterConfig對象。

4.二、Filter的銷燬

　　Web容器調用destroy方法銷燬Filter。destroy方法在Filter的生命週期中僅執行一次。在destroy方法中，能夠釋放過濾器使用的資源。

4.三、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上下文對象的引用。
範例：利用FilterConfig獲得filter配置信息

package me.gacl.web.filter;

import java.io.IOException;
import java.util.Enumeration;
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 FilterDemo02 implements Filter {

    /* 過濾器初始化
     * @see javax.servlet.Filter#init(javax.servlet.FilterConfig)
     */
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("----過濾器初始化----");
        /**
         *  <filter>
                  <filter-name>FilterDemo02</filter-name>
                  <filter-class>me.gacl.web.filter.FilterDemo02</filter-class>
                  <!--配置FilterDemo02過濾器的初始化參數-->
                  <init-param>
                      <description>配置FilterDemo02過濾器的初始化參數</description>
                      <param-name>name</param-name>
                      <param-value>gacl</param-value>
                  </init-param>
                  <init-param>
                      <description>配置FilterDemo02過濾器的初始化參數</description>
                      <param-name>like</param-name>
                      <param-value>java</param-value>
                  </init-param>
            </filter>
            
             <filter-mapping>
                  <filter-name>FilterDemo02</filter-name>
                  <!--「/*」表示攔截全部的請求 -->
                  <url-pattern>/*</url-pattern>
             </filter-mapping>
         */
        //獲得過濾器的名字
        String filterName = filterConfig.getFilterName();
        //獲得在web.xml文件中配置的初始化參數
        String initParam1 = filterConfig.getInitParameter("name");
        String initParam2 = filterConfig.getInitParameter("like");
        //返回過濾器的全部初始化參數的名字的枚舉集合。
        Enumeration<String> initParameterNames = filterConfig.getInitParameterNames();
        
        System.out.println(filterName);
        System.out.println(initParam1);
        System.out.println(initParam2);
        while (initParameterNames.hasMoreElements()) {
            String paramName = (String) initParameterNames.nextElement();
            System.out.println(paramName);
        }
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {
        System.out.println("FilterDemo02執行前！！！");
        chain.doFilter(request, response);  //讓目標資源執行，放行
        System.out.println("FilterDemo02執行後！！！");
    }

    @Override
    public void destroy() {
        System.out.println("----過濾器銷燬----");
    }
}

　　<description>用於添加描述信息，該元素的內容可爲空，<description>能夠不配置。

　　<filter-name>用於爲過濾器指定一個名字，該元素的內容不能爲空。
　　<filter-class>元素用於指定過濾器的完整的限定類名。
　　<init-param>元素用於爲過濾器指定初始化參數，它的子元素<param-name>指定參數的名字，<param-value>指定參數的值。在過濾器中，可使用FilterConfig接口對象來訪問初始化參數。若是過濾器不須要指定初始化參數，那麼<init-param>元素能夠不配置。

5.二、映射Filter

　　在web.xml文件中註冊了Filter以後，還要在web.xml文件中映射Filter

1  <!--映射過濾器-->
2   <filter-mapping>
3       <filter-name>FilterDemo02</filter-name>
4       <!--「/*」表示攔截全部的請求 -->
5       <url-pattern>/*</url-pattern>
6   </filter-mapping>

　　<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 對資源的多種調用方式進行攔截。以下：

1 <filter-mapping>
2 <filter-name>testFilter</filter-name>
3 <url-pattern>/index.jsp</url-pattern>
4 <dispatcher>REQUEST</dispatcher>
5 <dispatcher>FORWARD</dispatcher>
6 </filter-mapping>

　　<dispatcher> 子元素能夠設置的值及其意義：

REQUEST：當用戶直接訪問頁面時，Web容器將會調用過濾器。若是目標資源是經過RequestDispatcher的include()或forward()方法訪問時，那麼該過濾器就不會被調用。
INCLUDE：若是目標資源是經過RequestDispatcher的include()方法訪問時，那麼該過濾器將被調用。除此以外，該過濾器不會被調用。
FORWARD：若是目標資源是經過RequestDispatcher的forward()方法訪問時，那麼該過濾器將被調用，除此以外，該過濾器不會被調用。
ERROR：若是目標資源是經過聲明式異常處理機制調用時，那麼該過濾器將被調用。除此以外，過濾器不會被調用。