2021-09-25 SpringMVC拦截器

SpringMVC拦截器

1.1 拦截器（interceptor）的作用

Spring MVC 的拦截器类似于 Servlet 开发中的过滤器 Filter，用于对处理器进行预处理和后处理。将拦截器按一定的顺序联结成一条链，这条链称为拦截器链（Interceptor Chain）。在访问被拦截的方法或字段时，拦截器链中的拦截器就会按配置的顺序被调用。拦截器也是AOP思想的具体实现。

区别	过滤器（Filter）	拦截器（Interceptor）
使用范围	是 servlet 规范中的一部分，任何 Java Web 工程都可以使用	是 SpringMVC 框架的一部分，只有使用了 SpringMVC 框架的工程才能用
拦截范围	在 url-pattern 中配置了/*之后， 可以对所有要访问的资源拦截	在<mvc:mapping path=“”/>中配置了/**之 后，也可以多所有资源进行拦截，但是可以通 过<mvc:exclude-mapping path=“”/>标签 排除不需要拦截的资源

1.2 拦截器快速入门

① 创建拦截器类实现HandlerInterceptor接口

package com.raphuscucullatus.interceptor;

import org.springframework.lang.Nullable;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * intercepter快速开始
 *
 * @author raphus cucullatus
 * @version 2021/9/24 9:29
 * @since JDK8
 */
public class CustomInterceptor implements HandlerInterceptor {
    /**
     * 目标方法执行前
     * @param request
     * @param response
     * @param handler
     * @return
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler){
        System.out.println("目标方法执行前");
        //返回值:决定是否即是否返回视图以及执行后续拦截操作(即执行postHandle/afterCompletion方法)
        return true;
    }

    /**
     * 目标方法开始执行,且视图返回前
     * @param request
     * @param response
     * @param handler
     * @param modelAndView
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView){
        System.out.println("目标方法开始执行,且视图返回前");
    }

    /**
     * 目标表方法执行结束后
     * @param request
     * @param response
     * @param handler
     * @param ex
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex){
        System.out.println("目标表方法执行结束后");
    }
}

② 配置拦截器

<!--
  配置SpringMVC拦截器(类似filter)
-->
<mvc:interceptors>
    <mvc:interceptor>
        <!--      拦截所有资源      -->
        <mvc:mapping path="/**"/>
        <bean class="com.raphuscucullatus.interceptor.CustomInterceptor"/>
    </mvc:interceptor>
</mvc:interceptors>

③ 测试拦截器的拦截效果

目标方法执行前
设置姓名...
目标方法开始执行,且视图返回前
目标表方法执行结束后

1.3SpringMVC拦截器说明

方法名	说明
preHandle()	方法将在请求处理之前进行调用，该方法的返回值是布尔值Boolean类型的， 当它返回为false 时，表示请求结束，后续的Interceptor 和Controller 都不会 再执行；当返回值为true 时就会继续调用下一个Interceptor 的preHandle 方 法
postHandle()	该方法是在当前请求进行处理之后被调用，前提是preHandle 方法的返回值为 true 时才能被调用，且它会在DispatcherServlet 进行视图返回渲染之前被调 用，所以我们可以在这个方法中对Controller 处理之后的ModelAndView 对象 进行操作
afterCompletion()	该方法将在整个请求结束之后，也就是在DispatcherServlet 渲染了对应的视图 之后执行，前提是preHandle 方法的返回值为true 时才能被调用