SpringBoot 过滤器、监听器、拦截器

心已赠人 2022-02-03 10:41 306阅读 0赞

# SpringBoot | 第七章：过滤器、监听器、拦截器 #

2018/08/03 | 分类： [基础技术][Link 1] | [1 条评论][1] | 标签： [spring boot][], [拦截器][Link 2], [监听器][Link 3], [过滤器][Link 4]

分享到：

原文出处： [oKong][]

## 前言 ##

在实际开发过程中，经常会碰见一些比如系统启动初始化信息、统计在线人数、在线用户数、过滤敏高词汇、访问权限控制(URL级别)等业务需求。这些对于业务来说一般上是无关的，业务方是无需关系的，业务只需要关系自己内部业务的事情。所以一般上实现以上的功能，都会或多或少的用到今天准备讲解的`过滤器`、`监听器`、`拦截器`来实现以上功能。

## 过滤器 ##

过滤器`Filter`，是`Servlet`的的一个实用技术了。可通过过滤器，对请求进行拦截，比如读取**`session`判断用户是否登录**、判断访问的**请求URL是否有访问权限(黑白名单)**等。主要还是可对请求进行预处理。接下来介绍下，在`springboot`如何实现过滤器功能。

### 利用WebFilter注解配置 ###

> `@WebFilter`时`Servlet3.0`新增的注解，原先实现过滤器，需要在`web.xml`中进行配置，而现在通过此注解，启动启动时会自动扫描自动注册。

**编写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 </td> 
 <td> <code>//注册器名称为customFilter,拦截的url为所有</code> <code>@WebFilter</code><code>(filterName=</code><code>"customFilter"</code><code>,urlPatterns={ </code><code>"/*"</code><code>})</code> <code>@Slf4j</code> <code>public</code> <code>class</code> <code>CustomFilter </code><code>implements</code> <code>Filter{ </code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code> <code>void</code> <code>init(FilterConfig filterConfig) </code><code>throws</code> <code>ServletException { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>log.info(</code><code>"filter 初始化"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code> <code>void</code> <code>doFilter(ServletRequest request, ServletResponse response, FilterChain chain)</code> <code>&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;</code><code>// TODO Auto-generated method stub</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>log.info(</code><code>"doFilter 请求处理"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//对request、response进行一些预处理</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// 比如设置请求编码</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// request.setCharacterEncoding("UTF-8");</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// response.setCharacterEncoding("UTF-8");</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//TODO 进行业务逻辑</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//链路 直接传给下一个过滤器</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>chain.doFilter(request, response);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&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>log.info(</code><code>"filter 销毁"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

然后在启动类加入`@ServletComponentScan`注解即可。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 </td> 
 <td> <code>@SpringBootApplication</code> <code>@ServletComponentScan</code> <code>@Slf4j</code> <code>public</code> <code>class</code> <code>Chapter7Application { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code> <code>static</code> <code>void</code> <code>main(String[] args) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>SpringApplication.run(Chapter7Application.</code><code>class</code><code>, args);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>log.info(</code><code>"chapter7 服务启动"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

启动后，控制台输出：

[![31854d263adaff84c49683f8a0dc195c.png][]][31854d263adaff84c49683f8a0dc195c.png 1]

过滤器已经生效了。但当注册多个过滤器时，无法指定执行顺序的，原本使用`web。xml`配置过滤器时，是可指定执行顺序的，但使用`@WebFilter`时，没有这个配置属性的(需要配合`@Order`进行)，所以接下来介绍下通过`FilterRegistrationBean`进行过滤器的注册。

**–小技巧–**

1.  通过**过滤器的名字**，进行顺序的约定，比如`LogFilter`和`AuthFilter`，此时`AuthFilter`就会比`LogFilter`先执行，因为首字母`A`比`L`前面。
2.  通过**`@Order`**指定执行顺序，值越小，越先执行

### FilterRegistrationBean方式 ###

`FilterRegistrationBean`是`springboot`提供的，此类提供setOrder方法，可以为filter设置排序值，让spring在注册web filter之前排序后再依次注册。

**改写filter**

其实就输出了@webFilter注解即可。其他的都没有变化。

**启动类中利用`@bean`注册FilterRegistrationBean**

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 </td> 
 <td> <code>@Bean</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code> <code>FilterRegistrationBean&nbsp; filterRegistrationBean() { </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>//当过滤器有注入其他bean类时，可直接通过@bean的方式进行实体类过滤器，这样不可自动注入过滤器使用的其他bean类。</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//当然，若无其他bean需要获取时，可直接new CustomFilter()，也可使用getBean的方式。</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>registration.setFilter(customFilter());</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.setName(</code><code>"customFilter"</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>"/*"</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.setOrder(</code><code>10</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> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Bean</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code> <code>Filter customFilter() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>new</code> <code>CustomFilter();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

**注册多个时，就注册多个FilterRegistrationBean即可**

启动后，效果和第一种是一样的。

[![77fff35e8818102adc38f504498d273d.png][]][77fff35e8818102adc38f504498d273d.png 1]

## 监听器 ##

Listeeshi是servlet规范中定义的一种特殊类。用于监听servletContext、HttpSession和servletRequest等域对象的创建和销毁事件。监听域对象的属性发生修改的事件。用于在事件发生前、发生后做一些必要的处理。一般是获取在线人数等业务需求。

**创建一个ServletRequest监听器(其他监听器类似创建)**

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 </td> 
 <td> <code>@WebListener</code> <code>@Slf4j</code> <code>public</code> <code>class</code> <code>Customlister </code><code>implements</code> <code>ServletRequestListener{ </code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code> <code>void</code> <code>requestDestroyed(ServletRequestEvent sre) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>log.info(</code><code>"监听器：销毁"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code> <code>void</code> <code>requestInitialized(ServletRequestEvent sre) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>log.info(</code><code>"监听器：初始化"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> &nbsp; <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

和创建过滤器一样，在启动类中加入`@ServletComponentScan`进行自动注册即可。

[![570d497a5f787dcdb658c9a303c8ef08.png][]][570d497a5f787dcdb658c9a303c8ef08.png 1]

## 拦截器 ##

以上的过滤器、监听器都属于**Servlet**的api，我们在开发中处理利用以上的进行过滤web请求时，还可以使用`Spring`提供的拦截器(`HandlerInterceptor`)进行更加精细的控制。

**编写自定义拦截器类**

<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 </td> 
 <td> <code>@Slf4j</code> <code>public</code> <code>class</code> <code>CustomHandlerInterceptor </code><code>implements</code> <code>HandlerInterceptor{ </code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code> <code>boolean</code> <code>preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>throws</code> <code>Exception { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>log.info(</code><code>"preHandle:请求前调用"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//返回 false 则请求中断</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>true</code><code>;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code> <code>void</code> <code>postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>ModelAndView modelAndView) </code><code>throws</code> <code>Exception { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>log.info(</code><code>"postHandle:请求后调用"</code><code>);</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code> <code>void</code> <code>afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>throws</code> <code>Exception { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>log.info(</code><code>"afterCompletion:请求调用完成后回调方法，即在视图渲染完成后回调"</code><code>);</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> &nbsp; <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

**通过继承`WebMvcConfigurerAdapter`注册拦截器**

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 </td> 
 <td> <code>@Configuration</code> <code>public</code> <code>class</code> <code>WebMvcConfigurer </code><code>extends</code> <code>WebMvcConfigurerAdapter{ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code> <code>void</code> <code>addInterceptors(InterceptorRegistry registry) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</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>registry.addInterceptor(getHandlerInterceptor()).addPathPatterns(</code><code>"/*"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Bean</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code> <code>static</code> <code>HandlerInterceptor getHandlerInterceptor() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>new</code> <code>CustomHandlerInterceptor();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

启动后，访问某个url，控制台输出

[![ff1e5998eb18492f0209ec1de92b8dd6.png][]][ff1e5998eb18492f0209ec1de92b8dd6.png 1]

## 请求链路说明 ##

[![c1878fa666e4a1d8b993dd70f9ae2a96.png][]][c1878fa666e4a1d8b993dd70f9ae2a96.png 1]

在整个请求的过程，此一图胜千言，希望对此有个深刻的了解，通过不同组合实现不同的业务功能。

## 总结 ##

本章节主要介绍了常用web开发时，会用到的一些常用类，本章节对`servlet`未进行介绍，平时用的比较少，用法和配置其实和拦截器、监听器是类似的，再次就不阐述了。

## 最后 ##

目前互联网上很多大佬都有`SpringBoot`系列教程，如有雷同，请多多包涵了。本文是作者在电脑前一字一句敲的，每一步都是实践的。若文中有所错误之处，还望提出，谢谢。

### 相关文章 ###

*  [SpringBoot系列一：SpringBoot入门][SpringBoot_SpringBoot]
 *  [Spring Boot基础教程 ( 五 ) ：构建 RESTful API 与单元测试][Spring Boot_ _ _ _ _ RESTful API]
 *  [Spring Boot基础教程 ( 四 ) ：Spring Boot 属性配置文件详解][Spring Boot_ _ _ _ _Spring Boot]
 *  [Spring Boot基础教程 ( 三 ) ：使用 Cloud Studio 在线编写、调试和管理 Spring Boot 应用][Spring Boot_ _ _ _ _ Cloud Studio _ Spring Boot]
 *  [Spring Boot基础教程 ( 二 ) ：使用 Intellij 中的 Spring Initializr 来快速构建 Spring Boot/Cloud 工程][Spring Boot_ _ _ _ _ Intellij _ Spring Initializr _ Spring Boot_Cloud]
 *  [Spring Boot基础教程 ( 一 ) ：基础项目构建，引入web模块，完成一个简单的RESTful API][Spring Boot_ _ _ _ _web_RESTful API]
 *  [SpringBoot | 番外：使用小技巧合集][SpringBoot _]
 *  [SpringBoot | 第二十二章：定时任务的使用][SpringBoot _ 1]
 *  [SpringBoot | 第二十一章：异步开发之异步调用][SpringBoot _ 2]
 *  [SpringBoot | 第二十章：异步开发之异步请求][SpringBoot _ 3]

[Link 1]: http://www.importnew.com/cat/basic
[1]: http://www.importnew.com/29401.html#comments
[spring boot]: http://www.importnew.com/tag/spring-boot
[Link 2]: http://www.importnew.com/tag/%E6%8B%A6%E6%88%AA%E5%99%A8
[Link 3]: http://www.importnew.com/tag/%E7%9B%91%E5%90%AC%E5%99%A8
[Link 4]: http://www.importnew.com/tag/%E8%BF%87%E6%BB%A4%E5%99%A8
[oKong]: https://blog.lqdev.cn/2018/07/19/springboot/chapter-seven/
[31854d263adaff84c49683f8a0dc195c.png]: /images/20220203/fa2373f0c00d45fe892872cf43a49708.png
[31854d263adaff84c49683f8a0dc195c.png 1]: http://www.importnew.com/29401.html/attachment/80134508
[77fff35e8818102adc38f504498d273d.png]: /images/20220203/9ff0f93c394c4bcb879aeb4a50b906e7.png
[77fff35e8818102adc38f504498d273d.png 1]: http://www.importnew.com/29401.html/80134508-1
[570d497a5f787dcdb658c9a303c8ef08.png]: /images/20220203/7bddb9ee6c9344558788f6d22949f0e5.png
[570d497a5f787dcdb658c9a303c8ef08.png 1]: http://www.importnew.com/29401.html/attachment/85740970
[ff1e5998eb18492f0209ec1de92b8dd6.png]: /images/20220203/aa67a6b81c124b9eb9b09d07cb088a89.png
[ff1e5998eb18492f0209ec1de92b8dd6.png 1]: http://www.importnew.com/29401.html/attachment/56221243
[c1878fa666e4a1d8b993dd70f9ae2a96.png]: /images/20220203/cfa61ec9cb7644669787a324aa9a5eaa.png
[c1878fa666e4a1d8b993dd70f9ae2a96.png 1]: http://www.importnew.com/29401.html/attachment/55655219
[SpringBoot_SpringBoot]: http://www.importnew.com/30542.html
[Spring Boot_ _ _ _ _ RESTful API]: http://www.importnew.com/30031.html
[Spring Boot_ _ _ _ _Spring Boot]: http://www.importnew.com/30029.html
[Spring Boot_ _ _ _ _ Cloud Studio _ Spring Boot]: http://www.importnew.com/30026.html
[Spring Boot_ _ _ _ _ Intellij _ Spring Initializr _ Spring Boot_Cloud]: http://www.importnew.com/30022.html
[Spring Boot_ _ _ _ _web_RESTful API]: http://www.importnew.com/30016.html
[SpringBoot _]: http://www.importnew.com/29886.html
[SpringBoot _ 1]: http://www.importnew.com/29864.html
[SpringBoot _ 2]: http://www.importnew.com/29856.html
[SpringBoot _ 3]: http://www.importnew.com/29849.html