Java Web Filter 過濾器學(xué)習(xí)教程(推薦)
一、Filter簡(jiǎn)介
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是如何實(shí)現(xiàn)攔截的?
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á)到如下目的:
1.調(diào)用目標(biāo)資源之前,讓一段代碼執(zhí)行。
2.是否調(diào)用目標(biāo)資源(即是否讓用戶訪問web資源)。
3.調(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ì)被訪問。
三、Filter開發(fā)入門
3.1、Filter開發(fā)步驟
Filter開發(fā)分為二個(gè)步驟:
1.編寫java類實(shí)現(xiàn)Filter接口,并實(shí)現(xiàn)其doFilter方法。
2.在 web.xml 文件中使用<filter>和<filter-mapping>元素對(duì)編寫的filter類進(jìn)行注冊(cè),并設(shè)置它所能攔截的資源。
過濾器范例:
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: FilterDemo * @Description:filter的三種典型應(yīng)用: * 、可以在filter中根據(jù)條件決定是否調(diào)用chain.doFilter(request, response)方法, * 即是否讓目標(biāo)資源執(zhí)行 * 、在讓目標(biāo)資源執(zhí)行之前,可以對(duì)request\response作預(yù)處理,再讓目標(biāo)資源執(zhí)行 * 、在目標(biāo)資源執(zhí)行之后,可以捕獲目標(biāo)資源的執(zhí)行結(jié)果,從而實(shí)現(xiàn)一些特殊的功能 * @author: 孤傲蒼狼 * @date: -- 下午:: */ public class FilterDemo 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 { //對(duì)request和response進(jìn)行一些預(yù)處理 request.setCharacterEncoding("UTF-"); response.setCharacterEncoding("UTF-"); response.setContentType("text/html;charset=UTF-"); System.out.println("FilterDemo執(zhí)行前?。?!"); chain.doFilter(request, response); //讓目標(biāo)資源執(zhí)行,放行 System.out.println("FilterDemo執(zhí)行后?。。?); } @Override public void destroy() { System.out.println("----過濾器銷毀----"); } }
在web. xml中配置過濾器:
<?xml version="." encoding="UTF-"?> <web-app version="." xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w.org//XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app__.xsd"> <display-name></display-name> <welcome-file-list> <welcome-file>index.jsp</welcome-file> </welcome-file-list> <!--配置過濾器--> <filter> <filter-name>FilterDemo</filter-name> <filter-class>me.gacl.web.filter.FilterDemo</filter-class> </filter> <!--映射過濾器--> <filter-mapping> <filter-name>FilterDemo</filter-name> <!--“/*”表示攔截所有的請(qǐng)求 --> <url-pattern>/*</url-pattern> </filter-mapping> </web-app>
3.2、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)資源。
四、Filter的生命周期
4.1、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ì)象。
4.2、Filter的銷毀
Web容器調(diào)用destroy方法銷毀Filter。destroy方法在Filter的生命周期中僅執(zhí)行一次。在destroy方法中,可以釋放過濾器使用的資源。
4.3、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 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 FilterDemo implements Filter { /* 過濾器初始化 * @see javax.servlet.Filter#init(javax.servlet.FilterConfig) */ @Override public void init(FilterConfig filterConfig) throws ServletException { System.out.println("----過濾器初始化----"); /** * <filter> <filter-name>FilterDemo</filter-name> <filter-class>me.gacl.web.filter.FilterDemo</filter-class> <!--配置FilterDemo過濾器的初始化參數(shù)--> <init-param> <description>配置FilterDemo過濾器的初始化參數(shù)</description> <param-name>name</param-name> <param-value>gacl</param-value> </init-param> <init-param> <description>配置FilterDemo過濾器的初始化參數(shù)</description> <param-name>like</param-name> <param-value>java</param-value> </init-param> </filter> <filter-mapping> <filter-name>FilterDemo</filter-name> <!--“/*”表示攔截所有的請(qǐng)求 --> <url-pattern>/*</url-pattern> </filter-mapping> */ //得到過濾器的名字 String filterName = filterConfig.getFilterName(); //得到在web.xml文件中配置的初始化參數(shù) String initParam = filterConfig.getInitParameter("name"); String initParam = filterConfig.getInitParameter("like"); //返回過濾器的所有初始化參數(shù)的名字的枚舉集合。 Enumeration<String> initParameterNames = filterConfig.getInitParameterNames(); System.out.println(filterName); System.out.println(initParam); System.out.println(initParam); 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("FilterDemo執(zhí)行前?。?!"); chain.doFilter(request, response); //讓目標(biāo)資源執(zhí)行,放行 System.out.println("FilterDemo執(zhí)行后!?。?); } @Override public void destroy() { System.out.println("----過濾器銷毀----"); } }
五、Filter的部署
Filter的部署分為兩個(gè)步驟:
1、注冊(cè)Filter
2、映射Filter
5.1、注冊(cè)Filter
開發(fā)好Filter之后,需要在web.xml文件中進(jìn)行注冊(cè),這樣才能夠被web服務(wù)器調(diào)用
在web.xml文件中注冊(cè)Filter范例:
<filter> <description>FilterDemo過濾器</description> <filter-name>FilterDemo</filter-name> <filter-class>me.gacl.web.filter.FilterDemo</filter-class> <!--配置FilterDemo過濾器的初始化參數(shù)--> <init-param> <description>配置FilterDemo過濾器的初始化參數(shù)</description> <param-name>name</param-name> <param-value>gacl</param-value> </init-param> <init-param> <description>配置FilterDemo過濾器的初始化參數(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>元素用于指定過濾器的完整的限定類名。
<init-param>元素用于為過濾器指定初始化參數(shù),它的子元素<param-name>指定參數(shù)的名字,<param-value>指定參數(shù)的值。在過濾器中,可以使用FilterConfig接口對(duì)象來訪問初始化參數(shù)。如果過濾器不需要指定初始化參數(shù),那么<init-param>元素可以不配置。
5.2、映射Filter
在web.xml文件中注冊(cè)了Filter之后,還要在web.xml文件中映射Filter
<!--映射過濾器--> <filter-mapping> <filter-name>FilterDemo</filter-name> <!--“/*”表示攔截所有的請(qǐng)求 --> <url-pattern>/*</url-pattern> </filter-mapping>
<filter-mapping>元素用于設(shè)置一個(gè) Filter 所負(fù)責(zé)攔截的資源。一個(gè)Filter攔截的資源可通過兩種方式來指定:Servlet 名稱和資源訪問的請(qǐng)求路徑
<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,FORWARD和ERROR之一,默認(rèn)REQUEST。用戶可以設(shè)置多個(gè)<dispatcher> 子元素用來指定
Filter 對(duì)資源的多種調(diào)用方式進(jìn)行攔截。如下:
<filter-mapping> <filter-name>testFilter</filter-name> <url-pattern>/index.jsp</url-pattern> <dispatcher>REQUEST</dispatcher> <dispatcher>FORWARD</dispatcher> </filter-mapping>
<dispatcher> 子元素可以設(shè)置的值及其意義:
1.REQUEST:當(dāng)用戶直接訪問頁(yè)面時(shí),Web容器將會(huì)調(diào)用過濾器。如果目標(biāo)資源是通過RequestDispatcher的include()或forward()方法訪問時(shí),那么該過濾器就不會(huì)被調(diào)用。
2.INCLUDE:如果目標(biāo)資源是通過RequestDispatcher的include()方法訪問時(shí),那么該過濾器將被調(diào)用。除此之外,該過濾器不會(huì)被調(diào)用。
3.FORWARD:如果目標(biāo)資源是通過RequestDispatcher的forward()方法訪問時(shí),那么該過濾器將被調(diào)用,除此之外,該過濾器不會(huì)被調(diào)用。
4.ERROR:如果目標(biāo)資源是通過聲明式異常處理機(jī)制調(diào)用時(shí),那么該過濾器將被調(diào)用。除此之外,過濾器不會(huì)被調(diào)用。
相關(guān)文章
Jenkins自動(dòng)化部署springboot代碼實(shí)例
這篇文章主要介紹了Jenkins自動(dòng)化部署springboot代碼實(shí)例,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-04-04SpringBoot 動(dòng)態(tài)配置Profile環(huán)境的方式
這篇文章主要介紹了SpringBoot 動(dòng)態(tài)配置Profile環(huán)境的方式,本文通過圖文實(shí)例相結(jié)合給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2021-10-10SpringBoot統(tǒng)一返回處理出現(xiàn)cannot?be?cast?to?java.lang.String異常解決
這篇文章主要給大家介紹了關(guān)于SpringBoot統(tǒng)一返回處理出現(xiàn)cannot?be?cast?to?java.lang.String異常解決的相關(guān)資料,文中通過圖文介紹的非常詳細(xì),需要的朋友可以參考下2023-09-09java+selenium實(shí)現(xiàn)滑塊驗(yàn)證
現(xiàn)在越來越多的網(wǎng)站都使用采用滑塊驗(yàn)證來作為驗(yàn)證機(jī)制,用于判斷用戶是否為人類而不是機(jī)器人,本文就將利用java和selenium實(shí)現(xiàn)滑塊驗(yàn)證,希望對(duì)大家有所幫助2023-12-12用java生成html文件實(shí)現(xiàn)原理及代碼
用printStream來向html文件里輸出數(shù)據(jù),先創(chuàng)建一個(gè)StringBuilder對(duì)象,通過append方法來為其添加html語句,具體實(shí)現(xiàn)如下,感興趣的朋友可以參考下,希望對(duì)大家有所幫助2013-08-08