SpringMVC_05_拦截器

拦截器

1. 简介

Spring MVC中的拦截器（Interceptor）类似于Servlet中的过滤器（Filter），它主要用于拦截用户请求并作相应的处理。例如通过拦截器可以进行权限验证、记录请求信息的日志、判断用户是否登录等。 要使用Spring MVC中的拦截器，就需要对拦截器类进行定义和配置。

SpringMVC提供的拦截器接口：HandlerInterceptor

public interface HandlerInterceptor {
	boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
	    throws Exception;
 
	void postHandle(
			HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)
			throws Exception;
 
	void afterCompletion(
			HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
			throws Exception;
}

拦截器一个有3个回调方法，而一般的过滤器Filter才两个:

• preHandle：预处理回调方法，实现处理器的预处理（如登录检查），第三个参数为响应的处理器。返回值：true表示继续流程（如调用下一个拦截器或处理器）；false表示流程中断（如登录检查失败），不会继续调用其他的拦截器或处理器，此时我们需要通过response来产生响应；
• postHandle：后处理回调方法，实现处理器的后处理（但在渲染视图之前），此时我们可以通过modelAndView（模型和视图对象）对模型数据进行处理或对视图进行处理，modelAndView也可能为null。
• afterCompletion：整个请求处理完毕回调方法，即在视图渲染完毕时回调，如性能监控中我们可以在此记录结束时间并输出消耗时间，还可以进行一些资源清理，类似于try-catch-finally中的finally，但仅调用处理器执行链中preHandle返回true的拦截器才会执行afterCompletion。

2. 拦截器的配置

步骤一：自定义两个拦截器

• FisrtInterceptor

package interceptor;

import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.lang.reflect.Method;
import java.util.Arrays;

public class FisrtInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if(handler instanceof HandlerMethod){
            HandlerMethod handlerMethod = (HandlerMethod) handler; //参数hander本质上就是HandlerMethod实例
            Object bean = handlerMethod.getBean();
            Method method = handlerMethod.getMethod();
            System.out.println("FirstInterceptor.preHandle,bean:" +
                    bean.getClass() + ",method:" + method.getName() + ",args:" +
                    Arrays.toString(method.getParameterTypes()));
        }
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("FirstInterceptor.postHandle");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("FirstInterceptor.afterCompletion");
    }
}

• SecondInterceptor

package interceptor;

import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.lang.reflect.Method;
import java.util.Arrays;

public class SecondInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if(handler instanceof HandlerMethod){
            HandlerMethod handlerMethod = (HandlerMethod) handler; //参数hander本质上就是HandlerMethod实例
            Object bean = handlerMethod.getBean();
            Method method = handlerMethod.getMethod();
            System.out.println("SecondInterceptor.preHandle,bean:" +
                    bean.getClass() + ",method:" + method.getName() + ",args:" +
                    Arrays.toString(method.getParameterTypes()));
        }
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("SecondInterceptor.postHandle");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("SecondInterceptor.afterCompletion");
    }
}

步骤二：在配置文件进行配置

在springmvc.xml中加入如下代码

    <!--配置拦截器-->
    <mvc:interceptors>
        <!--拦截器1-->
            <bean class="interceptor.FirstInterceptor"/>
        <!--拦截器2-->
        <mvc:interceptor>
            <!--配置拦截器的作用路径-->
            <mvc:mapping path="/path/*"/>
            <mvc:mapping path="/hello"/>
            <mvc:exclude-mapping path="/path/showLogin"/>
            <!--定义在<mvc:interceptor>下面的表示匹配指定路径的请求才进行拦截-->
            <bean class="interceptor.SecondInterceptor"/>
        </mvc:interceptor>
    </mvc:interceptors>

• < mvc:interceptors>元素用于配置一组拦截器，基子元素< bean>中定义的是全局拦截器，它会拦截所有的请求；
• <mvc:interceptor>元素中定义的是指定路径的拦截器，它会对指定路径下的请求生效。
• <mvc:interceptor>元素的子元素<mvc:mapping>用于配置拦截器作用的路径，该路径在其属性path 中定义。如上述代码中 path 的属性值“/path/*” 表示拦截path下的所有路径，“/hello” 表示拦截所有以 “/hello” 结尾的路径。如果在请求路径中包含不需要拦截的内容，还可以通过<mvc:exclude-mapping>元素进行配置。

3. 拦截器的执行流程

3.1 单个拦截器的执行流程

在运行程序时，拦截器的执行是有一定顺序的，该顺序与配置文件中所定义的拦截器的顺序相关。 单个拦截器，在程序中的执行流程如下图所示：

1.程序先执行preHandle()方法，如果该方法的返回值为true，则程序会继续向下执行处理器中的方法，否则将不再向下执行。

2.在业务处理器（即控制器Controller类）处理完请求后，会执行postHandle()方法，然后会通过DispatcherServlet向客户端返回响应。

3.在DispatcherServlet处理完请求后，才会执行afterCompletion()方法。

案例：以全局拦截器FirstInterceptor为例，运行测试项目，url路径为http://localhost:8080/showLogin

3.2 多个拦截器的执行流程

如果程序中有两个拦截器，分别为Interceptor1和Intercepor2，则这两个拦截器的执行流程如下所示

从图可以看出，当有多个拦截器同时工作时，它们的preHandle()方法会按照配置文件中拦截器的配置顺序执行，而它们的postHandle()方法和afterCompletion()方法则会按照配置顺序的反序执行。

案例：以FirstInterceptor和SecondInterceptor为例，启动程序，url为http://localhost:8080/path/test1/1

url为http://localhost:8080/path/showLogin时，控制台输出为

只有FirstInterceptor拦截到了，SecondInterceptor不对其进行拦截，因为配置了<mvc:exclude-mapping path="/path/showLogin"/>，指明不对其进行拦截