JavaWeb-三大器之過濾器

概述

Filter也稱之為過濾器,它是Servlet技術(shù)中最激動(dòng)人心的技術(shù)之一。
WEB開發(fā)人員通過Filter技術(shù),對(duì)web服務(wù)器管理的所有web資源。
例如:

  • Jsp、Servlet、靜態(tài)圖片文件或靜態(tài)html文件等進(jìn)行攔截,從而實(shí)現(xiàn)一些特殊的功能。
  • 實(shí)現(xiàn)URL級(jí)別的權(quán)限訪問控制、過濾敏感詞匯、壓縮響應(yīng)信息等一些高級(jí)功能。

Servlet API中提供了一個(gè)Filter接口,開發(fā)web應(yīng)用時(shí),如果編寫的Java類實(shí)現(xiàn)了這個(gè)接口,則把這個(gè)java類稱之為過濾器Filter。
通過Filter技術(shù),開發(fā)人員可以實(shí)現(xiàn)用戶在訪問某個(gè)目標(biāo)資源之前,對(duì)訪問的請(qǐng)求和響應(yīng)進(jìn)行攔截。
Filter接口源代碼:

package javax.servlet;

import java.io.IOException;

public interface Filter {
    default void init(FilterConfig filterConfig) throws ServletException {
    }

    void doFilter(ServletRequest var1, ServletResponse var2, FilterChain var3) throws IOException, ServletException;

    default void destroy() {
    }
}

Filter的工作原理

Filter接口中有一個(gè)doFilter方法,當(dāng)我們編寫好Filter,并配置對(duì)哪個(gè)web資源進(jìn)行攔截后,WEB服務(wù)器每次在調(diào)用web資源的service方法之前,
都會(huì)先調(diào)用一下filter的doFilter方法,因此,在該方法內(nèi)編寫代碼可達(dá)到如下目的:

  • 調(diào)用目標(biāo)資源之前,讓一段代碼執(zhí)行。
  • 是否調(diào)用目標(biāo)資源(即是否讓用戶訪問web資源)。
  • 調(diào)用目標(biāo)資源之后,讓一段代碼執(zhí)行。

web服務(wù)器在調(diào)用doFilter方法時(shí),會(huì)傳遞一個(gè)filterChain對(duì)象進(jìn)來,filterChain對(duì)象是filter接口中最重要的一個(gè)對(duì)象,它也提供了一個(gè)doFilter方法,開發(fā)人員可以根據(jù)需求決定是否調(diào)用此方法,調(diào)用該方法,則web服務(wù)器就會(huì)調(diào)用web資源的service方法,即web資源就會(huì)被訪問,否則web資源不會(huì)被訪問,同時(shí)后續(xù)的Filter鏈也不會(huì)被執(zhí)行。

Filter開發(fā)流程

  • 編寫java類實(shí)現(xiàn)Filter接口,并實(shí)現(xiàn)其doFilter方法。
  • 在web.xml 文件中使用<filter>和<filter-mapping>元素對(duì)編寫的filter類進(jìn)行注冊(cè),并設(shè)置它所能攔截的資源。

例如:

package com.tp.filter;

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 java.io.IOException;

/**
 * FileName: CharacterEncodingFilter
 * Author:   TP
 * Description:全局亂碼處理過濾器
 */
public class CharacterEncodingFilter implements Filter {

    private FilterConfig filterConfig = null;
    //設(shè)置默認(rèn)的字符編碼
    private String defaultCharset = "UTF-8";

    public void init(FilterConfig filterConfig) throws ServletException {
        //得到過濾器的初始化配置信息
        System.out.println("字符過濾器初始化");
        this.filterConfig = filterConfig;
    }

    public void doFilter(ServletRequest req, ServletResponse resp,
                         FilterChain chain) throws IOException, ServletException {

        HttpServletRequest request = (HttpServletRequest) req;
        HttpServletResponse response = (HttpServletResponse) resp;
        String charset = filterConfig.getInitParameter("charset");
        if(charset==null){
            charset = defaultCharset;
        }
        request.setCharacterEncoding(charset);
        response.setCharacterEncoding(charset);
        response.setContentType("text/html;charset="+charset);
        System.out.println("----調(diào)用service之前執(zhí)行一段代碼----");
        chain.doFilter(request, response);
        System.out.println("----調(diào)用service之后執(zhí)行一段代碼----");
    }

    public void destroy() {
        System.out.println("字符過濾器被銷毀");
    }
}

在web. xml中配置過濾器:

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">

    <!--全局解決中文亂碼-->
    <filter>
        <filter-name>CharacterEncodingFilter</filter-name>
        <filter-class>com.tp.filter.CharacterEncodingFilter</filter-class>
        <init-param>
            <param-name>charset</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
    </filter>

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

啟動(dòng)項(xiàng)目,訪問http://localhost:8080/,觀察控制臺(tái)輸出:

停止項(xiàng)目,觀察控制臺(tái)輸出:

Filter鏈

在一個(gè)web應(yīng)用中,可以開發(fā)編寫多個(gè)Filter,這些Filter組合起來稱之為一個(gè)Filter鏈。
web服務(wù)器根據(jù)Filter在web.xml文件中的注冊(cè)順序,決定先調(diào)用哪個(gè)Filter,當(dāng)?shù)谝粋€(gè)Filter的doFilter方法被調(diào)用時(shí),web服務(wù)器會(huì)創(chuàng)建一個(gè)代表Filter鏈的FilterChain對(duì)象傳遞給該方法。在doFilter方法中,開發(fā)人員如果調(diào)用了FilterChain對(duì)象的doFilter方法,則web服務(wù)器會(huì)檢查FilterChain對(duì)象中是否還有filter,如果有,則調(diào)用第2個(gè)filter,如果沒有,則調(diào)用目標(biāo)資源。

Spring框架下,過濾器的配置

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

<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.java如下:

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;

public class CharacterEncodingFilter extends OncePerRequestFilter {
    private String encoding;
    private boolean forceEncoding = false;

    public CharacterEncodingFilter() {
    }

    public void setEncoding(String encoding) {
        this.encoding = encoding;
    }

    public void setForceEncoding(boolean forceEncoding) {
        this.forceEncoding = forceEncoding;
    }

    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) {
                response.setCharacterEncoding(this.encoding);
            }
        }

        filterChain.doFilter(request, response);
    }
}

又例如防止腳本攻擊的過濾器:

import java.io.IOException;  
import java.util.Enumeration;  
import javax.servlet.FilterChain;  
import javax.servlet.RequestDispatcher;  
import javax.servlet.ServletException;  
import javax.servlet.http.HttpServletRequest;  
import javax.servlet.http.HttpServletResponse;  
import org.apache.commons.lang.StringUtils;  
import org.springframework.web.filter.CharacterEncodingFilter;  
/* 
 * InvalidCharacterFilter:過濾request請(qǐng)求中的非法字符,防止腳本攻擊 
 * InvalidCharacterFilter繼承了Spring框架的CharacterEncodingFilter過濾器,當(dāng)然,我們也可以自己實(shí)現(xiàn)這樣一個(gè)過濾器 
 */  
public class InvalidCharacterFilter extends CharacterEncodingFilter{  
    // 需要過濾的非法字符  
    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"  
    };  
  
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)  
            throws ServletException, IOException{     
        String parameterName = null;  
        String parameterValue = null;  
        // 獲取請(qǐng)求的參數(shù)  
        @SuppressWarnings("unchecked")  
        Enumeration<String> allParameter = request.getParameterNames();  
        while(allParameter.hasMoreElements()){  
            parameterName = allParameter.nextElement();  
            parameterValue = request.getParameter(parameterName);  
            if(null != parameterValue){  
                for(String str : invalidCharacter){  
                    if (StringUtils.containsIgnoreCase(parameterValue, str)){  
                        request.setAttribute("errorMessage", "非法字符:" + str);  
                        RequestDispatcher requestDispatcher = request.getRequestDispatcher("/error.jsp");  
                        requestDispatcher.forward(request, response);  
                        return;  
                    }  
                }  
            }  
        }  
        super.doFilterInternal(request, response, filterChain);  
    }  
}  

接下來需要在web.xml中進(jìn)行配置:

<filter>  
    <filter-name>InvalidCharacterFilter</filter-name>  
    <filter-class>com.yangcq.filter.InvalidCharacterFilter</filter-class>  
</filter>  
<filter-mapping>  
    <filter-name>InvalidCharacterFilter</filter-name>  
    <url-pattern>/*</url-pattern>  
</filter-mapping>  

Filter的生命周期

  • Filter的創(chuàng)建
    Filter的創(chuàng)建和銷毀由web服務(wù)器負(fù)責(zé)。 web應(yīng)用程序啟動(dòng)時(shí),web服務(wù)器將創(chuàng)建Filter的實(shí)例對(duì)象,并調(diào)用其init方法,完成對(duì)象的初始化
    功能,從而為后續(xù)的用戶請(qǐng)求作好攔截的準(zhǔn)備工作,filter對(duì)象只會(huì)創(chuàng)建一次,init方法也只會(huì)執(zhí)行一次。通過init方法的參數(shù),可獲得代表當(dāng)前
    filter配置信息的FilterConfig對(duì)象。
  • Filter的銷毀
    web容器調(diào)用destroy方法銷毀Filter。destroy方法在Filter的生命周期中僅執(zhí)行一次。在destroy方法中,可以釋放過濾器使用的資源。

FilterConfig接口

用戶在配置filter時(shí),可以使用<init-param>為filter配置一些初始化參數(shù),當(dāng)web容器實(shí)例化Filter對(duì)象,調(diào)用其init方法時(shí),會(huì)把封裝了filter初始化參數(shù)的filterConfig對(duì)象傳遞進(jìn)來。
因此開發(fā)人員在編寫filter時(shí),通過filterConfig對(duì)象的方法,就可獲得:

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

示例:利用FilterConfig得到filter配置信息

package com.yangcq.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 FilterTest implements Filter {  
  
    /* 過濾器初始化 
     * @see javax.servlet.Filter#init(javax.servlet.FilterConfig) 
     */  
    @Override  
    public void init(FilterConfig filterConfig) throws ServletException {  
        System.out.println("----過濾器初始化----");  
        /** 
         *  <filter> 
                  <filter-name>FilterTest</filter-name> 
                  <filter-class>com.yangcq.filter.FilterTest</filter-class> 
                  <!--配置FilterTest過濾器的初始化參數(shù)--> 
                  <init-param> 
                      <description>FilterTest</description> 
                      <param-name>name</param-name> 
                      <param-value>gacl</param-value> 
                  </init-param> 
                  <init-param> 
                      <description>配置FilterTest過濾器的初始化參數(shù)</description> 
                      <param-name>like</param-name> 
                      <param-value>java</param-value> 
                  </init-param> 
            </filter> 
             
             <filter-mapping> 
                  <filter-name>FilterDemo02</filter-name> 
                  <!--“/*”表示攔截所有的請(qǐng)求 --> 
                  <url-pattern>/*</url-pattern> 
             </filter-mapping> 
         */  
        //得到過濾器的名字  
        String filterName = filterConfig.getFilterName();  
        //得到在web.xml文件中配置的初始化參數(shù)  
        String initParam1 = filterConfig.getInitParameter("name");  
        String initParam2 = filterConfig.getInitParameter("like");  
        //返回過濾器的所有初始化參數(shù)的名字的枚舉集合。  
        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執(zhí)行前!??!");  
        chain.doFilter(request, response);  //讓目標(biāo)資源執(zhí)行,放行  
        System.out.println("FilterDemo02執(zhí)行后!!!");  
    }  
  
    @Override  
    public void destroy() {  
        System.out.println("----過濾器銷毀----");  
    }  
}  

部署filter

Filter的部署分為兩個(gè)步驟:

  • 注冊(cè)Filter
  • 映射Filter
注冊(cè)Filter

開發(fā)好Filter之后,需要在web.xml文件中進(jìn)行注冊(cè),這樣才能夠被web服務(wù)器調(diào)用。
在web.xml文件中注冊(cè)Filter范例:

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

其中:

  • <description>用于添加描述信息
    該元素的內(nèi)容可為空,<description>可以不配置。
  • <filter-name>用于為過濾器指定一個(gè)名字
    該元素的內(nèi)容不能為空。
  • <filter-class>元素用于指定過濾器的完整的限定類名
    該元素的內(nèi)容不能為空。
  • <init-param>元素用于為過濾器指定初始化參數(shù)
    它的子元素<param-name>指定參數(shù)的名字,<param-value>指定參數(shù)的值。
    在過濾器中,可以使用FilterConfig接口對(duì)象來訪問初始化參數(shù)。
    如果過濾器不需要指定初始化參數(shù),那么<init-param>元素可以不配置。
映射Filter

在web.xml文件中注冊(cè)了Filter之后,還要在web.xml文件中映射Filter:

<!--映射過濾器-->
  <filter-mapping>
      <filter-name>FilterTest</filter-name>
      <!--“/*”表示攔截所有的請(qǐng)求 -->
      <url-pattern>/*</url-pattern>
  </filter-mapping>

其中:

  • <filter-name>子元素用于設(shè)置filter的注冊(cè)名稱。
    該值必須是在<filter>元素中聲明過的過濾器的名字
  • <url-pattern>設(shè)置filter所攔截的請(qǐng)求路徑(過濾器關(guān)聯(lián)的URL樣式)
  • <servlet-name>指定過濾器所攔截的Servlet名稱。
  • <dispatcher>指定過濾器所攔截的資源被 Servlet 容器調(diào)用的方式。
    可以是REQUEST,INCLUDE,F(xiàn)ORWARD和ERROR之一(默認(rèn)REQUEST)
    用戶可以設(shè)置多個(gè),例如:
<filter-mapping>
    <filter-name>testFilter</filter-name>
    <url-pattern>/index.jsp</url-pattern>
    <dispatcher>REQUEST</dispatcher>
    <dispatcher>FORWARD</dispatcher>
</filter-mapping>

<dispatcher> 子元素可以設(shè)置的值及其意義:

  • REQUEST:
    當(dāng)用戶直接訪問頁面時(shí),Web容器將會(huì)調(diào)用過濾器。
    如果目標(biāo)資源是通過RequestDispatcher的include()或forward()方法訪問時(shí),那么該過濾器就不會(huì)被調(diào)用。
  • INCLUDE:
    如果目標(biāo)資源是通過RequestDispatcher的include()方法訪問時(shí),那么該過濾器將被調(diào)用。
    除此之外,該過濾器不會(huì)被調(diào)用。
  • FORWARD:
    如果目標(biāo)資源是通過RequestDispatcher的forward()方法訪問時(shí),那么該過濾器將被調(diào)用。
    除此之外,該過濾器不會(huì)被調(diào)用。
  • ERROR:
    如果目標(biāo)資源是通過聲明式異常處理機(jī)制調(diào)用時(shí),那么該過濾器將被調(diào)用。
    除此之外,過濾器不會(huì)被調(diào)用。
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容