Spring Boot項目中如何定製servlet-filters

本文首發於個人網站:http://www.javaadu.online/?p=646

Spring Boot項目中如何定製servlet-filters

在實際的web應用程序中,經常需要在請求(request)外面增加包裝用於:記錄調用日誌、排除有XSS威脅的字符、執行權限驗證等等。除了上述提到的之外,Spring Boot自動添加了OrderedCharacterEncodingFilter和HiddenHttpMethodFilter,並且我們在自己的項目中還可以增加別的過濾器。

Spring Boot、Spring Web和Spring MVC等其他框架,都提供了很多servlet 過濾器可使用,我們需要在配置文件中定義這些過濾器為bean對象。現在假設我們的應用程序運行在一臺負載均衡代理服務器後方,因此需要將代理服務器發來的請求包含的IP地址轉換成真正的用戶IP。Tomcat 8 提供了對應的過濾器:RemoteIpFilter。通過將RemoteFilter這個過濾器加入過濾器調用鏈即可使用它。

實戰

一般在寫簡單的例子時,不需要單獨定義配置文件,只需要將對應的bean對象定義在Application類中即可。正式的項目中一般會有單獨的web配置文件,我們在項目的com.test.bookpub(與BookpubApplication.java同級)下建立WebConfiguration.java文件,並用@Configuration註解修飾。

package com.test.bookpub;
import org.apache.catalina.filters.RemoteIpFilter;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class WebApplication {
@Bean
public RemoteIpFilter remoteIpFilter() {

return new RemoteIpFilter();
}
}

通過mvn spring-boot:run啟動項目,可以在終端中看到如下的輸出信息,證明RemoteIPFilter已經添加成功。

Spring Boot項目中如何定製servlet-filters

分析

項目的主類——BookPubApplication,可以看到由@SpringBootApplication註解修飾,這包含了@ComponentScan、@Configuration和@EnableAutoConfiguration註解。在http://www.jianshu.com/p/846bb2d26ff8一文中曾對這個三個註解做詳細解釋,@ComponentScan讓Spring Boot掃描到WebConfiguration類並把它加入到程序上下文中,因此,我們在WebApplication中定義的Bean就跟在BookPubApplication中定義一樣。

方法public RemoteIpFilter remoteIpFilter() { ... }返回一個RemoteIPFilter類的spring bean。當Spring Boot監測到有javax.servlet.Filter的bean時就會自動加入過濾器調用鏈。從上圖中還可以看到,該Spring Boot項目一次加入了這幾個過濾器:characterEncodingFilter(用於處理編碼問題)、hiddenHttpMethodFilter(隱藏HTTP函數)、httpPutFormContentFilter、requestContextFilter(請求上下文),以及我們剛才自定義的RemoteIPFilter。

所有過濾器的調用順序跟添加的順序相反,過濾器的實現是責任鏈模式,具體的原理分析可以參考:http://www.cnblogs.com/wxisme/p/4550712.html

Spring Boot 1.x系列

  1. http://www.javaadu.online/?p=487
  2. http://www.javaadu.online/?p=495
  3. http://www.javaadu.online/?p=499
  4. http://www.javaadu.online/?p=515
  5. http://www.javaadu.online/?p=518
  6. http://www.javaadu.online/?p=521
  7. http://www.javaadu.online/?p=526
  8. http://www.javaadu.online/?p=530
  9. http://www.javaadu.online/?p=535
  10. http://www.javaadu.online/?p=538
  11. http://www.javaadu.online/?p=546
  12. http://www.javaadu.online/?p=575
  13. http://www.javaadu.online/?p=588
  14. http://www.javaadu.online/?p=590
  15. http://www.javaadu.online/?p=593
  16. http://www.javaadu.online/?p=633
  17. http://www.javaadu.online/?p=637

本號專注於後端技術、JVM問題排查和優化、Java面試題、個人成長和自我管理等主題,為讀者提供一線開發者的工作和成長經驗,期待你能在這裡有所收穫。


分享到:


相關文章: