SpringMVC拦截器介绍与源码剖析

最新推荐文章于 2023-06-18 21:32:21 发布
最新推荐文章于 2023-06-18 21:32:21 发布
阅读量1.8k 收藏 3
点赞数
文章标签： mvc java spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_41860497/article/details/120690350
版权

本博文基于：

Spring MVC 5.3.1
JDK1.8

SpringMVC拦截器与源码分析

SpringMVC拦截器的作用与应用场景

在处理用户请求之前或者之后，通常需要执行一些行为，如检测用户是否可以登录，或者将请求的信息记录到日志中，时刻的记录当前用户请求的日志信息。Spring MVC提供了拦截器机制，用于请求的预处理和后处理。

假设可能存在这样一个场景，可能本网站注册账号谁都可以注册，但是有些内容需要VIP才能进行访问。这样的需求，就可以通过SpringMVC的拦截器来实现。

通常看到这个需求会想到利用 Java Servlet 的过滤器（Filter）来做，本文中会介绍拦截器和Filter的区别。

拦截器的定义

SpringMVC中的拦截器用于拦截控制器方法的执行,如果要在SpringMVC中定义一个拦截器需要对拦截器进行定义和配置，有两种常用方式：

  1. 实现HandlerInterceptor接口
  2. 继承类HandlerInterceptorAdapter

要实现SpringMVC的拦截器，必须在springmvc.xml文件中进行配置：

<!--springmvc.xml文件中配置拦截器-->
  <mvc:interceptors>
        <!--bean ref方法会拦截所有的请求 一下的两种方式会拦截所有的请求，包括/-->
<!--        <bean class="com.fangshaolei.interceptors.FirstInterceptor"/>-->
<!--        <ref bean="firstInterceptor"/>-->
		<!--配置第一个拦截器-->
        <mvc:interceptor>
            <!--配置拦截的路径 但是 /* 只会拦截一层路径，如果要拦截多层，还需要 /** 来进行配置-->
            <mvc:mapping path="/**"/>
            <!--需要排除不进行拦截的路径-->
            <mvc:exclude-mapping path="/"/>
            <!--注入拦截器-->
            <ref bean="firstInterceptor"/>
        </mvc:interceptor>
        <!--配置第二个拦截器-->
        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <mvc:exclude-mapping path="/"/>
            <ref bean="secondInterceptor"/>
        </mvc:interceptor>
    </mvc:interceptors>

当设置多个拦截器时，先按顺序调用preHandle方法，然后逆序调用每个拦截器的postHandle和afterCompletion方法

两个拦截器实现类：

@Component
public class FirstInterceptor implements HandlerInterceptor 
@Component
public class SecondInterceptor implements HandlerInterceptor

拦截器三个方法

  • preHandle

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

  • postHandle

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

  • afterCompletion

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

多个拦截器的执行顺序

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

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

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

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

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

演示：
在这里插入图片描述
意味着执行的顺序和图 1- 1类似：
在这里插入图片描述

图 1-1

在这里插入图片描述

如果是SecondInterceptor中preHandle()拦截器不放行,则执行的结果如下：
在这里插入图片描述

Servlet Filter 和 SpringMVC 拦截器的区别

由于整个Spring MVC是基于一个DispatcherServlet来进行一系列的操作，可以跳出来看，就是一个Servlet和Filter的区别，在JAVAWEB基础阶段得知，Filter的执行一定是在DispatcherServlet之前的。
而对于Interceptor是对每个映射的Controller来处理和放行操作的。下面是简图，主要体现的是两者的作用位置区别。
在这里插入图片描述

源码解析

在观察拦截器的实现和为什么会出现如此的执行流程：主要涉及到两个类：DispatcherServlet和HandlerExecutionChain这两个类：
我把DispatcherServlet中主要的方法提出来：

doDispatch{
// applyPreHandle 实现的就是preHandler链的调用
	 if (!mappedHandler.applyPreHandle(processedRequest, response)) {
                        return;
      }
      
      // 获取到ModelAndView 对象  方法handle中 有对postHandle方法链进行调用
      mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
      
	// 进行的就是afterCompletion方法调用
	mappedHandler.applyPostHandle(processedRequest, response, mv);
}

HandlerExecutionChain中主要方法提出来：

要注意 private int interceptorIndex;这个成员变量，这是实现拦截器不放行时执行流程的主要。


// =========================执行preHandle=====================================
    boolean applyPreHandle(HttpServletRequest request, HttpServletResponse response) throws Exception {
        for(int i = 0; i < this.interceptorList.size(); this.interceptorIndex = i++) {
            HandlerInterceptor interceptor = (HandlerInterceptor)this.interceptorList.get(i);
            if (!interceptor.preHandle(request, response, this.handler)) {
                this.triggerAfterCompletion(request, response, (Exception)null);
                return false;
            }
        }

        return true;
    }
    
    
// ========================执行PostHandle======================================
    void applyPostHandle(HttpServletRequest request, HttpServletResponse response, @Nullable ModelAndView mv) throws Exception {
        for(int i = this.interceptorList.size() - 1; i >= 0; --i) {
            HandlerInterceptor interceptor = (HandlerInterceptor)this.interceptorList.get(i);
            interceptor.postHandle(request, response, this.handler, mv);
        }

    }
    
    
// ==========================执行afterCompletion====================================
     void triggerAfterCompletion(HttpServletRequest request, HttpServletResponse response, @Nullable Exception ex) {
        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);
            }
        }

    }

applyPreHandle方法内部：
在这里插入图片描述
其中interceptor就是从集合中取出各个拦截器的操作，而interceptor所调用的方法，就是自己定义的preHandler方法的执行，如果方法返回false，则会执行if中的方法。

其中this.triggerAfterCompletion(request, response, (Exception)null);执行interceptor中的方法afterCompletion.在执行每一步操作，都会通过interceptorIndex记录下上一次的索引。

比如，以例子为例，applyPreHandle在正常执行之后，interceptorIndex为 3. 返回为true，不会执行DispatcherServlet中return方法，所以会继续执行返回的handle方法。 handle方法调用HandlerExecutionChain中的applyPostHandle.
而方法applyPostHandle执行的是:

 for(int i = this.interceptorList.size() - 1; i >= 0; --i) {
           HandlerInterceptor interceptor = (HandlerInterceptor)this.interceptorList.get(i);
           interceptor.postHandle(request, response, this.handler, mv);
       }

从interceptorList.size倒叙执行，所以，在正常的情况下，postHandle方法逆向输出。

对于afterCompletion为什么不是通过interceptorList.size，而是通过 interceptorIndex来作为起始执行索引呢？

这是由于考虑到preHandle中不放行，而interceptorIndex由上文分析得，记录的是上次访问拦截器的索引，所以在 第一个FirstInterceptor不放行的情况下，会出现如下这种现象。原因是interceptorIndex
在这里插入图片描述

     void triggerAfterCompletion(HttpServletRequest request, HttpServletResponse response, @Nullable Exception ex) {
        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);
            }
        }

    }

推荐阅读

Servlet Filter 和 SpringMVC 拦截器的区别
SpringMVC拦截器执行流程
SpringMVC拦截器简介
【参考博文】

https://blog.csdn.net/drdongshiye/article/details/88583967
https://www.cnblogs.com/yuxiaole/p/9969360.html
https://blog.csdn.net/weixin_44751434/article/details/119358203?spm=1001.2014.3001.5501

Fon |
关注
SpringMVC进阶（三） SpringMVC框架源码深度剖析
舞鹤白沙编码日志
01-08 644
一. SpringMVC框架源码剖析准备工作 （一）前段控制器DispatcherServlet继承结构图 （二）SpringMVC源码剖析准备工作 1. 下载并在IDEA中导入spring-5.1x_ch源码，工程使用Gradle管理 2. 在上述工程中新建一个SpringMVC测试模块 3. 在测试模块的handle方法中打断点，做为SpringMVC请求处理流程的开始 Debug模式启动Tomcat,在前端发申请，并观察调用栈 根据上图得知：doDispathch⽅法中的1.
springMVC3学习(七)--Interceptor拦截器(源码)
05-19
springMVC3学习(七)--Interceptor拦截器(源码) 文章地址：http://blog.csdn.net/itmyhome1990/article/details/26286107
SpringMVC源码阅读：过滤器
Jinyao的博客
02-28 492
SpringMVC源码阅读：过滤器 1.前言 SpringMVC是目前J2EE平台的主流Web框架，不熟悉的园友可以看SpringMVC源码阅读入门,它交代了SpringMVC的基础知识和源码阅读的技巧 本文将通过源码(基于Spring4.3.7)分析，弄清楚SpringMVC过滤器是如何执行的，并自定义过滤器，分清楚过滤器和拦截器的区别 2...
springMvc 拦截器源码解析
y936992174的博客
09-03 266
统一请求处理 dispatcherServlet 类图结构 前端请求过来先进入servlet 的 service 方法 // FrameWorkServlet @Override protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { HttpMethod httpMethod = HttpMethod.res
spring mvc的拦截器源码分析
weixin_43866043的博客
01-15 1043
上面说了dispatcher servlet的执行流程源码，现在分析下拦截器的源码 首先看下自己的的interceptor ，然后还需要将inerceptor注册到WebMvcConfigurer中 实现 package com.example.demo.config; import org.springframework.context.annotation.Configuration; import org.springframework.lang.Nullable; import org.sprin
springMVC 详细版本 拦截器源码
03-01
springMVC 拦截器源代码 内有详细文档介绍操作 @Override public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3) throws Exception { //可以通过ModelAndView arg3参数来改变显示的视图，或发往视图的方法 } //返回值表示是否需要将当前的请求拦截下来 // 如果返回false，请求将被终止 // 如果返回true，请求会被继续运行 // Object arg2 表示被拦截的请求的目标对象
Java进阶之SpringMVC源码深度剖析共12页.pd
11-20
本资料“Java进阶之SpringMVC源码深度剖析共12页.pdf”是对SpringMVC核心原理的深入探讨，通过分析源码来帮助开发者更深入地理解其工作原理。 1. **SpringMVC概述** SpringMVC是Spring框架的一个模块，主要负责...
SpringMVC源码剖析（一）- 从抽象和接口说起1
08-03
`HandlerExecutionChain`包含了实际处理请求的处理器以及相关的拦截器。在`DispatcherServlet`中，多个`HandlerMapping`的实现会被遍历，直到找到第一个匹配的处理器链。 `HandlerMapping`接口中的其他常量，如`...
powernode_springmvc源码.zip
08-02
本文将围绕"powernode_springmvc源码.zip"中的各个章节，深入剖析 Spring MVC 的核心概念和工作原理。 1. **第一章：Hello Spring MVC** 这部分通常会介绍如何创建一个基本的 Spring MVC 项目，包括配置文件的设置...
Spring MVC源码深度剖析开源架构源码2021.pdf
04-27
本知识点将围绕Spring MVC的源码深度剖析展开，详细介绍Spring MVC的源码结构、工作原理以及如何进行源码分析。 首先，要理解Spring MVC是如何启动和配置的。在web.xml文件中配置了DispatcherServlet，这是Spring ...
010-Spring MVC 拦截器及其源码解析
这个需求，做不了
11-01 420
HandlerInterceptor Spring MVC 中拦截器的顶层接口如下： package org.springframework.web.servlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import org.springframework.lang.Nullable; public interface HandlerInterceptor
springmvc拦截器及源码分析
黑马程序员官方博客
07-24 284
前言 springmvc拦截器是我们项目开发中用到的一个功能，常常用于对Handler进行预处理和后处理。本案例来演示一个较简单的springmvc拦截器的使用，并通过分析源码来探究拦截器的执行顺序是如何控制的。 1、springmvc拦截器使用 1.1 项目初始搭建 1.1.1 创建一个maven的war工程 ​ 该步骤不再截图说明 1.1.2 引入maven依赖 <dependencies> <dependency> <groupId
springmvc拦截器工作源码
joenqc的博客
08-22 1090
当一个请求到达后，会调用DispatcherServlet的doDispatch( )方法，在此方法中调用拦截器，调用方法栈如下：doDispatch( )方法源码如下：protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception { HandlerEx
SpringMVC源码系列-拦截器
Adam_allen的博客
05-01 603
1.简介 2.重要的接口及类 2.1 HandlerInterceptor 2.2 HandlerInterceptorAdapter 3.执行流程 4.拦截器的使用 4.1 继承HandlerInterceptorAdapter 4.2 在spring-mvc.xml配置拦截器 4.3 Controller编写 5.源码分析 6.多拦截器的执行情况 6.1配置多个拦截器 6.2 各种...
SpringMvc拦截器和手写模拟SpringMvc工作流程源码详解
最新发布
qq_43649937的博客
06-18 4469
Spring SpringMvc java
SpringMVC拦截器之拦截器入门代码
weixin_40055163的博客
10-22 653
SpringMVC拦截器之拦截器入门代码 1.编写拦截器的类代码如下： package com.txw.controller.interceptor; import org.springframework.web.servlet.HandlerInterceptor; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; /** *自定义拦截器 * @author Ada
SpringMVC拦截器源码解析
sxudong2010的博客
03-21 285
版权声明：本文为CSDN博主「风剑无影」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。 原文链接：https://blog.csdn.net/dreamcatcher1314/article/details/80956074 前言：提到拦截器，我们一定会想到Spring Aop。在看SpringMVC源码以前，一直以为SpringMVC的拦截器是用Spring Aop的动态代理来实现，并且也很困惑，如果用动态代理如何实现拦截器？这里就不介绍Spring Aop实现拦截器的
SpringMVC_拦截器_源码分析
底层码农
08-03 6103
SpringMVC_拦截器_源码分析
SpringMVC执行流程详解：深度剖析与入门指南
本文主要探讨了SpringMVC的执行过程，SpringMVC是Spring框架中的一个重要组件，用于构建基于模型-视图-控制器（Model-View-Controller, MVC）的Web应用程序。文章首先概述了Spring框架的结构，特别强调了Web模块内的...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值