SpringMVC-拦截器

Posted 2023-03-30 poixao

SpringMVC-拦截器

• 1、拦截器的配置
• 2、拦截器的三个抽象方法
• 3、拦截器三个抽象方法执行顺序
• 4、多个拦截器的执行顺序
• • 演示
  • 源码分析

 
 

 
 

1、拦截器的配置

SpringMVC中的拦截器用于拦截控制器方法的执行

SpringMVC中的拦截器需要实现HandlerInterceptor

@Component
public class FirstInterceptor implements HandlerInterceptor 
    //控制器方法之前执行
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception 
        System.out.println("FirstInterceptor --> preHandle");
        //是否放行
        return true; //false拦截 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");
    

SpringMVC的拦截器必须在SpringMVC的配置文件中进行配置：

<!--配置拦截器-->
<mvc:interceptors>
    <!--对所有请求进行拦截-->
    <!--<bean class="com.study.mvc.interceptors.FirstInterceptor"></bean>-->
    <!--<ref bean="firstInterceptor"></ref>-->
    <mvc:interceptor>
        <!--
            "/*" 只能对一级目录进行拦截
            "/**" 对多级目录进行拦截
        -->
        <mvc:mapping path="/**"/>
        <mvc:exclude-mapping path="/"/>
        <ref bean="firstInterceptor"></ref>
    </mvc:interceptor>
</mvc:interceptors>

以上配置方式可以通过ref或bean标签设置拦截器，通过mvc:mapping设置需要拦截的请求，通过mvc:exclude-mapping设置需要排除的请求，即不需要拦截的请求

 

2、拦截器的三个抽象方法

SpringMVC中的拦截器有三个抽象方法：

preHandle：控制器方法执行之前执行preHandle()，其boolean类型的返回值表示是否拦截或放行，返回true为放行，即调用控制器方法；返回false表示拦截，即不调用控制器方法

postHandle：控制器方法执行之后执行postHandle()

afterComplation：处理完视图和模型数据，渲染视图完毕之后执行afterComplation()

 
 

3、拦截器三个抽象方法执行顺序

preHandle --> 控制器方法 --> postHandle --> this.render(输出视图) --> afterComplation


追进去

 

4、多个拦截器的执行顺序

a>若每个拦截器的preHandle()都返回true

此时多个拦截器的执行顺序和拦截器在SpringMVC的配置文件的配置顺序有关：

preHandle()会按照配置的顺序执行，而postHandle()和afterComplation()会按照配置的反序执行

b>若某个拦截器的preHandle()返回了false

preHandle()返回false和它之前的拦截器的preHandle()都会执行，postHandle()都不执行，返回false的拦截器之前的拦截器的afterComplation()会执行

 

当每个拦截器的preHandle()都返回true：preHandle()会按照配置的顺序执行，而postHandle()和afterComplation()会按照配置的反序执行
 
若某个拦截器的preHandle()返回了false：当前拦截器(false)和之前的拦截器的preHandle()都会执行，postHandle()都不执行，当前拦截器(false)之前的拦截器的afterComplation()会执行

 

演示

创建两个拦截器

@Component
public class FirstInterceptor implements HandlerInterceptor 
    //控制器方法之前执行
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception 
        System.out.println("FirstInterceptor --> preHandle");
        //是否放行
        return true; //false拦截 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");
    

@Component
public class SecondInterceptor implements HandlerInterceptor 

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception 
        System.out.println("SecondInterceptor --> preHandle");
        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");
    

在配置文件中配置拦截器
执行顺序按照配置文件中配置的顺序执行

   <!--配置拦截器-->
    <mvc:interceptors>
        <!--对所有请求进行拦截-->
        <ref bean="firstInterceptor"></ref>
        <ref bean="secondInterceptor"></ref>
    </mvc:interceptors>

查看效果

 

源码分析

执行链有两个部分：
1、控制器方法
2、拦截器集合

applyPreHandle

boolean applyPreHandle(HttpServletRequest request, HttpServletResponse response) throws Exception 
    //循环执行链中所有的拦截器
    //每执行完一个拦截器的preHandle方法，将当前索引复制给interceptorIndex(默认为-1)
    //1. 如果拦截器全部执行完，那么interceptorIndex = 最后一个拦截器的索引
    //2. 如果有一个拦截器在执行preHandle()为false时，那么 interceptorIndex = 当前拦截器前一个索引值
    for(int i = 0; i < this.interceptorList.size(); this.interceptorIndex = i++) 
        //正序取出
        HandlerInterceptor interceptor = (HandlerInterceptor)this.interceptorList.get(i);
        //返回值如果为false，执行以下代码
        if (!interceptor.preHandle(request, response, this.handler)) 
            this.triggerAfterCompletion(request, response, (Exception)null);
            return false;
        
    
	//拦截器都会true，返回true
    return true;

applyPostHandle

void applyPostHandle(HttpServletRequest request, HttpServletResponse response, @Nullable ModelAndView mv) throws Exception 
    //倒序执行拦截器的postHandle()方法
    //注意：i = interceptorList.size() - 1
    for(int i = this.interceptorList.size() - 1; i >= 0; --i) 
        HandlerInterceptor interceptor = (HandlerInterceptor)this.interceptorList.get(i);
        interceptor.postHandle(request, response, this.handler, mv);
    

triggerAfterCompletion

void triggerAfterCompletion(HttpServletRequest request, HttpServletResponse response, @Nullable Exception ex) 
    //倒序执行拦截器的afterCompletion()方法
    //注意：i = this.interceptorIndex
    for(int i = this.interceptorIndex; i >= 0; --i) 
        HandlerInterceptor interceptor = (HandlerInterceptor)this.interceptorList.get(i);
        try 
            interceptor.afterCompletion(request, response, this.handler, ex);
         catch (Throwable var7) 
            logger.error("HandlerInterceptor.afterCompletion threw exception", var7);