Filter的執行順序及實例

2019-11-15 00:20:55

字體：大中小

來源：轉載

供稿：網友

Filter的執行順序及實例

學習中的收藏，該文出自http://m.survivalescaperooms.com/Fskjb/archive/2010/03/27/1698448.html

　　在此，非常感謝該文章作者的分享，本文完全轉載自上面鏈接，此處作為備份，方便查看使用。

Filter介紹

Filter可認為是Servlet的一種“變種”，它主要用于對用戶請求進行預處理，也可以對HttpServletResponse進行后處理，是個典型的處理鏈。它與Servlet的區別在于：它不能直接向用戶生成響應。完整的流程是：Filter對用戶請求進行預處理，接著將請求交給Servlet進行處理并生成響應，最后Filter再對服務器響應進行后處理。

Filter有如下幾個用處。

在HttpServletRequest到達Servlet之前，攔截客戶的HttpServletRequest。
根據需要檢查HttpServletRequest，也可以修改HttpServletRequest頭和數據。
在HttpServletResponse到達客戶端之前，攔截HttpServletResponse。
根據需要檢查HttpServletResponse，也可以修改HttpServletResponse頭和數據。

Filter有如下幾個種類。

用戶授權的Filter：Filter負責檢查用戶請求，根據請求過濾用戶非法請求。
日志Filter：詳細記錄某些特殊的用戶請求。
負責解碼的Filter：包括對非標準編碼的請求解碼。
能改變xml內容的XSLT Filter等。
Filter可負責攔截多個請求或響應；一個請求或響應也可被多個請求攔截。

創建一個Filter只需兩個步驟：

建Filter處理類；
web.xml文件中配置Filter。

下面先介紹一個簡單的記錄日志的Filter，這個Filter負責攔截所有的用戶請求，并將請求的信息記錄在日志中。

代碼publicclassLogFilterimplementsFilter{//FilterConfig可用于訪問Filter的配置信息

上面程序實現了doFilter()方法，實現該方法就可實現對用戶請求進行預處理，也可實現對服務器響應進行后處理——它們的分界線為是否調用了chain.doFilter()，執行該方法之前，即對用戶請求進行預處理；執行該方法之后，即對服務器響應進行后處理。

在上面的請求Filter中，僅在日志中記錄請求的URL，對所有的請求都執行chain.doFilter (request,reponse)方法，當Filter對請求過濾后，依然將請求發送到目的地址。如果需要檢查權限，可以在Filter中根據用戶請求的Http session，判斷用戶權限是否足夠。如果權限不夠，直接調用重定向即可，無須調用chain.doFilter(request,reponse)方法。

代碼

==================FirstFilter.java==================packagecom.test.filter;importjava.io.IOException;importjavax.servlet.Filter;importjavax.servlet.FilterChain;importjavax.servlet.FilterConfig;importjavax.servlet.ServletException;importjavax.servlet.ServletRequest;importjavax.servlet.ServletResponse;publicclassFirstFilterimplementsFilter{@Overridepublicvoiddestroy(){}@OverridepublicvoiddoFilter(ServletRequestrequest,ServletResponseresponse,FilterChainchain)throwsIOException,ServletException{System.out.println("beforeinvokefirstFilter'schain.doFilter()..");chain.doFilter(request,response);System.out.println("afterinvokefirstFilter'schain.doFilter()..");}@Overridepublicvoidinit(FilterConfigarg0)throwsServletException{System.out.println("firstFilterinit()...");}}============SecondFilter.java=============packagecom.test.filter;importjava.io.IOException;importjavax.servlet.Filter;importjavax.servlet.FilterChain;importjavax.servlet.FilterConfig;importjavax.servlet.ServletException;importjavax.servlet.ServletRequest;importjavax.servlet.ServletResponse;publicclassSecondFilterimplementsFilter{@Overridepublicvoiddestroy(){}@OverridepublicvoiddoFilter(ServletRequestrequest,ServletResponseresponse,FilterChainchain)throwsIOException,ServletException{System.out.println("beforeinvokesecondFilter'schain.doFilter()..");chain.doFilter(request,response);System.out.println("afterinvokesecondFilter'schain.doFilter()..");}@Overridepublicvoidinit(FilterConfigfilterConfig)throwsServletException{System.out.println("secondFilterinit()...");}}==========FirstServlet.java==========packagecom.test.servlet;importjava.io.IOException;importjavax.servlet.ServletException;importjavax.servlet.http.HttpServlet;importjavax.servlet.http.HttpServletRequest;importjavax.servlet.http.HttpServletResponse;publicclassFirstServletextendsHttpServlet{@OverrideprotectedvoiddoGet(HttpServletRequestreq,HttpServletResponseresp)throwsServletException,IOException{System.out.println("servletdoGetbeinvoked...");req.getRequestDispatcher("test.jsp").forward(req,resp);}@OverrideprotectedvoiddoPost(HttpServletRequestreq,HttpServletResponseresp)throwsServletException,IOException{//TODOAuto-generatedmethodstubdoGet(req,resp);}} 復制代碼

web.xml

代碼<?xmlversion="1.0"encoding="UTF-8"?><web-appversion="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/javaeehttp://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"><welcome-file-list><welcome-file>index.jsp</welcome-file></welcome-file-list><filter><filter-name>firstFilter</filter-name><filter-class>com.test.filter.FirstFilter</filter-class></filter><filter><filter-name>secondFilter</filter-name><filter-class>com.test.filter.SecondFilter</filter-class></filter><filter-mapping><filter-name>secondFilter</filter-name><url-pattern>/*</url-pattern></filter-mapping><filter-mapping><filter-name>firstFilter</filter-name><url-pattern>/*</url-pattern></filter-mapping><servlet><servlet-name>firstServlet</servlet-name><servlet-class>com.alimama.servlet.FirstServlet</servlet-class></servlet><servlet-mapping><servlet-name>firstServlet</servlet-name><url-pattern>/firstServlet</url-pattern></servlet-mapping></web-app> 復制代碼

然后發布，發現打印的日志如下：

。。。

firstFilter init()...secondFilter init()...

。。。信息: Server startup in 3665 ms

這里過濾器初始化好了。

當我們訪問我們的應用：http://127.0.0.1:8080/appName

發現打印日記如下：

before invoke secondFilter's chain.doFilter() ..before invoke firstFilter's chain.doFilter() ..after invoke firstFilter's chain.doFilter() ..after invoke secondFilter's chain.doFilter() ..

當我們將web.xml中filter的位置進行調整后（注意filter-mapping的順序）：

代碼<?xmlversion="1.0"encoding="UTF-8"?><web-appversion="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/javaeehttp://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"><welcome-file-list><welcome-file>index.jsp</welcome-file></welcome-file-list><filter><filter-name>firstFilter</filter-name><filter-class>com.test.filter.FirstFilter</filter-class></filter><filter><filter-name>secondFilter</filter-name><filter-class>com.test.filter.SecondFilter</filter-class></filter><SPANstyle="COLOR:#ff0000"><filter-mapping><filter-name>firstFilter</filter-name><url-pattern>/*</url-pattern></filter-mapping><filter-mapping><filter-name>secondFilter</filter-name><url-pattern>/*</url-pattern></filter-mapping></SPAN><servlet><servlet-name>firstServlet</servlet-name><servlet-class>com.alimama.servlet.FirstServlet</servlet-class></servlet><servlet-mapping><servlet-name>firstServlet</servlet-name><url-pattern>/firstServlet</url-pattern></servlet-mapping></web-app> 復制代碼

然后在啟動應用，會看到打印：

before invoke firstFilter's chain.doFilter() ..

before invoke secondFilter's chain.doFilter() ..after invoke secondFilter's chain.doFilter() ..

after invoke firstFilter's chain.doFilter() ..

下面是一個實例：

publicclassAuthorityFilterimplementsFilter{//FilterConfig可用于訪問Filter的配置信息privateFilterConfigconfig;//實現初始化方法publicvoidinit(FilterConfigconfig){this.config=config;}//實現銷毀方法publicvoiddestroy(){this.config=null;}//執行過濾的核心方法publicvoiddoFilter(ServletRequestrequest,ServletResponseresponse,FilterChainchain)throwsIOException,ServletException{//獲取該Filter的配置參數Stringencoding=config.getInitParameter("encoding");StringloginPage=config.getInitParameter("loginPage");StringproLogin=config.getInitParameter("proLogin");//設置request編碼用的字符集request.setCharacterEncoding(encoding);//①HttpServletRequestrequ=(HttpServletRequest)request;HttpSessionsession=requ.getSession(true);//獲取客戶請求的頁面StringrequestPath=requ.getServletPath();//如果session范圍的user為null，即表明沒有登錄//且用戶請求的既不是登錄頁面，也不是處理登錄的頁面if(session.getAttribute("user")==null&&!requestPath.endsWith(loginPage)&&!requestPath.endsWith(proLogin)){//forward到登錄頁面request.setAttribute("t

上面Filter的doFilter方法里3行斜體字代碼用于獲取Filter的配置參數，而程序中粗體字代碼則是此Filter的核心，①號代碼按配置參數設置了request編碼所用的字符集，接下來的粗體字代碼判斷session范圍內是否有user屬性——沒有該屬性即認為沒有登錄，如果既沒有登錄，而且請求地址也不是登錄頁和處理登錄頁，系統直接跳轉到登錄頁面。

在web.xml文件中配置該Filter，使用init-param元素為該Filter配置參數，init-param可接受如下兩個子元素：

param-name：指定參數名。

param-value：指定參數值。

該Filter的配置片段如下：

<filter><filter-name>authority</filter-name><filter-class>lee.AuthorityFilter</filter-class><init-param><param-name>encoding</param-name><param-value>GBK</param-value></init-param><init-param><param-name>loginPage</param-name><param-value>/login.jsp</param-value></init-param><init-param><param-name>proLogin</param-name><param-value>/proLogin.jsp</param-value></init-param></filter><filter-mapping><filter-name>authority</filter-name><url-pattern>/*</url-pattern></filter-mapping> 復制代碼

上面配置片段中粗體字代碼為該Filter指定了3個配置參數，指定loginPage為/login.jsp，proLogin為/proLogin.jsp，這表明：如果沒有登錄該應用，普通用戶只能訪問/login.jsp和/proLogin.jsp頁面。只有當用戶登錄該應用后才可自由訪問其他頁面。

實際上Filter和Servlet極其相似，區別只是Filter不能直接對用戶生成響應。實際上Filter里doFilter()方法里的代碼就是從多個Servlet的service()方法里抽取的通用代碼，通過使用Filter可以實現更好的復用。