Spring是如何找到URL请求对应的Controller的

2024-09-07 00:18

本文主要是介绍Spring是如何找到URL请求对应的Controller的,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

文章来源

原文作者:Spring MVC 原文地址:
https://blog.csdn.net/hl233211/article/details/77450697
http://ddrv.cn/a/58528
本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。

序:先贴一张SpringMVC整体的框架原理图
在这里插入图片描述
此文主要描述Spring在响应请求的时候是如何根据URL找到对应的处理方法(Handler Method)的。即上图中的第二步(版本号:4.3.4.RELEASE)。

读源码最好的方法是一边调试一边理解,直接靠读很可能最后的结果就是能看懂每行甚至每个方法的意思,但是一串联起来就完全懵圈了,至少我是这个样子的。

1,那么既然要调试,很明显就需要找调试的入口,阅读的起点就在请求分发的地方:DispatcherServlet.doDispatch

此处先大概过一下这个方法,立马我们可以理解根据请求获取对应的处理器主要就在这个方法:getHandler(processedRequest)
在这里插入图片描述
对应的方法详细实现:
在这里插入图片描述
这里可以发现,它的逻辑很简单,就是循环内存中的handlerMappings,请求每个handleMapping返回一个HandlerExecutionChain。这个HandlerExecutionChain主要是包括了一个handler(处理对象,Object类型),以及一个拦截器列表(拦截器非本次研究对象,先无视)。

OK,那代码阅读至此,我们第一个疑问是:

Q1:DispatcherServlet中的handlerMappings是什么,它是哪里来的?

2,然后我们继续看,下面的核心代码是hm.getHandler(request)方法,它被AbstractHandlerMapping这个抽象类实现。
在这里插入图片描述
它直接调用了自身定一个的一个抽象方法:getHandlerInternal,将返回的结果组装成HandlerExecutionChain类型。

AbstractHandlerMethodMapping这个class实现了这个抽象方法
在这里插入图片描述
该方法先根据request获取到请求的资源路劲(lookupPath),然后调用lookupHandlerMethod方法。
在这里插入图片描述
这边代码稍微有点多,但是还是可以理解。它定义了一个matchs的列表,然后内存变量mappingRegistry根据lookupPath获取所有的匹配对象。

如果存在这个匹配对象,那么回调用addMatchingMappings方法将匹配的对象映射到matches上。

如果未匹配到这个lookupPath,那么则会循环mappingRegistry中每个Mapping来匹配该路劲(因为RequestMapping中定义的路劲可以有通配符)。

getMappingsByUrl方法:

在这里插入图片描述
此处又增加一个疑问:

Q2:这个mappingRegistry变量是何物,什么时候将Mapping结果保存的?

那么现在带着Q1和Q2,我们只需要再了解这个方法了:addMatchingMappings,至于后面的代码,只是看看有没有一个请求映射到多个处理方法,如果存在并且优先级还一样,那么就会报错:Ambiguous handler methods mapped for HTTP path。

3,继续往下,以下为addMatchingMappings方法的逻辑:

在这里插入图片描述
注意到AbstractHandlerMethodMapping这个class是个泛型抽象类 getMatchingMapping是个抽象方法,返回值为定义的泛型(T),我们暂且把这个泛型成为[映射信息]。

根据方法名称,T getMatchingMapping(T,reqeust) ,根据映射信息和请求获取是否匹配,如果匹配则返回映射信息。

RequestMappingInfoHandlerMapping这个class继承了这个抽象类,泛型类型为:RequestMappingInfo。看看它的方法实现:

在这里插入图片描述
在这里插入图片描述
前五行根据字面意思是分别根据请求判断各要素是否匹配。后两者其实也是,逻辑大部分都一样。

至于为什么源码立马会拆开写,可能是后两者的match方法更加稍微耗时一点吧。

这里7个要素如果都匹配了的话,那么可以说这个[映射信息]就匹配成功了。(其中前六个为自带属性,最后一个为自定义属性)
7要素分别为:

  1. methods : 请求方法匹配(POST/GET/DELETE/PUT等等),对应RequestMapping注解的method
  2. params : 请求参数匹配 例如myParam=myValue, 对应RequestMapping注解的params
  3. headers:请求头信息(例如:My-Header!=myValue),对应RequestMapping的headers
  4. consumes:提交内容类型(例如:application/json,text/html;),对应RequestMapping的consumes
  5. produces:返回的内容类型(例如:application/json),对应RequestMapping的consumes
  6. patterns:URL格式(例如:test/testDo),对应RequestMapping的value
  7. 自定义条件,后续会针对它再写一篇博文。

这些要素的匹配逻辑比较简单,无非就是把请求中的属性和处理方法ReqeustMapping中的属性值比对是否匹配,此处不再做深入。

Q1:DispatcherServlet中的handlerMappings是什么,它是哪里来的?

DispatcherService的initHandlerMappings中初始化了这个成员变量。
在这里插入图片描述
逻辑无非就是从spring仓库中获取实现了HandleMapping接口的组件。

以我们常用的配置:annotation-driven为例,其对应的处理解析类为AnnotationDrivenBeanDefinitionParser,它的parse方法:
在这里插入图片描述
可以看到,它注册了RequestMappingHandlerMapping这个实现类,而RequestMappingHandlerMapping继承了RequestMappingInfoHandlerMapping

再如通过配置注解的WebMvcConfigurationSupport中,也将RequestMappingHandlerMapping注册在仓库中。
在这里插入图片描述

Q2:AbstractHandlerMethodMapping中的mappingRegistry变量是何物,什么时候将Mapping结果保存的?

主要的成员变量:
在这里插入图片描述
在AbstractHandlerMethodMapping中有个registerHandlerMethod方法,在初始化之后(afterPropertiesSet)对调用该方法

afterPropertiesSet -> initHandlerMethods ->detectHandlerMethods-> registerHandlerMethod
在这里插入图片描述
该方法的逻辑比较好理解,循环一个handler的所有内部方法,获取它的所有方法对应的匹配信息,并且将匹配信息保存在mappingRegistry中。

这里有个需要注意的是 getMappingForMethod 这个抽象方法就是抽取一个Handler里面Method对应的映射信息。

RequestMappingHandlerMapping的实现为:
在这里插入图片描述
先获取method对应的RequestMappingInfo,然后获取类对应的RequestMappingInfo(应为@RequestMapping也可以作为类的注解)最后两者进行combine。

combine逻辑即合并两个RequestMapping,比如类对应的path为 test,Method对应的path为 test1,那么最后合并的path即为 test/test1。

在这里插入图片描述
以下为Spring默认HandleMapping的类图:
在这里插入图片描述
好了,上述都是文字型的东西,下面匹配运行时数据强化记忆吧。

这篇关于Spring是如何找到URL请求对应的Controller的的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1143523

相关文章

SpringMVC获取请求参数的方法

《SpringMVC获取请求参数的方法》:本文主要介绍SpringMVC获取请求参数的方法,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下... 目录1、通过ServletAPI获取2、通过控制器方法的形参获取请求参数3、@RequestParam4、@

SpringBoot应用中出现的Full GC问题的场景与解决

《SpringBoot应用中出现的FullGC问题的场景与解决》这篇文章主要为大家详细介绍了SpringBoot应用中出现的FullGC问题的场景与解决方法,文中的示例代码讲解详细,感兴趣的小伙伴可... 目录Full GC的原理与触发条件原理触发条件对Spring Boot应用的影响示例代码优化建议结论F

springboot项目中常用的工具类和api详解

《springboot项目中常用的工具类和api详解》在SpringBoot项目中,开发者通常会依赖一些工具类和API来简化开发、提高效率,以下是一些常用的工具类及其典型应用场景,涵盖Spring原生... 目录1. Spring Framework 自带工具类(1) StringUtils(2) Coll

SpringBoot条件注解核心作用与使用场景详解

《SpringBoot条件注解核心作用与使用场景详解》SpringBoot的条件注解为开发者提供了强大的动态配置能力,理解其原理和适用场景是构建灵活、可扩展应用的关键,本文将系统梳理所有常用的条件注... 目录引言一、条件注解的核心机制二、SpringBoot内置条件注解详解1、@ConditionalOn

通过Spring层面进行事务回滚的实现

《通过Spring层面进行事务回滚的实现》本文主要介绍了通过Spring层面进行事务回滚的实现,包括声明式事务和编程式事务,具有一定的参考价值,感兴趣的可以了解一下... 目录声明式事务回滚:1. 基础注解配置2. 指定回滚异常类型3. ​不回滚特殊场景编程式事务回滚:1. ​使用 TransactionT

Spring LDAP目录服务的使用示例

《SpringLDAP目录服务的使用示例》本文主要介绍了SpringLDAP目录服务的使用示例... 目录引言一、Spring LDAP基础二、LdapTemplate详解三、LDAP对象映射四、基本LDAP操作4.1 查询操作4.2 添加操作4.3 修改操作4.4 删除操作五、认证与授权六、高级特性与最佳

Spring Shell 命令行实现交互式Shell应用开发

《SpringShell命令行实现交互式Shell应用开发》本文主要介绍了SpringShell命令行实现交互式Shell应用开发,能够帮助开发者快速构建功能丰富的命令行应用程序,具有一定的参考价... 目录引言一、Spring Shell概述二、创建命令类三、命令参数处理四、命令分组与帮助系统五、自定义S

SpringSecurity JWT基于令牌的无状态认证实现

《SpringSecurityJWT基于令牌的无状态认证实现》SpringSecurity中实现基于JWT的无状态认证是一种常见的做法,本文就来介绍一下SpringSecurityJWT基于令牌的无... 目录引言一、JWT基本原理与结构二、Spring Security JWT依赖配置三、JWT令牌生成与

Java中Date、LocalDate、LocalDateTime、LocalTime、时间戳之间的相互转换代码

《Java中Date、LocalDate、LocalDateTime、LocalTime、时间戳之间的相互转换代码》:本文主要介绍Java中日期时间转换的多种方法,包括将Date转换为LocalD... 目录一、Date转LocalDateTime二、Date转LocalDate三、LocalDateTim

如何配置Spring Boot中的Jackson序列化

《如何配置SpringBoot中的Jackson序列化》在开发基于SpringBoot的应用程序时,Jackson是默认的JSON序列化和反序列化工具,本文将详细介绍如何在SpringBoot中配置... 目录配置Spring Boot中的Jackson序列化1. 为什么需要自定义Jackson配置?2.