Spring Boot之FilterRegistrationBean-自定義Filter詳解

Spring Boot之FilterRegistrationBean-自定義Filter

項目老的用spring寫的，新的升級到了springboot,原代碼中有在web.xml中定義過濾器，在boot中，自然沒法這樣用了，因而看了看boot如何使用自定義過濾器。

在springboot 中，主要是靠FilterRegistrationBean 這個類來提供這樣的功能。

自定義 Filter

我們常常在項目中會使用 filters 用于錄調用日志、排除有 XSS 威脅的字符、執行權限驗證等等。Spring Boot 自動添加了 OrderedCharacterEncodingFilter 和 HiddenHttpMethodFilter，并且我們可以自定義 Filter。

兩個步驟： 1、實現 Filter 接口，實現 Filter 方法 2、添加 @Configuration 注解，將自定義Filter加入過濾鏈

好吧，直接上代碼

package com.zoo.lion.modules.test.test; import org.apache.catalina.filters.RemoteIpFilter;import org.springframework.boot.web.servlet.FilterRegistrationBean;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration; import javax.servlet.*;import javax.servlet.http.HttpServletRequest;import java.io.IOException; /** * @Author: xf * @Date: 2019/7/16 13:39 * @Version 1.0 */@Configurationpublic class WebConfiguration { @Bean public RemoteIpFilter remoteIpFilter() {return new RemoteIpFilter(); } @Bean public FilterRegistrationBean<MyFilter> testFilterRegistration() {FilterRegistrationBean<MyFilter> registration = new FilterRegistrationBean<>();registration.setFilter(new MyFilter());//過濾應用程序中所有資源,當前應用程序根下的所有文件包括多級子目錄下的所有文件，注意這里*前有“/”registration.addUrlPatterns('/*');//過濾指定的類型文件資源, 當前應用程序根目錄下的所有html文件，注意：*.html前沒有“/”,否則錯誤registration.addUrlPatterns('.html');//過濾指定的目錄下的所有文件,當前應用程序根目錄下的folder_name子目錄（可以是多級子目錄）下所有文件registration.addUrlPatterns('/folder_name/*');//過濾指定文件registration.addUrlPatterns('/index.html'); registration.addInitParameter('paramName', 'paramValue');registration.setName('MyFilter');registration.setOrder(1);return registration; } public class MyFilter implements Filter { @Overridepublic void init(FilterConfig filterConfig) { } @Overridepublic void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { HttpServletRequest request2 = (HttpServletRequest) request; System.out.println(request2.getRequestURI()); chain.doFilter(request, response);} @Overridepublic void destroy() { } }}SpringBoot FilterRegistrationBean對象支持web的filter的排序

1.FilterRegistrationBean對象可以實現對web Filter的排序，使用setOrder(int i)方法

具體代碼如下：

package com.dbzhang;/** * @author zdb * @description @Configuration和@Bean注解配置使用，就相當于在配置文件中配置bean的注解式用法 */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 org.apache.catalina.filters.RemoteIpFilter;import org.springframework.boot.web.servlet.FilterRegistrationBean;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration; @Configurationpublic class WebConfiguration {@Beanpublic RemoteIpFilter remoteIpFilter(){return new RemoteIpFilter();}/*** * 這個FilterRegistrationBean類可以使用setOrder()方法實現對filter的排序，然后在進行注冊 * https://blog.csdn.net/doctor_who2004/article/details/56055505 */public FilterRegistrationBean testFilterRegistration(){FilterRegistrationBean registration = new FilterRegistrationBean();registration.setFilter(new MyFilter());registration.addUrlPatterns('/*');registration.addInitParameter('paramName', 'paramValue');registration.setName('MyFilter');registration.setOrder(1);return registration;}/** * * @author zdb * @description 這個是用來實現Filter * */public class MyFilter implements Filter{ @Overridepublic void destroy() {} @Overridepublic void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)throws IOException, ServletException {HttpServletRequest request = (HttpServletRequest)servletRequest;System.out.println('this is MyFilter,url:'+request.getRequestURI());filterChain.doFilter(servletRequest, servletResponse);} @Overridepublic void init(FilterConfig arg0) throws ServletException {}}}

以上為個人經驗，希望能給大家一個參考，也希望大家多多支持好吧啦網。