第六课从零开始学Spring boot 之（过滤器Filter、监听器Listener、拦截器HandlerInterceptor）

本文主要是介绍第六课从零开始学Spring boot 之（过滤器Filter、监听器Listener、拦截器HandlerInterceptor），希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

过滤器（Filter）和监听器（Listener）的注册方法和Servlet 一样，不清楚的可以查看上一篇文章。本文将直接使用@WebFilter和@WebListener的方式，完成一个Filter 和一个 Listener；使用注解。

@ServletComponentScan//这个就是扫描相应的Servlet包;

过滤器属于 Servlet 范畴的 API ，与 Spring 没什么关系。

1、过滤器Filter

过滤器（Filter）文件：

package com.gongh.config;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.annotation.WebFilter;/**
*
* 使用注解标注过滤器
* @WebFilter将一个实现了javax.servlet.Filter接口的类定义为过滤器
* 属性filterName声明过滤器的名称,可选
* 属性urlPatterns指定要过滤的URL模式,也可使用属性value来声明.(指定要过滤的URL模式是必选属性)
* @author gh
* @version v.0.1
*/@WebFilter(filterName="myFilter",urlPatterns="/*")
public class MyFilter implements Filter{@Overridepublic void destroy() {System.out.println("过滤器销毁操作");}@Overridepublic void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)throws IOException, ServletException {System.out.println("执行过滤操作");chain.doFilter(request, response);}@Overridepublic void init(FilterConfig arg0) throws ServletException {

		System.out.println("过滤器初始化操作");

}

2、监听器Listener

ServletContext监听器（Listener）文件：

package com.gongh.config;import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;/*** 监听器* 使用@WebListener注解，实现ServletContextListener接口* @author gh* @version v.0.1*/@WebListener
public class MyServletContextListener implements ServletContextListener{@Overridepublic void contextDestroyed(ServletContextEvent arg0) {System.out.println("ServletContext销毁");}@Overridepublic void contextInitialized(ServletContextEvent arg0) {System.out.println("ServletContext初始化");}}

ServletContext监听器（Listener）文件（HttpSessionListener）：

package com.gongh.config;import javax.servlet.annotation.WebListener;
import javax.servlet.http.HttpSessionEvent;
import javax.servlet.http.HttpSessionListener;/*** 监听Session的创建与销毁* @author gh**/
@WebListener
public class MyHttpSessionListener implements HttpSessionListener{@Overridepublic void sessionCreated(HttpSessionEvent arg0) {System.out.println("Session 被创建");}@Overridepublic void sessionDestroyed(HttpSessionEvent arg0) {System.out.println("Session 被销毁");}}

注意不要忘记在 App.java 上添加 @ServletComponentScan 注解。不然扫描不到这俩文件，就起不到过滤器和监听器的作用啦

3、拦截器HandlerInterceptor

上一篇对过滤器的定义做了说明，也比较简单。过滤器属于Servlet范畴的API，与Spring 没什么关系。
Web开发中，我们除了使用 Filter 来过滤请web求外，还可以使用Spring提供的HandlerInterceptor（拦截器）。

HandlerInterceptor 的功能跟过滤器类似，但是提供更精细的的控制能力：在request被响应之前、request被响应之后、视图渲染之前以及request全部结束之后。我们不能通过拦截器修改request内容，但是可以通过抛出异常（或者返回false）来暂停request的执行。

实现 UserRoleAuthorizationInterceptor 的拦截器有：
ConversionServiceExposingInterceptor
CorsInterceptor
LocaleChangeInterceptor
PathExposingHandlerInterceptor
ResourceUrlProviderExposingInterceptor
ThemeChangeInterceptor
UriTemplateVariablesHandlerInterceptor
UserRoleAuthorizationInterceptor

其中 LocaleChangeInterceptor 和 ThemeChangeInterceptor 比较常用。

配置拦截器也很简单，Spring 为什么提供了基础类WebMvcConfigurerAdapter ，我们只需要重写 addInterceptors 方法添加注册拦截器。

实现自定义拦截器只需要3步：
1、创建我们自己的拦截器类并实现 HandlerInterceptor 接口。
2、创建一个Java类继承WebMvcConfigurerAdapter，并重写 addInterceptors 方法。
2、实例化我们自定义的拦截器，然后将对像手动添加到拦截器链中（在addInterceptors方法中添加）。
PS：本文重点在如何在Spring-Boot中使用拦截器，关于拦截器的原理请大家查阅资料了解。

package com.gongh.config;import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;/*** 自定义拦截器* @author gh**/
public class MyInterceptor implements HandlerInterceptor{@Overridepublic void afterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3)throws Exception {System.out.println("====MyInterceptor====在整个请求结束之后被调用，也就是在DispatcherServlet 渲染了对应的视图之后执行（主要是用于进行资源清理工作）");}@Overridepublic void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3)throws Exception {System.out.println("====MyInterceptor====请求处理之后进行调用，但是在视图被渲染之前（Controller方法调用之后）");}@Overridepublic boolean preHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2) throws Exception {System.out.println("====MyInterceptor====在请求处理之前进行调用（Controller方法调用之前）");return true;// 只有返回true才会继续向下执行，返回false取消当前请求}}

package com.gongh.config;import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;@Configuration
public class MyWebAppConfigurer extends WebMvcConfigurerAdapter{@Overridepublic void addInterceptors(InterceptorRegistry registry) {// 多个拦截器组成一个拦截器链// addPathPatterns 用于添加拦截规则// excludePathPatterns 用户排除拦截registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**");super.addInterceptors(registry);}}

然后在浏览器输入地址： http://localhost:8080/ 后，控制台的输出如下：

根据输出可以了解拦截器链的执行顺序（具体原理介绍，大家找度娘一问便知）

最后强调一点：只有经过DispatcherServlet 的请求，才会走拦截器链，我们自定义的Servlet 请求是不会被拦截的，比如我们自定义的Servlet地址http://localhost:8080/myServlet是不会被拦截器拦截的。并且不管是属于哪个Servlet 只要复合过滤器的过滤规则，过滤器都会拦截。