java過濾器Filter筆記

阿新 • • 發佈：2018-02-24

意義執行 cut rup 過濾器 sch www 內容 map

一、Filter簡介

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

public abstract interface Filter{  
　　//初始化
    public abstract void init(FilterConfig paramFilterConfig) throws ServletException; 
　　//執行 
    public abstract void doFilter(ServletRequest paramServletRequest, ServletResponse paramServletResponse, FilterChain   
        paramFilterChain) throws IOException, ServletException; 
　　//銷毀 
     
public abstract void destroy();  
}

二、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開發步驟
Filter開發分為2步：
* 編寫java類實現Filter接口，並實現其doFilter方法。
* 在web.xml 文件中使用<filter>和<filter-mapping>元素對編寫的filter類進行註冊，並設置它所能攔截的資源。

Filter範例：

package 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 FliterWW implements Filter {

    public void destroy() {
        System.out.println("----Filter銷毀----"); 
    }

    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain filterChain) throws IOException, ServletException {
        // 對request、response進行一些預處理  
        request.setCharacterEncoding("UTF-8");  
        response.setCharacterEncoding("UTF-8");  
        response.setContentType("text/html;charset=UTF-8");  
        System.out.println("----調用service之前執行一段代碼----");  
        filterChain.doFilter(request, response); // 執行目標資源，放行  
        System.out.println("----調用service之後執行一段代碼----");  
    }

    public void init(FilterConfig arg0) throws ServletException {
         System.out.println("----Filter初始化----");
    }

}

web.xml配置

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.5" 
    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_2_5.xsd">
  <display-name></display-name>    
  <welcome-file-list>
    <welcome-file>index.jsp</welcome-file>
  </welcome-file-list>
  
  <!-- 配置過濾器 -->
  <filter>
          <filter-name>FilterWW</filter-name>
          <filter-class>filter.FilterWW</filter-class>
  </filter>
  
  <!-- 映射過濾器 -->
  <filter-mapping>
          <filter-name>FilterWW</filter-name>
          <!-- 配置需要攔截url請求路徑 -->

          <!-- 攔截所有請求路徑 -->

　　　　　　<url-pattern>/*</url-pattern>
　　</filter-mapping> 
</web-app>

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

四，Spring框架下，過濾器的配置
如果項目中使用了Spring框架，那麽，很多過濾器都不用自己來寫了，Spring為我們寫好了一些常用的過濾器。下面我們就以字符編碼的
過濾器CharacterEncodingFilter為例，來看一下Spring框架下，如果配置過濾器。

web.xml配置

<filter>  
    <filter-name>encodingFilter</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>  
        <param-value>true</param-value>  
    </init-param>  
</filter>  
  
<filter-mapping>  
    <filter-name>encodingFilter</filter-name>  
    <url-pattern>/*</url-pattern>  
</filter-mapping>

CharacterEncodingFilter的關鍵源碼

package org.springframework.web.filter;  
import java.io.IOException;  
import javax.servlet.FilterChain;  
import javax.servlet.ServletException;  
import javax.servlet.http.HttpServletRequest;  
import javax.servlet.http.HttpServletResponse;  
import org.springframework.util.ClassUtils;  
public class CharacterEncodingFilter extends OncePerRequestFilter{  
    private static final boolean responseSetCharacterEncodingAvailable = ClassUtils.hasMethod(  
        class$javax$servlet$http$HttpServletResponse, "setCharacterEncoding", new Class[] { String.class });  
    // 需要設置的編碼方式，為了支持可配置，Spring把編碼方式設置成了一個變量  
    private String encoding;  
    // 是否強制使用統一編碼，也是為了支持可配置  
    private boolean forceEncoding;  
    // 構造器，在這裏，Spring把forceEncoding的值默認設置成了false  
    public CharacterEncodingFilter(){  
        this.forceEncoding = false;  
    }  
    // encoding/forceEncoding的setter方法  
    public void setEncoding(String encoding){  
        this.encoding = encoding;  
    }  
    public void setForceEncoding(boolean forceEncoding){  
        this.forceEncoding = forceEncoding;  
    }  
    // Spring通過GenericFilterBean抽象類，對Filter接口進行了整合，  
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)  
        throws ServletException, IOException{  
        if ((this.encoding != null) && (((this.forceEncoding) || (request.getCharacterEncoding() == null)))) {  
            request.setCharacterEncoding(this.encoding);  
            if ((this.forceEncoding) && (responseSetCharacterEncodingAvailable)) {  
                response.setCharacterEncoding(this.encoding);  
            }  
        }  
        filterChain.doFilter(request, response);  
    }  
}

按照spring源碼照著寫一個過濾器。

自己動手寫一個過濾器：FilterWW（防止腳本攻擊的過濾器）

package filter;

import java.io.IOException;
import java.util.Enumeration;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.RequestDispatcher;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;


public class FliterWW implements Filter {
    
    private static String[] invalidCharacter = new String[]{  
        "script","select","insert","document","window","function",  
        "delete","update","prompt","alert","create","alter",  
        "drop","iframe","link","where","replace","function","onabort",  
        "onactivate","onafterprint","onafterupdate","onbeforeactivate",  
        "onbeforecopy","onbeforecut","onbeforedeactivateonfocus",  
        "onkeydown","onkeypress","onkeyup","onload",  
        "expression","applet","layer","ilayeditfocus","onbeforepaste",  
        "onbeforeprint","onbeforeunload","onbeforeupdate",  
        "onblur","onbounce","oncellchange","oncontextmenu",  
        "oncontrolselect","oncopy","oncut","ondataavailable",  
        "ondatasetchanged","ondatasetcomplete","ondeactivate",  
        "ondrag","ondrop","onerror","onfilterchange","onfinish","onhelp",  
        "onlayoutcomplete","onlosecapture","onmouse","ote",  
        "onpropertychange","onreadystatechange","onreset","onresize",  
        "onresizeend","onresizestart","onrow","onscroll",  
        "onselect","onstaronsubmit","onunload","IMgsrc","infarction"  
    };  
    
    private boolean isAble; 
    
    public FliterWW() {
        isAble = false;
    }
    
    //isAble的setter方法  
    public void setIsAble(boolean isAble){  
        this.isAble = isAble;  
    }

    public void destroy() {
        System.out.println("----Filter銷毀----"); 
    }

    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain filterChain) throws IOException, ServletException {
        String parameterName = null;  
        String parameterValue = null;  
        // 獲取請求的參數  
        @SuppressWarnings("unchecked") 
        Enumeration<String> allParameter = request.getParameterNames();
        //遍歷所有參數
        if(isAble) {
            while(allParameter.hasMoreElements()){  
                parameterName = allParameter.nextElement();  
                parameterValue = request.getParameter(parameterName);  
                if(null != parameterValue){  
                    for(String stri : invalidCharacter){  
                        //判斷是否含有非法字符
                        if (StringUtils.containsIgnoreCase(parameterValue, stri)){  
                            request.setAttribute("errorMessage", "非法字符：" + stri);  
                            //轉發地址
                            RequestDispatcher requestDispatcher = request.getRequestDispatcher("/error.jsp");  
                            requestDispatcher.forward(request, response);  
                            return;  
                        }  
                    }  
                }  
            }  
        }
        doFilter(request, response, filterChain);  
    }

    public void init(FilterConfig arg0) throws ServletException {
         System.out.println("----Filter初始化----");
    }

}

View Code

web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.5" 
    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_2_5.xsd">
  <display-name></display-name>    
  <welcome-file-list>
    <welcome-file>index.jsp</welcome-file>
  </welcome-file-list>
  
  <!-- 配置過濾器 -->
  <filter>
          <filter-name>FilterWW</filter-name>
          <filter-class>filter.FilterWW</filter-class>
          <init-param>
              <param-name>isAble</param-name>
              <param-value>true</param-value>
          </init-param>
  </filter>
  
  <!-- 映射過濾器 -->
  <filter-mapping>
          <filter-name>FilterWW</filter-name>
          <!-- 配置需要攔截url請求路徑 -->
          <url-pattern>/*</url-pattern>
          <!-- 攔截所有請求路徑 -->
  </filter-mapping>
  
</web-app>

View Code

五、Filter的生命周期

5.1、Filter的創建
　　Filter的創建和銷毀由web服務器負責。 web應用程序啟動時，web服務器將創建Filter的實例對象，並調用其init方法，完成對象的初始化
功能，從而為後續的用戶請求作好攔截的準備工作，filter對象只會創建一次，init方法也只會執行一次。通過init方法的參數，可獲得代表當前
filter配置信息的FilterConfig對象

5.2、Filter的銷毀
　　web容器調用destroy方法銷毀Filter。destroy方法在Filter的生命周期中僅執行一次。在destroy方法中，可以釋放過濾器使用的資源。

5.3、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配置信息

public void init(FilterConfig filterConfig) throws ServletException {
         System.out.println("----Filter初始化----");
         
        /*<!-- 配置過濾器 -->
          <filter>
              <filter-name>FilterWW</filter-name>
              <filter-class>filter.FilterWW</filter-class>
              <init-param>
                  <param-name>isAble</param-name>
                  <param-value>true</param-value>
              </init-param>
          </filter>*/
         
             //得到過濾器的名字  
            String filterName = filterConfig.getFilterName();  
            //得到在web.xml文件中配置的初始化參數  
            String isAble = filterConfig.getInitParameter("isAble");  
            //返回過濾器的所有初始化參數的名字的枚舉集合。  
            Enumeration<String> initParameterNames = filterConfig.getInitParameterNames();  
              
            System.out.println(filterName);  
            System.out.println(isAble);
            setIsAble(Boolean.parseBoolean(isAble));
            while (initParameterNames.hasMoreElements()) {  
                String paramName = (String) initParameterNames.nextElement();  
                System.out.println(paramName);  
            }  
    }

六、Filter的部署時的一些參數的含義

Filter的部署分為兩個步驟：
　　1、註冊Filter
　　2、映射Filter

6.1、註冊Filter
　　開發好Filter之後，需要在web.xml文件中進行註冊，這樣才能夠被web服務器調用。在web.xml文件中註冊Filter範例：

<filter>  
    <description>過濾器名稱</description>  
    <filter-name>自定義的名字</filter-name>  
    <filter-class>com.yangcq.filter.FilterTest</filter-class>  
    <!--配置FilterTest過濾器的初始化參數-->  
    <init-param>  
        <description>配置過濾器的初始化參數</description>  
        <param-name>name</param-name>  
        <param-value>gacl</param-value>  
    </init-param>  
    <init-param>  
        <description>配置FilterTest過濾器的初始化參數</description>  
        <param-name>like</param-name>  
        <param-value>java</param-value>  
    </init-param>  
</filter>

<description>用於添加描述信息，該元素的內容可為空，<description>可以不配置。
　　<filter-name>用於為過濾器指定一個名字，該元素的內容不能為空。
　　<filter-class>元素用於指定過濾器的完整的限定類名。
　　<init-param>元素用於為過濾器指定初始化參數，它的子元素<param-name>指定參數的名字，<param-value>指定參數的值。在過濾器中，
可以使用FilterConfig接口對象來訪問初始化參數。如果過濾器不需要指定初始化參數，那麽<init-param>元素可以不配置。

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

<filter-mapping>
<filter-name>FilterTest</filter-name>

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

<filter-mapping>
<filter-name>testFilter</filter-name>
<url-pattern>/index.jsp</url-pattern>
<dispatcher>REQUEST</dispatcher>
<dispatcher>FORWARD</dispatcher>
</filter-mapping>

　<dispatcher> 子元素可以設置的值及其意義：
REQUEST：當用戶直接訪問頁面時，Web容器將會調用過濾器。如果目標資源是通過RequestDispatcher的include()或forward()方法訪問
時，那麽該過濾器就不會被調用。
INCLUDE：如果目標資源是通過RequestDispatcher的include()方法訪問時，那麽該過濾器將被調用。除此之外，該過濾器不會被調用。
FORWARD：如果目標資源是通過RequestDispatcher的forward()方法訪問時，那麽該過濾器將被調用，除此之外，該過濾器不會被調用。
ERROR：如果目標資源是通過聲明式異常處理機制調用時，那麽該過濾器將被調用。除此之外，過濾器不會被調用。

java過濾器Filter筆記

意義執行 cut rup 過濾器 sch www 內容 map 一、Filter簡介　　Filter也稱之為過濾器，它是Servlet技術中最激動人心的技術之一，WEB開發人員通過Filter技術，對web服務器管理的所有web資源：例如Jsp,Servlet, 靜態圖片

java過濾器Filter筆記

java過濾器Filter筆記

Java過濾器Filter的原理及配置_學習筆記

Java過濾器Filter使用詳解（轉載自別人的文章，感覺很不錯，適合我這樣的小白）

java 過濾器(Filter)

Java過濾器Filter詳解

防止常見XSS 過濾 SQL注入 JAVA過濾器filter

java 過濾器Filter中chain.doFilter()之前和之後程式碼的執行順序

java過濾器——filter的使用和配置

淺談java過濾器Filter<最通俗易懂的講解>

Java Web 學習筆記之十四：RestEasy新增Filter過濾器預處理請求

【Servlet】Java Servet Filter 過濾器

java過濾器（Filter和ChainFilter鏈）你了解嗎？(有詳細代碼)

java開發以太坊過濾器(filter)和智能合約事件(event)

Java技術學習筆記：過濾器鏈的實現方法、配置和案例分析

java中的過濾器 --Filter

Java 三大器之過濾器Filter

Java Servlet 實戰入門教程-10-servlet 過濾器 Filter

java中Filter過濾器處理中文亂碼的方法

Java過濾器（Filter）的工作原理和程式碼演示

java過濾器（filter）一

java過濾器Filter筆記

相關推薦