SpringMVC 拦截器

SpringMVC拦截器的实现

1. 自定义的Interceptor类要实现Spring的 HandlerInterceptor 接口
2. 继承实现了HandlerInterceptor接口的类，比如Spring已经提供的实现了HandlerInterceptor接口的抽象类HandlerInterceptorAdapter

这两种方法殊途同归，其实HandlerInterceptorAdapter也就是声明了HandlerInterceptor接口中所有方法的默认实现，而我们在继承他之后只需要重写必要的方法。

HandlerInterceptor 接口

接口中定义了三个抽象方法，我们就是通过这三个方法来对用户的请求进行拦截处理的。

     preHandle()： 这个方法在业务处理器处理请求之前被调用，SpringMVC 中的Interceptor 是链式的调用的，在一个应用中或者说是在一个请求中可以同时存在多个Interceptor 。每个Interceptor 的调用会依据它的声明顺序依次执行，而且最先执行的都是Interceptor 中的preHandle 方法，所以可以在这个方法中进行一些前置初始化操作或者是对当前请求的一个预处理，也可以在这个方法中进行一些判断来决定请求是否要继续进行下去。该方法的返回值是布尔值Boolean 类型的，当它返回为false 时，表示请求结束，后续的Interceptor 和Controller 都不会再执行；当返回值为true 时就会继续调用下一个Interceptor 的preHandle 方法，如果已经是最后一个Interceptor 的时候就会是调用当前请求的Controller 方法。

     postHandle()：这个方法在当前请求进行处理之后，也就是Controller 方法调用之后执行，但是它会在DispatcherServlet 进行视图返回渲染之前被调用，所以我们可以在这个方法中对Controller 处理之后的ModelAndView 对象进行操作。postHandle 方法被调用的方向跟preHandle 是相反的，也就是说先声明的Interceptor 的postHandle 方法反而会后执行。

     afterCompletion()：该方法也是需要当前对应的Interceptor 的preHandle 方法的返回值为true 时才会执行。顾名思义，该方法将在整个请求结束之后，也就是在DispatcherServlet 渲染了对应的视图之后执行。这个方法的主要作用是用于进行资源清理工作的。

 

spring-MVC.xml的相关配置

<!--配置拦截器, 多个拦截器,顺序执行 -->
<mvc:interceptors>
    <mvc:interceptor>
         <!-- /**的意思是所有文件夹及里面的子文件夹 
        /*是所有文件夹，不含子文件夹 
        /是web项目的根目录  -->
        <mvc:mapping path="/**" />
        <!-- 需排除拦截的地址 -->
        <!--  <mvc:exclude-mapping path="/userController/login"/>  -->
       
        <!--这个类就是我们自定义的Interceptor -->
        <bean id="commonInterceptor" class="org.shop.interceptor.CommonInterceptor"> </bean> 
     </mvc:interceptor >
<!-- 当设置多个拦截器时，先按顺序调用preHandle方法，然后逆序调用每个拦截器的postHandle和afterCompletion方法 -->
 </mvc:interceptors>

　

执行流程示意图：

 

SpringBoot设置拦截器的方法

步骤1.编写一个方法实现HandlerInterceptor接口。

package com.xxl.job.admin.controller.interceptor;
 
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.resource.ResourceHttpRequestHandler;
 
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
 
/**
 * 配置自定义拦截器后，Interceptor拦截器默认会对一次请求进行多次拦截，
 * 这是因为有静态资源访问导致的增加配置，第二次请求是对静态资源的访问。
 *
 * 解决方法：
 *  1.在preHandle方法中增加判断过滤调静态资源访问
 *  2.在配置类中排除对静态资源的拦截
 */
@Component
public class MyInterceptor   implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)   throws Exception {
        System.out.println(  "======preHandle 方法执行======" );
        // 处理方法
        if (handler   instanceof HandlerMethod) {
            HandlerMethod handlerMethod = (HandlerMethod) handler;
            System.out.println(  "被拦截的方法： " + handlerMethod.getMethod().getName());
            return true ;
        }
        //增加判断过滤调静态资源访问，这样只有第一次请求会进入，之后的请求都不会进入了
        if (handler   instanceof ResourceHttpRequestHandler) {
            System.out.println(  "===> 过滤静态资源访问 " );
            ResourceHttpRequestHandler httpRequestHandler = (ResourceHttpRequestHandler) handler;
            // 请求路径： /xxl-job-admin/static/images/1.jpg
            System.out.println(  "请求路径： " + httpRequestHandler.getUrlPathHelper().getRequestUri(request));
            return false ;  // 如果拦截，静态资源就无法给前台展示了
        }
        return true ;
    }
 
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
                           ModelAndView modelAndView)   throws Exception {
        System.out.println(  "======postHandle 方法执行======" );
    }
 
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,
                                Exception ex)   throws Exception {
        System.out.println(  "======afterCompletion 方法执行======" );
 
    }
}

　　

步骤2.开启拦截器的配置路径，再写一个类，这个类要加上@Configuration，继承 WebMvcConfigurerAdapter 类或实现 WebMvcConfigurer 接口，重写 addInterceptors 方法。

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
 
@Configuration
public class WebAppConfig extends WebMvcConfigurerAdapter {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //对所有的进行拦截 放行登录页面和首页
        registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**").excludePathPatterns("/user/login", "index.html");
    }
}