Spring Boot之FilterRegistrationBean-自定义Filter详解

心已赠人 2024-02-24 08:09 71阅读 0赞

这篇文章主要介绍了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加入过滤链

好吧，直接上代码

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 </td> 
 <td> <code>package</code> <code>com.zoo.lion.modules.test.test; </code> <code>import</code> <code>org.apache.catalina.filters.RemoteIpFilter;</code> <code>import</code> <code>org.springframework.boot.web.servlet.FilterRegistrationBean;</code> <code>import</code> <code>org.springframework.context.annotation.Bean;</code> <code>import</code> <code>org.springframework.context.annotation.Configuration; </code> <code>import</code> <code>javax.servlet.*;</code> <code>import</code> <code>javax.servlet.http.HttpServletRequest;</code> <code>import</code> <code>java.io.IOException;</code> <code>&nbsp;</code>&nbsp; <code>/**</code> <code>&nbsp;</code><code>* @Author: xf</code> <code>&nbsp;</code><code>* @Date: 2019/7/16 13:39</code> <code>&nbsp;</code><code>* @Version 1.0</code> <code>&nbsp;</code><code>*/</code> <code>@Configuration</code> <code>public</code> <code>class</code> <code>WebConfiguration { </code> <code>&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Bean</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code> <code>RemoteIpFilter remoteIpFilter() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>new</code> <code>RemoteIpFilter();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Bean</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code> <code>FilterRegistrationBean&lt;MyFilter&gt; testFilterRegistration() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>FilterRegistrationBean&lt;MyFilter&gt; registration = </code><code>new</code> <code>FilterRegistrationBean&lt;&gt;();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>registration.setFilter(</code><code>new</code> <code>MyFilter());</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//过滤应用程序中所有资源,当前应用程序根下的所有文件包括多级子目录下的所有文件，注意这里*前有“/”</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>registration.addUrlPatterns(</code><code>"/*"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//过滤指定的类型文件资源, 当前应用程序根目录下的所有html文件，注意：*.html前没有“/”,否则错误</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>registration.addUrlPatterns(</code><code>".html"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//过滤指定的目录下的所有文件,当前应用程序根目录下的folder_name子目录（可以是多级子目录）下所有文件</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>registration.addUrlPatterns(</code><code>"/folder_name/*"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//过滤指定文件</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>registration.addUrlPatterns(</code><code>"/index.html"</code><code>);</code> <code>&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>registration.addInitParameter(</code><code>"paramName"</code><code>, </code><code>"paramValue"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>registration.setName(</code><code>"MyFilter"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>registration.setOrder(</code><code>1</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>registration;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>} </code> <code>&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code> <code>class</code> <code>MyFilter </code><code>implements</code> <code>Filter { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code> <code>void</code> <code>init(FilterConfig filterConfig) { </code> <code>&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code> <code>void</code> <code>doFilter(ServletRequest request, ServletResponse response, FilterChain chain) </code><code>throws</code> <code>IOException, ServletException { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>HttpServletRequest request2 = (HttpServletRequest) request;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>System.out.println(request2.getRequestURI());</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>chain.doFilter(request, response);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code> <code>void</code> <code>destroy() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

### SpringBoot FilterRegistrationBean对象支持web的filter的排序 ###

1.FilterRegistrationBean对象可以实现对web Filter的排序，使用setOrder(int i)方法

#### 具体代码如下： ####

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 </td> 
 <td> <code>package</code> <code>com.dbzhang;</code> <code>/**</code> <code>&nbsp;</code><code>* @author zdb</code> <code>&nbsp;</code><code>* @description @Configuration和@Bean注解配置使用，就相当于在配置文件中配置bean的注解式用法</code> <code>&nbsp;</code><code>*/</code> <code>import</code> <code>java.io.IOException;</code> <code>import</code> <code>javax.servlet.Filter;</code> <code>import</code> <code>javax.servlet.FilterChain;</code> <code>import</code> <code>javax.servlet.FilterConfig;</code> <code>import</code> <code>javax.servlet.ServletException;</code> <code>import</code> <code>javax.servlet.ServletRequest;</code> <code>import</code> <code>javax.servlet.ServletResponse;</code> <code>import</code> <code>javax.servlet.http.HttpServletRequest;</code> <code>import</code> <code>org.apache.catalina.filters.RemoteIpFilter;</code> <code>import</code> <code>org.springframework.boot.web.servlet.FilterRegistrationBean;</code> <code>import</code> <code>org.springframework.context.annotation.Bean;</code> <code>import</code> <code>org.springframework.context.annotation.Configuration;</code> <code>&nbsp;</code>&nbsp; <code>@Configuration</code> <code>public</code> <code>class</code> <code>WebConfiguration { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Bean</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code> <code>RemoteIpFilter remoteIpFilter(){ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>new</code> <code>RemoteIpFilter();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>/***</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>* 这个FilterRegistrationBean类可以使用setOrder()方法实现对filter的排序，然后在进行注册</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>* https://blog.csdn.net/doctor_who2004/article/details/56055505</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>*/</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code> <code>FilterRegistrationBean testFilterRegistration(){ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>FilterRegistrationBean registration = </code><code>new</code> <code>FilterRegistrationBean();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>registration.setFilter(</code><code>new</code> <code>MyFilter());</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>registration.addUrlPatterns(</code><code>"/*"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>registration.addInitParameter(</code><code>"paramName"</code><code>, </code><code>"paramValue"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>registration.setName(</code><code>"MyFilter"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>registration.setOrder(</code><code>1</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>registration;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>/**</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>* </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>* @author zdb</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>* @description 这个是用来实现Filter</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>*</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>*/</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code> <code>class</code> <code>MyFilter </code><code>implements</code> <code>Filter{ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code> <code>void</code> <code>destroy() {&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code> <code>void</code> <code>doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>throws</code> <code>IOException, ServletException { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>HttpServletRequest request = (HttpServletRequest)servletRequest;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>System.out.println(</code><code>"this is MyFilter,url:"</code><code>+request.getRequestURI());</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>filterChain.doFilter(servletRequest, servletResponse);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code> <code>void</code> <code>init(FilterConfig arg0) </code><code>throws</code> <code>ServletException {&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。