鍍金池/ 教程/ Java/ Spring Boot:定制servlet filters
通過JMX監(jiān)控Spring Boot應用
Spring Boot:定制PropertyEditors
配置是否初始化Bean的方法
Spring Boot的自動配置、Command-line Runner
Spring Boot:定制URL匹配規(guī)則
Spring Boot的自動配置、Command-line Runner
利用Mockito模擬DB
Spring Boot應用的打包和部署
了解Spring Boot的自動配置
Spring Boot應用的健康監(jiān)控
了解Spring Boot的自動配置
初始化數(shù)據(jù)庫和導入數(shù)據(jù)
Spring Boot應用的健康監(jiān)控
Docker with Spring Boot
RESTful by Spring Boot with MySQL
Spring Boot:定制攔截器
Spring Boot:定制static path mappings
Spring Boot with Mysql
Spring Boot:定制自己的starter
在測試中使用內(nèi)存數(shù)據(jù)庫
Restful: Spring Boot with Mongodb
Spring Boot with Redis
Spring Boot:定制HTTP消息轉(zhuǎn)換器
Spring Boot: Data Rest Service
Spring Boot:定制type Formatters
在Spring Boot項目中使用Spock框架
選擇Spring Boot項目的內(nèi)嵌容器
通過EmbeddedServletContainerCustomizer接口調(diào)優(yōu)Tomcat
Spring Boot應用的打包和部署
Spring Boot Admin的使用
讓你的Spring Boot工程支持HTTP和HTTPS
Spring Boot:定制servlet filters
Spring Boot:定制URL匹配規(guī)則
Spring Boot應用的測試——Mockito
Spring Boot應用的測試——Mockito
Spring Boot:定制servlet filters
通過@Enable*注解觸發(fā)Spring Boot配置

Spring Boot:定制servlet filters

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

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

How Do

一般在寫簡單的例子時,不需要單獨定義配置文件,只需要將對應的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已經(jīng)添加成功。

http://wiki.jikexueyuan.com/project/spring-boot-cookbook-zh/images/cc5.png" alt="RemoteIPFilter" />

分析

項目的主類——BookPubApplication,可以看到由@SpringBootApplication注解修飾,這包含了@ComponentScan、@Configuration和@EnableAutoConfiguration注解。在Spring Boot的自動配置、Command-line Runner一文中曾對這個三個注解做詳細解釋,@ComponentScan讓Spring Boot掃描到WebConfiguration類并把它加入到程序上下文中,因此,我們在WebApplication中定義的Bean就跟在BookPubApplication中定義一樣。

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

所有過濾器的調(diào)用順序跟添加的順序相反,過濾器的實現(xiàn)是責任鏈模式,具體的原理分析可以參考:責任鏈模式