Spring Boot之FilterRegistrationBean-自定義Filter詳解

更新時(shí)間：2021年08月12日 09:38:55 作者：NPException

這篇文章主要介紹了Spring Boot之FilterRegistrationBean-自定義Filter詳解，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

Spring Boot之FilterRegistrationBean-自定義Filter

項(xiàng)目老的用spring寫(xiě)的，新的升級(jí)到了springboot,原代碼中有在web.xml中定義過(guò)濾器，在boot中，自然沒(méi)法這樣用了，因而看了看boot如何使用自定義過(guò)濾器。

在springboot 中，主要是靠FilterRegistrationBean 這個(gè)類(lèi)來(lái)提供這樣的功能。

自定義 Filter

我們常常在項(xiàng)目中會(huì)使用 filters 用于錄調(diào)用日志、排除有 XSS 威脅的字符、執(zhí)行權(quán)限驗(yàn)證等等。Spring Boot 自動(dòng)添加了 OrderedCharacterEncodingFilter 和 HiddenHttpMethodFilter，并且我們可以自定義 Filter。

兩個(gè)步驟：

1、實(shí)現(xiàn) Filter 接口，實(shí)現(xiàn) Filter 方法
2、添加 @Configuration 注解，將自定義Filter加入過(guò)濾鏈

好吧，直接上代碼

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
 */
@Configuration
public class WebConfiguration {
 
    @Bean
    public RemoteIpFilter remoteIpFilter() {
        return new RemoteIpFilter();
    }
 
    @Bean
    public FilterRegistrationBean<MyFilter> testFilterRegistration() {
        FilterRegistrationBean<MyFilter> registration = new FilterRegistrationBean<>();
        registration.setFilter(new MyFilter());
        //過(guò)濾應(yīng)用程序中所有資源,當(dāng)前應(yīng)用程序根下的所有文件包括多級(jí)子目錄下的所有文件，注意這里*前有“/”
        registration.addUrlPatterns("/*");
        //過(guò)濾指定的類(lèi)型文件資源, 當(dāng)前應(yīng)用程序根目錄下的所有html文件，注意：*.html前沒(méi)有“/”,否則錯(cuò)誤
        registration.addUrlPatterns(".html");
        //過(guò)濾指定的目錄下的所有文件,當(dāng)前應(yīng)用程序根目錄下的folder_name子目錄（可以是多級(jí)子目錄）下所有文件
        registration.addUrlPatterns("/folder_name/*");
        //過(guò)濾指定文件
        registration.addUrlPatterns("/index.html");
 
        registration.addInitParameter("paramName", "paramValue");
        registration.setName("MyFilter");
        registration.setOrder(1);
        return registration;
    } 
 
    public class MyFilter implements Filter { 
        @Override
        public void init(FilterConfig filterConfig) {
 
        }
 
        @Override
        public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
            HttpServletRequest request2 = (HttpServletRequest) request;
            System.out.println(request2.getRequestURI());
            chain.doFilter(request, response);
        }
 
        @Override
        public void destroy() { 
        }
    }
}

SpringBoot FilterRegistrationBean對(duì)象支持web的filter的排序

1.FilterRegistrationBean對(duì)象可以實(shí)現(xiàn)對(duì)web Filter的排序，使用setOrder(int i)方法

具體代碼如下：

package com.dbzhang;
/**
 * @author zdb
 * @description @Configuration和@Bean注解配置使用，就相當(dāng)于在配置文件中配置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;
 
@Configuration
public class WebConfiguration {
	@Bean
	public RemoteIpFilter remoteIpFilter(){
		return new RemoteIpFilter();
	}
	/***
	 * 這個(gè)FilterRegistrationBean類(lèi)可以使用setOrder()方法實(shí)現(xiàn)對(duì)filter的排序，然后在進(jìn)行注冊(cè)
	 * 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 這個(gè)是用來(lái)實(shí)現(xiàn)Filter
	 *
	 */
	public class MyFilter implements Filter{ 
		@Override
		public void destroy() {			
		}
 
		@Override
		public 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);
		}
 
		@Override
		public void init(FilterConfig arg0) throws ServletException {			
		}		
	}
}

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

您可能感興趣的文章: