springboot中的过滤器Filter与拦截器Intercepter

谁借莪１个温暖的怀抱￠ 2022-04-02 08:58 231阅读 0赞

### 一.前言 ###

首先比较下过滤器filter和拦截器intercept的差别,两个有点像,但实际有所差别,过滤器和拦截器在对请求进行拦截时，一个是发生的时机不一样，filter是在servlet容器外，interceptor在servlet容器内，且可以对请求的3个关键步骤进行拦截处理。另外filter在过滤是只能对request和response进行操作，而interceptor可以对request、response、handler、modelAndView、exception进行操作。

### 二.过滤器Filter基本用法 ###

##### 1.Application添加注解 #####

@EnableAutoConfiguration
    @ServletComponentScan
    @ComponentScan("com.example.sso_client")

##### 2.新增Fileter测试 #####

@WebFilter(filterName = "filter", urlPatterns = "/*")
    public class MyFilter implements Filter { 
    
        @Override
        public void init(FilterConfig config) throws ServletException { 
            System.out.println("过滤器初始化");
        }
    
    
        @Override
        public void doFilter(ServletRequest request, ServletResponse response,
                             FilterChain chain) throws IOException, ServletException { 
            System.out.println("执行过滤操作");
            chain.doFilter(request, response);
        }
    
        @Override
        public void destroy() { 
            System.out.println("过滤器销毁");
        }
    }

### 三.拦截器Intercepter用法 ###

##### 1.默认资源映射 #####

Spring Boot 默认为我们提供了静态资源处理，使用WebMvcAutoConfiguration 中的配置各种属性。建议大家使用Spring Boot的默认配置方式，提供的静态资源映射如下:

*  classpath:/META-INF/resources
 *  classpath:/resources
 *  classpath:/static
 *  classpath:/public

**在工程中目录为:**  
![在这里插入图片描述][19f8000623d07fa4c5cc]  
面这几个都是静态资源的映射路径，优先级顺序为：META-INF/resources > resources > static > public

##### 2.拦截器注册 #####

@Configuration
    public class WebAppConfig extends WebMvcConfigurationSupport { 
       @Override
       public void addInterceptors(InterceptorRegistry registry) { 
           //注册自定义拦截器，添加拦截路径和排除拦截路径
           registry.addInterceptor(new AuthInterceptor()).addPathPatterns("/**")
                 .excludePathPatterns("/login");
       }
    }

##### 3.定义拦截器 #####

实现HandlerInterceptor接口或者继承HandlerInterceptor的子类,比如比如Spring 已经提供的实现了HandlerInterceptor 接口的抽象类HandlerInterceptorAdapter ,下面讲实现其接口的写法,先看一下这个接口的三个方法.

*  方法preHandle: 顾名思义，该方法将在请求处理之前进行调用。SpringMVC 中的Interceptor 是链式的调用的，在一个应用中或者说是在一个请求中可以同时存在多个Interceptor 。每个Interceptor 的调用会依据它的声明顺序依次执行，而且最先执行的都是Interceptor 中的preHandle 方法，所以可以在这个方法中进行一些前置初始化操作或者是对当前请求的一个预处理，也可以在这个方法中进行一些判断来决定请求是否要继续进行下去。该方法的返回值是布尔值Boolean 类型的，当它返回为false 时，表示请求结束，后续的Interceptor 和Controller 都不会再执行；当返回值为true 时就会继续调用下一个Interceptor 的preHandle 方法，如果已经是最后一个Interceptor 的时候就会是调用当前请求的Controller 方法。
 *  方法postHandle:由preHandle 方法的解释我们知道这个方法包括后面要说到的afterCompletion 方法都只能是在当前所属的Interceptor 的preHandle 方法的返回值为true 时才能被调用。postHandle 方法，顾名思义就是在当前请求进行处理之后，也就是Controller 方法调用之后执行，但是它会在DispatcherServlet 进行视图返回渲染之前被调用，所以我们可以在这个方法中对Controller 处理之后的ModelAndView 对象进行操作。postHandle 方法被调用的方向跟preHandle 是相反的，也就是说先声明的Interceptor 的postHandle 方法反而会后执行，这和Struts2 里面的Interceptor 的执行过程有点类型。Struts2 里面的Interceptor 的执行过程也是链式的，只是在Struts2 里面需要手动调用ActionInvocation 的invoke 方法来触发对下一个Interceptor 或者是Action 的调用，然后每一个Interceptor 中在invoke 方法调用之前的内容都是按照声明顺序执行的，而invoke 方法之后的内容就是反向的。
 *  方法afterCompletion:该方法也是需要当前对应的Interceptor 的preHandle 方法的返回值为true 时才会执行。顾名思义，该方法将在整个请求结束之后，也就是在DispatcherServlet 渲染了对应的视图之后执行。这个方法的主要作用是用于进行资源清理工作的。

public class AuthInterceptors implements HandlerInterceptor{ 
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { 
            System.out.println("在请求处理之前进行调用");
            return false;
        }
    
        @Override
        public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception { 
            System.out.println("在当前请求进行处理之后");
        }
    
        @Override
        public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception { 
            System.out.println("在整个请求结束之后");
        }
    }

[19f8000623d07fa4c5cc]: http://p3.pstatp.com/large/19f8000623d07fa4c5cc