Spring MVC 拦截器执行流程

Spring MVC-拦截器

今天就是把有关拦截器的知识做一个总结。

1.拦截器概述

1.1 什么是拦截器?

Spring MVC中的拦截器(Interceptor)类似于Servlet中的过滤器(Filter),它主要用于拦截用户请求并作相应的处理。例如通过拦截器可以进行权限验证、记录请求信息的日志、判断用户是否登录等。
要使用Spring MVC中的拦截器,就需要对拦截器类进行定义和配置。通常拦截器类可以通过两种方式来定义。
1.通过实现HandlerInterceptor接口,或继承HandlerInterceptor接口的实现类(如HandlerInterceptorAdapter)来定义。

2.通过实现WebRequestInterceptor接口,或继承WebRequestInterceptor接口的实现类来定义。

以实现HandlerInterceptor接口方式为例,自定义拦截器类的代码如下:

Spring MVC 拦截器执行流程_第1张图片
package com.mmm.interceptors;

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

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


/**
 * 创建自定义的拦截器
 01.务必实现 HandlerInterceptor!
 02.我们使用的拦截器其实就是针对于Handler的拦截器===》处理器拦截器
 03.核心控制器中的HandleMapping返回的就是一个
 处理器执行链 =  Handler+ Interceptors(处理器拦截器)
 */
public class MyInterceptor implements HandlerInterceptor{

    /**
     *
     * @param request
     * @param response
     * @param handler 打印出来com.mmm.controller.UserController@6225177c
     * @return
     * @throws Exception
     *
     *
     *   HandlerInterceptor接口中的三个方法:

            01.preHandle 如果返回值是false,则不会执行后续的操作! 一个拦截器
                preHandle如果返回值是true 则会执行下一个拦截器。。
            02.如果有多个拦截器,则之后拦截器中的所有方法都不会执行!
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("执行了  拦截器1111中的 ===》preHandle");

        return true;
    }

    /**
     * 之后指定了对应Handler中的方法之后 才执行!
     * @param modelAndView 打印出来 ModelAndView: reference to view with name 'success'; model is {welcome=恭喜您登录成功}
     * @throws Exception
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("执行了  拦截器1111中的===》postHandle");

    }

    /**
     * 只要是当前拦截器中的preHandle返回true则此方法必须执行!
     * @param handler   打印出来com.mmm.controller.UserController@6225177c
     * @param ex
     * @throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("执行了  拦截器1111的  ===》afterCompletion");
    }
}

上述代码中,自定义拦截器实现了HandlerInterceptor接口,并实现了接口中的三个方法:

  • preHandle() 方法:该方法会在控制器方法前执行,其返回值表示是否中断后续操作。当其返回值为true时,表示继续向下执行;
    当其返回值为false时,会中断后续的所有操作(包括调用下一个拦截器和控制器类中的方法执行等)。

  • postHandle()方法:该方法会在控制器方法调用之后,且解析视图之前执行。可以通过此方法对请求域中的模型和视图做出进一步的修改。

  • afterCompletion()方法:该方法会在整个请求完成,即视图渲染结束之后执行。可以通过此方法实现一些资源清理、记录日志信息等工作。

1.2 拦截器的配置

开发拦截器就像开发servlet或者filter一样,都需要在配置文件进行配置,配置代码如下:


    
    
        
        
            
            
            
            
        
        
        
            
            
        

    

上面的代码中,元素用于配置一组拦截器,基子元素中定义的是全局拦截器,它会拦截所有的请求;而元素中定义的是指定路径的拦截器,它会对指定路径下的请求生效。元素的子元素用于配置拦截器作用的路径,该路径在其属性path 中定义。如上述代码中 path 的属性值“/**” 表示拦截所有路径,“/hello” 表示拦截所有以 “/hello” 结尾的路径。如果在请求路径中包含不需要拦截的内容,还可以通过元素进行配置。
注意:中的子元素必须按照上述代码中的配置顺序进行编写,即 ,否则文件会报错。

2. 拦截器的执行流程


Spring MVC 拦截器执行流程_第2张图片

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

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

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

Spring MVC 拦截器执行流程_第3张图片

进入了   login
执行了  拦截器1111中的 ===》preHandle
执行了  拦截器2222中的 ===》preHandle
进入了  main
执行了  拦截器2222中的===》postHandle
执行了  拦截器1111中的===》postHandle
执行了  拦截器2222的  ===》afterCompletion
执行了  拦截器1111的  ===》afterCompletion

你可能感兴趣的:(Spring,mvc)