Filter簡(jiǎn)介

Filter也稱之為過(guò)濾器，它是Servlet技術(shù)中最實(shí)用的技術(shù)，WEB開(kāi)發(fā)人員通過(guò)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)限訪問(wèn)控制、過(guò)濾敏感詞匯、壓縮響應(yīng)信息等一些高級(jí)功能。

它主要用于對(duì)用戶請(qǐng)求進(jìn)行預(yù)處理，也可以對(duì)HttpServletResponse 進(jìn)行后處理。使用Filter 的完整流程：Filter 對(duì)用戶請(qǐng)求進(jìn)行預(yù)處理，接著將請(qǐng)求交給Servlet 進(jìn)行處理并生成響應(yīng)，最后Filter 再對(duì)服務(wù)器響應(yīng)進(jìn)行后處理。

Filter功能

1.在HttpServletRequest 到達(dá) Servlet 之前，攔截客戶的 HttpServletRequest 。根據(jù)需要檢查 HttpServletRequest ，也可以修改HttpServletRequest 頭和數(shù)據(jù)。

2.在HttpServletResponse 到達(dá)客戶端之前，攔截HttpServletResponse 。根據(jù)需要檢查 HttpServletResponse ，也可以修改HttpServletResponse頭和數(shù)據(jù)。 

如何借助Filter實(shí)現(xiàn)攔截功能

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

1.調(diào)用目標(biāo)資源之前，讓一段代碼執(zhí)行。

2.是否調(diào)用目標(biāo)資源（即是否讓用戶訪問(wèn)web資源）。

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

Filter開(kāi)發(fā)兩步走

編寫(xiě)java類實(shí)現(xiàn)Filter接口，并實(shí)現(xiàn)其doFilter方法。
在 web.xml 文件中使用和元素對(duì)編寫(xiě)的filter類進(jìn)行注冊(cè)，并設(shè)置它所能攔截的資源。
web.xml配置各節(jié)點(diǎn)介紹：

1. <filter>指定一個(gè)過(guò)濾器。
2. <filter-name>用于為過(guò)濾器指定一個(gè)名字，該元素的內(nèi)容不能為空。
3. <filter-class>元素用于指定過(guò)濾器的完整的限定類名。
4. <init-param>元素用于為過(guò)濾器指定初始化參數(shù)，它的子元素<param-name>指定參數(shù)的名字，<param-value>指定參數(shù)的值。
5. 在過(guò)濾器中，可以使用FilterConfig接口對(duì)象來(lái)訪問(wèn)初始化參數(shù)。

<filter-mapping>元素用于設(shè)置一個(gè) Filter 所負(fù)責(zé)攔截的資源。一個(gè)Filter攔截的資源可通過(guò)兩種方式來(lái)指定：Servlet 名稱和資源訪問(wèn)的請(qǐng)求路徑

1. <filter-name>子元素用于設(shè)置filter的注冊(cè)名稱。該值必須是在<filter>元素中聲明過(guò)的過(guò)濾器的名字
2. <url-pattern>設(shè)置 filter 所攔截的請(qǐng)求路徑(過(guò)濾器關(guān)聯(lián)的URL樣式)

<servlet-name>指定過(guò)濾器所攔截的Servlet名稱。

<dispatcher>指定過(guò)濾器所攔截的資源被 Servlet 容器調(diào)用的方式，可以是REQUEST,INCLUDE,FORWARD和ERROR之一，默認(rèn)REQUEST。用戶可以設(shè)置多個(gè)<dispatcher>子元素用來(lái)指定 Filter 對(duì)資源的多種調(diào)用方式進(jìn)行攔截。

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

1. REQUEST：當(dāng)用戶直接訪問(wèn)頁(yè)面時(shí)，Web容器將會(huì)調(diào)用過(guò)濾器。如果目標(biāo)資源是通過(guò)RequestDispatcher的include()或forward()方法訪問(wèn)時(shí)，那么該過(guò)濾器就不會(huì)被調(diào)用。
2. INCLUDE：如果目標(biāo)資源是通過(guò)RequestDispatcher的include()方法訪問(wèn)時(shí)，那么該過(guò)濾器將被調(diào)用。除此之外，該過(guò)濾器不會(huì)被調(diào)用。
3. FORWARD：如果目標(biāo)資源是通過(guò)RequestDispatcher的forward()方法訪問(wèn)時(shí)，那么該過(guò)濾器將被調(diào)用，除此之外，該過(guò)濾器不會(huì)被調(diào)用。
4. ERROR：如果目標(biāo)資源是通過(guò)聲明式異常處理機(jī)制調(diào)用時(shí)，那么該過(guò)濾器將被調(diào)用。除此之外，過(guò)濾器不會(huì)被調(diào)用。

Filter鏈

在一個(gè)web應(yīng)用中，可以開(kāi)發(fā)編寫(xiě)多個(gè)Filter，這些Filter組合起來(lái)稱之為一個(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方法中，開(kāi)發(fā)人員如果調(diào)用了FilterChain對(duì)象的doFilter方法，則web服務(wù)器會(huì)檢查FilterChain對(duì)象中是否還有filter，如果有，則調(diào)用第2個(gè)filter，如果沒(méi)有，則調(diào)用目標(biāo)資源。

 Filter的生命周期

public void init(FilterConfig filterConfig) throws ServletException;//初始化

和我們編寫(xiě)的Servlet程序一樣，F(xiàn)ilter的創(chuàng)建和銷(xiāo)毀由WEB服務(wù)器負(fù)責(zé)。 web 應(yīng)用程序啟動(dòng)時(shí)，web 服務(wù)器將創(chuàng)建Filter 的實(shí)例對(duì)象，并調(diào)用其init方法，讀取web.xml配置，完成對(duì)象的初始化功能，從而為后續(xù)的用戶請(qǐng)求作好攔截的準(zhǔn)備工作（filter對(duì)象只會(huì)創(chuàng)建一次，init方法也只會(huì)執(zhí)行一次）。開(kāi)發(fā)人員通過(guò)init方法的參數(shù)，可獲得代表當(dāng)前filter配置信息的FilterConfig對(duì)象。

public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException;//攔截請(qǐng)求

這個(gè)方法完成實(shí)際的過(guò)濾操作。當(dāng)客戶請(qǐng)求訪問(wèn)與過(guò)濾器關(guān)聯(lián)的URL的時(shí)候，Servlet過(guò)濾器將先執(zhí)行doFilter方法。FilterChain參數(shù)用于訪問(wèn)后續(xù)過(guò)濾器。

public void destroy();//銷(xiāo)毀

Filter對(duì)象創(chuàng)建后會(huì)駐留在內(nèi)存，當(dāng)web應(yīng)用移除或服務(wù)器停止時(shí)才銷(xiāo)毀。在Web容器卸載 Filter 對(duì)象之前被調(diào)用。該方法在Filter的生命周期中僅執(zhí)行一次。在這個(gè)方法中，可以釋放過(guò)濾器使用的資源。

FilterConfig接口

用戶在配置filter時(shí)，可以使用為filter配置一些初始化參數(shù)，當(dāng)web容器實(shí)例化Filter對(duì)象，調(diào)用其init方法時(shí)，會(huì)把封裝了filter初始化參數(shù)的filterConfig對(duì)象傳遞進(jìn)來(lái)。因此開(kāi)發(fā)人員在編寫(xiě)filter時(shí)，通過(guò)filterConfig對(duì)象的方法，就可獲得以下內(nèi)容：

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

Filter使用案例

使用Filter驗(yàn)證用戶登錄安全控制

前段時(shí)間參與維護(hù)一個(gè)項(xiàng)目，用戶退出系統(tǒng)后，再去地址欄訪問(wèn)歷史，根據(jù)url，仍然能夠進(jìn)入系統(tǒng)響應(yīng)頁(yè)面。我去檢查一下發(fā)現(xiàn)對(duì)請(qǐng)求未進(jìn)行過(guò)濾驗(yàn)證用戶登錄。添加一個(gè)filter搞定問(wèn)題！

先在web.xml配置

<filter>
 <filter-name>SessionFilter</filter-name>
 <filter-class>com.action.login.SessionFilter</filter-class>
 <init-param>
  <param-name>logonStrings</param-name><!-- 對(duì)登錄頁(yè)面不進(jìn)行過(guò)濾 -->
  <param-value>/project/index.jsp;login.do</param-value>
 </init-param>
 <init-param>
  <param-name>includeStrings</param-name><!-- 只對(duì)指定過(guò)濾參數(shù)后綴進(jìn)行過(guò)濾 -->
  <param-value>.do;.jsp</param-value>
 </init-param>
 <init-param>
  <param-name>redirectPath</param-name><!-- 未通過(guò)跳轉(zhuǎn)到登錄界面 -->
  <param-value>/index.jsp</param-value>
 </init-param>
 <init-param>
  <param-name>disabletestfilter</param-name><!-- Y:過(guò)濾無(wú)效 -->
  <param-value>N</param-value><!-- http://www.manongjc.com/article/1613.html -->
 </init-param>
</filter>
<filter-mapping>
 <filter-name>SessionFilter</filter-name>
 <url-pattern>/*</url-pattern>
</filter-mapping>

接著編寫(xiě)FilterServlet.java：

package com.action.login;
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;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpServletResponseWrapper;
/**
 * 判斷用戶是否登錄,未登錄則退出系統(tǒng)
 * http://www.manongjc.com/article/1613.html 
 */
public class SessionFilter implements Filter {

 public FilterConfig config;

 public void destroy() {
  this.config = null;
 }

 public static boolean isContains(String container, String[] regx) {
  boolean result = false;
  for (int i = 0; i < regx.length; i++) {
   if (container.indexOf(regx[i]) != -1) {
    return true;
   }
  }
  return result;
 }
 public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
  HttpServletRequest hrequest = (HttpServletRequest)request;
  HttpServletResponseWrapper wrapper = new HttpServletResponseWrapper((HttpServletResponse) response);

  String logonStrings = config.getInitParameter("logonStrings");  // 登錄登陸頁(yè)面
  String includeStrings = config.getInitParameter("includeStrings"); // 過(guò)濾資源后綴參數(shù)
  String redirectPath = hrequest.getContextPath() + config.getInitParameter("redirectPath");// 沒(méi)有登陸轉(zhuǎn)向頁(yè)面
  String disabletestfilter = config.getInitParameter("disabletestfilter");// 過(guò)濾器是否有效

  if (disabletestfilter.toUpperCase().equals("Y")) { // 過(guò)濾無(wú)效
   chain.doFilter(request, response);
   return;
  }
  String[] logonList = logonStrings.split(";");
  String[] includeList = includeStrings.split(";");

  if (!this.isContains(hrequest.getRequestURI(), includeList)) {// 只對(duì)指定過(guò)濾參數(shù)后綴進(jìn)行過(guò)濾
   chain.doFilter(request, response);
   return;
  }

  if (this.isContains(hrequest.getRequestURI(), logonList)) {// 對(duì)登錄頁(yè)面不進(jìn)行過(guò)濾
   chain.doFilter(request, response);
   return;
  }

  String user = ( String ) hrequest.getSession().getAttribute("useronly");//判斷用戶是否登錄
  if (user == null) {
   wrapper.sendRedirect(redirectPath);
   return;
  }else {
   chain.doFilter(request, response);
   return;
  }
 }
 public void init(FilterConfig filterConfig) throws ServletException {
  config = filterConfig;
 }
}

這樣既可完成對(duì)用戶所有請(qǐng)求，均要經(jīng)過(guò)這個(gè)Filter進(jìn)行驗(yàn)證用戶登錄。

防止中文亂碼過(guò)濾器

項(xiàng)目使用spring框架時(shí)。當(dāng)前臺(tái)JSP頁(yè)面和JAVA代碼中使用了不同的字符集進(jìn)行編碼的時(shí)候就會(huì)出現(xiàn)表單提交的數(shù)據(jù)或者上傳/下載中文名稱文件出現(xiàn)亂碼的問(wèn)題，那就可以使用這個(gè)過(guò)濾器。

<filter>
 <filter-name>encoding</filter-name>
 <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
 <init-param>
  <param-name>encoding</param-name><!--用來(lái)指定一個(gè)具體的字符集-->
  <param-value>UTF-8</param-value>
 </init-param>
 <init-param>
  <param-name>forceEncoding</param-name><!--true：無(wú)論request是否指定了字符集，都是用encoding；false：如果request已指定一個(gè)字符集，則不使用encoding-->
  <param-value>false</param-value>
 </init-param>
</filter>
<filter-mapping>
 <filter-name>encoding</filter-name>
 <url-pattern>/*</url-pattern>
</filter-mapping>

Spring+Hibernate的OpenSessionInViewFilter控制session的開(kāi)關(guān)

當(dāng)hibernate+spring配合使用的時(shí)候，如果設(shè)置了lazy=true（延遲加載）,那么在讀取數(shù)據(jù)的時(shí)候，當(dāng)讀取了父數(shù)據(jù)后，hibernate 會(huì)自動(dòng)關(guān)閉session，這樣，當(dāng)要使用與之關(guān)聯(lián)數(shù)據(jù)、子數(shù)據(jù)的時(shí)候，系統(tǒng)會(huì)拋出lazyinit的錯(cuò)誤，這時(shí)就需要使用spring提供的OpenSessionInViewFilter過(guò)濾器。

OpenSessionInViewFilter主要是保持Session狀態(tài)直到request將全部頁(yè)面發(fā)送到客戶端，直到請(qǐng)求結(jié)束后才關(guān)閉session，這樣就可以解決延遲加載帶來(lái)的問(wèn)題。

注意：OpenSessionInViewFilter配置要寫(xiě)在struts2的配置前面。因?yàn)閠omcat容器在加載過(guò)濾器的時(shí)候是按照順序加載的，如果配置文件先寫(xiě)的是struts2的過(guò)濾器配置，然后才是OpenSessionInViewFilter過(guò)濾器配置，所以加載的順序?qū)е拢琣ction在獲得數(shù)據(jù)的時(shí)候session并沒(méi)有被spring管理。

<filter><!-- lazy loading enabled in spring -->
 <filter-name>OpenSessionInViewFilter</filter-name>
 <filter-class>org.springframework.orm.hibernate3.support.OpenSessionInViewFilter</filter-class>
 <init-param>
  <param-name>sessionFactoryBeanName</param-name><!-- 可缺省。默認(rèn)是從spring容器中找id為sessionFactory的bean，如果id不為sessionFactory，則需要配置如下，此處SessionFactory為spring容器中的bean。 -->
  <param-value>sessionFactory</param-value>
 </init-param>
 <init-param>
  <param-name>singleSession</param-name><!-- singleSession默認(rèn)為true,若設(shè)為false則等于沒(méi)用OpenSessionInView -->
  <param-value>true</param-value>
 </init-param>
</filter>
<filter-mapping>
 <filter-name>OpenSessionInViewFilter</filter-name>
 <url-pattern>*.do</url-pattern>
</filter-mapping>
 

Struts2的web.xml配置

項(xiàng)目中使用Struts2同樣需要在web.xml配置過(guò)濾器，用來(lái)截取請(qǐng)求，轉(zhuǎn)到Struts2的Action進(jìn)行處理。

注意：如果在2.1.3以前的Struts2版本，過(guò)濾器使用org.apache.struts2.dispatcher.FilterDispatcher。否則使用org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter。從Struts2.1.3開(kāi)始，將廢棄ActionContextCleanUp過(guò)濾器，而在StrutsPrepareAndExecuteFilter過(guò)濾器中包含相應(yīng)的功能。

三個(gè)初始化參數(shù)配置：

1. config參數(shù)：指定要加載的配置文件。逗號(hào)分割。
2. actionPackages參數(shù)：指定Action類所在的包空間。逗號(hào)分割。
3. configProviders參數(shù)：自定義配置文件提供者，需要實(shí)現(xiàn)ConfigurationProvider接口類。逗號(hào)分割。

<!-- struts 2.x filter -->
<filter>
 <filter-name>struts2</filter-name>
 <filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter</filter-class>
</filter>
<filter-mapping>
 <filter-name>struts2</filter-name>
 <url-pattern>*.do</url-pattern>
</filter-mapping>

 感謝閱讀，希望能幫助到大家，謝謝大家對(duì)本站的支持！