springmvc(六)拦截器

一、概念

SpringMVC中拦截器(interceptor)是非常重要的，它的主要作用是拦截用户请求，并进行相应的预处理和后处理。

拦截的时间点在“处理器映射器HandlerMapping根据用户请求映射出了所要执行的处理器类，并且也找到了要执行该处理器类的处理器适配器，在处理器适配器HandlerAdaptor执行处理器之前”

在处理器适配器映射出所需要执行的处理器类时，已将拦截器与处理器组合为一个处理器执行链HandlerExecutionChain，并返回给了前端控制器。

自定义拦截器需要实现HandlerInterceptor接口，该接口中含有三个方法：

preHandler(request,response,Object handler)
该方法在处理器方法执行之前执行。其返回值为boolean，若为true，则紧接着会执行处理器方法，且会将afterCompletion()方法放入到一个专门的方法栈中等待执行。

postHandler(request,response,Object Handler,modelAndView)
该方法在处理器方法执行后执行。处理器方法若最终未被执行，则该方法不会被执行。由于该方法是处理器执行之后执行，且方法参数中包含modelAndView,所以该方法可以修改处理器方法执行结果和跳转方向。

afterCompletion(request,response,Object Handler,Exception ex)
当preHandler()返回true时，会将该方法放到专门方法栈中，等待对请求进行响应的
所有工作完成之后才会执行该方法。即该方法是前端控制器渲染了（填充数据）响应页面之后执行，此时对ModelAndView再操作也对响应没有影响。

afterCompletion()是最后执行的方法，用来清除资源，例如：在controller方法中加入数据。

二、自定义拦截器

2.1、拦截器类

/**
 * @Author: JSONLiu
 * @Description: 自定义拦截器
 * @Date Created in 2022-02-08 16:31
 * @Modified By:
 */
public class MyInterceptor implements HandlerInterceptor {

    /**
     * 执行时间：控制器方法执行之前，ModelAndView返回之前
     * 使用场景：登录验证
     * 返回值：true，放行，继续执行控制器方法； false,拦截，不会继续执行控制器方法
     * @param request
     * @param response
     * @param handler
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        System.out.println("------------------------preHandle");
        return true;
    }

    /**
     * 执行时间：控制器方法执行之后，ModelAndView返回之前，可以修改返回值
     * 使用场景：日志记录，记录登录IP，时间等信息
     * @param request
     * @param response
     * @param handler
     * @param modelAndView
     * @throws Exception
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("------------------------postHandle");
    }

    /**
     * 执行时间：控制器方法执行之后，ModelAndView返回之后，不能修改返回值
     * 使用场景：全局资源的操作
     * @param request
     * @param response
     * @param handler
     * @param ex
     * @throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("------------------------afterCompletion");
    }
}

2.2、配置拦截器

在springmvc.xml添加如下配置：

    <!--  配置拦截器  -->
    <mvc:interceptors>
        <!-- 这里可以同时配置多个拦截器，配置的顺序就是拦截器的拦截顺序  -->
        <mvc:interceptor>
            <!--  拦截器要拦截的请求路径，拦截所有用/**  -->
            <mvc:mapping path="/**"/>
            <!--  指定干活的拦截器  -->
            <bean class="com.jsonliu.spring.interceptor.MyInterceptor" id="myInterceptor"></bean>
        </mvc:interceptor>
    </mvc:interceptors>
    <!--
      如果有多个拦截器的时候：
      preHandler：按照配置前后顺序执行
      postHandler:按照配置前后逆序执行
      afterCompletion:按照配置前后逆序执行
      -->