碼上歡樂
相關內容    簡體    繁體

JAVA Spring MVC中各個filter的用法

本文轉載自   查看原文   2017-11-01 10:00   5759    JAVA spring mvc/ JAVA Spring MVC中各個filter的用法

 

spring mvc的org.springframework.web.filter包下的Java文件如下：


類的結構如下：

AbstractRequestLoggingFilter及其子類 

  AbstractRequestLoggingFilter類定義了兩個方法beforeRequest和afterRequest分別用於設定過濾前后執行的操作，它有三個子類，分別是CommonsRequestLoggingFilter、ServletContextRequestLoggingFilter和Log4jNestedDiagnosticContextFilter，這三個子類分別實現了各自的beforeRequest和afterRequest。其中，CommonsRequestLoggingFilter在過濾前后分別打印出一段debug的信息；ServletContextRequestLoggingFilter在過濾前后分別向日志文件中寫入一段日志信息，日志文件可由log4j.properties等指定；Log4jNestedDiagnosticContextFilter則將日志信息存儲到NDC中，NDC采用了一個類似棧的機制來push和pot上下文信息，每一個線程都獨立地儲存上下文信息，比如說一個servlet就可以針對 每一個request創建對應的NDC，儲存客戶端地址等信息。

CharacterEncodingFilter

該過濾器是配置編碼格式的，在web.xml中設置如下：

Xml代碼   收藏代碼
  1. <filter>  
  2.   <filter-name>springCharacterEncodingFilter</filter-name>  
  3.   <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>  
  4.   <init-param>  
  5.      <param-name>forceEncoding</param-name>  
  6.      <param-value>true</param-value>  
  7.   </init-param>  
  8.   <init-param>  
  9.      <param-name>encoding</param-name>  
  10.      <param-value>UTF-8</param-value>  
  11.   </init-param>  
  12. </filter>  
  13. <filter-mapping>  
  14.    <filter-name>springCharacterEncodingFilter</filter-name>  
  15.    <url-pattern>/*</url-pattern>  
  16. </filter-mapping>  

 HiddenHttpMethodFilter

html中form表單只支持GET與POST請求，而DELETE、PUT等method並不支持，spring3添加了一個過濾器，可以將這些請求轉換為標准的http方法，使得支持GET、POST、PUT與DELETE請求。可以配置如下：

Xml代碼   收藏代碼
  1. <filter>  
  2.     <filter-name>HiddenHttpMethodFilter</filter-name>  
  3.     <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>  
  4.     <init-param>  
  5.         <param-name>methodParam</param-name>  
  6.         <param-value>_method_</param-value>  
  7.     </init-param>  
  8. </filter>  
  9. <filter-mapping>  
  10.     <filter-name>HiddenHttpMethodFilter</filter-name>  
  11.     <url-pattern>/*</url-pattern>  
  12. </filter-mapping>  

 在頁面的form表單中設置method為Post，並添加一個如下的隱藏域：

  <input type="hidden" name="_method" value="put" />

查看HiddenHttpMethodFilter源碼

Java代碼   收藏代碼
  1. protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {  
  2.         String paramValue = request.getParameter(methodParam);  
  3.         if("POST".equals(request.getMethod()) && StringUtils.hasLength(paramValue)) {  
  4.             String method = paramValue.toUpperCase(Locale.ENGLISH);  
  5.             HttpServletRequest wrapper = new HttpMethodRequestWrapper(request, method);  
  6.             filterChain.doFilter(wrapper, response);  
  7.         } else  
  8.         {  
  9.             filterChain.doFilter(request, response);  
  10.         }  
  11. }  

     由源碼可以看出，filter只對Post方法進行過濾，且需要添加參數名為_method的隱藏域，也可以設置其他參數名，比如想設置為_method_，可以在HiddenHttpMethodFilter配置類中設置初始化參數： 

Xml代碼   收藏代碼
  1. <filter>  
  2.      <filter-name>HiddenHttpMethodFilter</filter-name>  
  3.      <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>  
  4.      <init-param>  
  5.         <param-name>methodParam</param-name>  
  6.         <param-value>_method_</param-value>  
  7.      </init-param>  
  8. </filter>   

 HttpPutFormContentFilter

由HiddenHttpMethodFilter可知，html中的form的method值只能為post或get，我們可以通過HiddenHttpMethodFilter獲取put表單中的參數鍵值對，而在Spring3中獲取put表單的參數鍵值對還有另一種方法，即使用HttpPutFormContentFilter過濾器。

HttpPutFormContentFilter過濾器的作為就是獲取put表單的值，並將之傳遞到Controller中標注了method為RequestMethod.put的方法中。

與HiddenHttpMethodFilter不同，在form中不用添加參數名為_method的隱藏域，且method不必是post，直接寫成put，但該過濾器只能接受enctype值為application/x-www-form-urlencoded的表單，也就是說，在使用該過濾器時，form表單的代碼必須如下：

<form action="" method="put" enctype="application/x-www-form-urlencoded">  

......  

</form>  

配置如下：

 

Xml代碼   收藏代碼
  1. <filter>  
  2.    <filter-name>httpPutFormcontentFilter</filter-name>  
  3.    <filter-class>org.springframework.web.filter.HttpPutFormContentFilter</filter-class>  
  4. </filter>  
  5. <filter-mapping>  
  6.    <filter-name>httpPutFormContentFilter</filter-name>  
  7.    <url-pattern>/*</url-pattern>  
  8. </filter-mapping>  

 ShallowEtagHeaderFilter

ShallowEtagHeaderFilter是spring提供的支持ETag的一個過濾器，所謂ETag是指被請求變量的實體值，是一個可以與Web資源關聯的記號，而Web資源可以是一個Web頁，也可以是JSON或XML文檔，服務器單獨負責判斷記號是什么及其含義，並在HTTP響應頭中將其傳送到客戶端，以下是服務器端返回的格式：

ETag:"50b1c1d4f775c61:df3"  

客戶端的查詢更新格式是這樣的：

If-None-Match : W / "50b1c1d4f775c61:df3"  

   如果ETag沒改變，則返回狀態304然后不返回，這也和Last-Modified一樣。

   ShallowEtagHeaderFilter會將JSP等的內容緩存，生成MD5的key，然后在response中作為Etage的header返回給客戶端。下次客戶端對相同的資源（或者說相同的url）發出請求時，客戶端會將之前生成的key作為If-None-Match的值發送到server端。 Filter會客戶端傳來的值和服務器上的做比較，如果相同，則返回304；否則，將發送新的內容到客戶端。

查看ShallowEtagHeaderFilter的源碼如下：

 

Java代碼   收藏代碼
  1. protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException{  
  2.   ShallowEtagResponseWrapper responseWrapper = new ShallowEtagResponseWrapper(response, null);  
  3.   filterChain.doFilter(request, responseWrapper);  
  4.   // 由此可知，服務器仍會處理請求  
  5.   byte[] body = responseWrapper.toByteArray();  
  6.   int statusCode = responseWrapper.getStatusCode();  
  7.    
  8.   if (isEligibleForEtag(request, responseWrapper, statusCode, body)) {  
  9.     String responseETag = generateETagHeaderValue(body);  
  10.     response.setHeader(HEADER_ETAG, responseETag);  
  11.    
  12.     String requestETag = request.getHeader(HEADER_IF_NONE_MATCH);  
  13.     if (responseETag.equals(requestETag)) {  
  14.       if (this.logger.isTraceEnabled()) {  
  15.         this.logger.trace("ETag [" + responseETag + "] equal to If-None-Match, sending 304");  
  16.       }  
  17.       response.setStatus(304);  
  18.     }  
  19.     else {  
  20.       if (this.logger.isTraceEnabled()) {  
  21.         this.logger.trace("ETag [" + responseETag + "] not equal to If-None-Match [" + requestETag + "], sending normal response");  
  22.       }  
  23.       copyBodyToResponse(body, response);  
  24.     }  
  25.   }  
  26.   else {  
  27.     if (this.logger.isTraceEnabled()) {  
  28.       this.logger.trace("Response with status code [" + statusCode + "] not eligible for ETag");  
  29.     }  
  30.     copyBodyToResponse(body, response);  
  31.   }  
  32. }  

由源碼可知，ShallowEtagHeaderFilter只能根據結果判斷是否重新向客戶端發送數據，並不會不處理請求，因此節省帶寬，而不能提高服務器性能。

配置ShallowEtagHeaderFilter的代碼如下：

 

Xml代碼   收藏代碼
  1. <filter>    
  2.    <filter-name>shallowEtagHeaderFilter</filter-name>    
  3.    <filter-class>org.springframework.web.filter.ShallowEtagHeaderFilter</fliter-class>    
  4. </filter>    
  5. <filter-mapping>    
  6.    <filter-name>shallowEtagHeaderFilter</filter-name>    
  7.    <servlet-name>spring</servlet-name>    
  8. </filter-mapping>  

 

RequestContextFilter

這是在Spring2.0時添加的類，通過LocaleContextHolder和RequestContextHolder把Http request對象基於LocalThread綁定到請求提供服務的線程上。現在一般使用DispatcherServlet這個中央分發器。現在RequestContextFilter過濾器主要用於第三方的Servlet，如JSF的FacesServlet。在Spring2.5之前都是使用該過濾器配置。配置如下：

 

Xml代碼   收藏代碼
  1. <filter>    
  2.     <filter-name>RequestContextFilter</filter-name>    
  3.     <filter-class>org.springframework.web.filter.RequestContextFilter</filter-class>    
  4. </filter>    
  5. <filter-mapping>    
  6.     <filter-name>RequestContextFilter</filter-name>    
  7.     <servlet-name>Faces Servlet</servlet-name>    
  8. </filter-mapping>  

DelegatingFilterProxy

該類其實並不能說是一個過濾器，它的原型是FilterToBeanProxy，即將Filter作為spring的bean，由spring來管理。該類提供了在web.xml和application context之間的聯系。

Proxy for a standard Servlet 2.3 Filter, delegating to a Spring-managed bean that implements the Filter interface. 

有以下幾個參數可以設置：

(1) contextAttribute，使用委派Bean的范圍，其值必須從org.springframework.context.ApplicationContext.WebApplicationContext中取得，默認值是session；其他可選的有request、globalSession和application

(2) targetFilterLifecycle，是否調用Filter的init和destroy方法，默認為false。

(3)targetBeanName，被代理的過濾器的bean的名字，該bean的類必須實現Filter接口。

在web.xml中配置如下：

Xml代碼   收藏代碼
  1. <filter>  
  2.    <filter-name>testFilter</filter-name>  
  3.    <filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>  
  4.    <init-param>  
  5.       <param-name>targetBeanName</param-name>  
  6.       <param-value>spring-bean-name</param-value>  
  7.    </init-param>  
  8.    <init-param>  
  9.       <param-name>contextAttribute</param-name>  
  10.      <param-value>session</param-value>  
  11.    </init-param>  
  12.    <init-param>  
  13.       <param-name>targetFilterLifecycle</param-name>  
  14.       <param-value>false</param-value>  
  15.    </init-param>  
  16. </filter>          
  17. <filter-mapping>  
  18.    <filter-name>testFilter</filter-name>  
  19.    <url-pattern>/*</url-pattern>  
  20. </filter-mapping>  

         testBean是被spring容器管理的對象，對象的類實現了Filter接口。或者可以不用配置這個參數，這樣spring容器中所有實現了Filter接口的類都被代理，實際就是把Servlet容器中的filters同spring容器中的bean關聯起來，方便spring進行管理。

如果不配置DelegatingFilterProxy，則由於filter比bean先加載，也就是spring會先加載filter指定的類到container中，這樣filter中注入的spring bean就為null了。如果將filter中加入DelegatingFilterProxy類，"targetFilterLifecycle"指明作用於filter的所有生命周期。原理是，DelegatingFilterProxy類是一個代理類，所有的請求都會首先發到這個filter代理，然后再按照"filter-name"委派到spring中的這個bean。

此外，spring bean實現了Filter接口，但默認情況下，是由spring容器來管理其生命周期的(不是由tomcat這種服務器容器來管理)。如果設置"targetFilterLifecycle"為True，則spring來管理Filter.init()和Filter.destroy()；若為false，則這兩個方法失效。

在Spring Security中就是使用該類進行設置。即在web.xml中配置該過濾器，然后在spring security相關的配置中設置相應的過濾器bean。但是該類是spring-web包下的類，不屬於Spring Security類。


免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。



猜您在找 Spring MVC中各個filter的用法 java中filter的用法 [劉陽Java]_Spring MVC中ModelAndView的用法_第3講 [劉陽Java]_Spring MVC中@RequestMapping用法_第2講 Spring mvc中@RequestMapping 基本用法 Spring mvc中@RequestParam 基本用法 Spring MVC中RequestMapping的各種用法 Spring MVC 中 Model 的用法 Spring MVC中的ModelMap作用及用法 Spring MVC中Session的正確用法之我見
 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM