SpringBoot之请求映射原理

前言

我们发出的请求，SpringMVC是如何精准定位到那个Controller以及具体方法？其实这都是 HandlerMapping 发挥的作用，这篇博文我们以 RequestMappingHandlerMapping 为例并结合源码一步步进行分析。

定义HandlerMapping

默认 HandlerMapping 主要定义在 EnableWebMvcConfiguration 和其祖父类 WebMvcConfigurationSupport 中

EnableWebMvcConfiguration
@Bean
@Primary
@Override
public RequestMappingHandlerMapping requestMappingHandlerMapping(@Qualifier("mvcContentNegotiationManager") ContentNegotiationManager contentNegotiationManager,@Qualifier("mvcConversionService") FormattingConversionService conversionService,@Qualifier("mvcResourceUrlProvider") ResourceUrlProvider resourceUrlProvider) {// Must be @Primary for MvcUriComponentsBuilder to workreturn super.requestMappingHandlerMapping(contentNegotiationManager, conversionService,resourceUrlProvider);
}@Bean
public WelcomePageHandlerMapping welcomePageHandlerMapping(ApplicationContext applicationContext,FormattingConversionService mvcConversionService, ResourceUrlProvider mvcResourceUrlProvider) {WelcomePageHandlerMapping welcomePageHandlerMapping = new WelcomePageHandlerMapping(new TemplateAvailabilityProviders(applicationContext), applicationContext, getWelcomePage(),this.mvcProperties.getStaticPathPattern());welcomePageHandlerMapping.setInterceptors(getInterceptors(mvcConversionService, mvcResourceUrlProvider));welcomePageHandlerMapping.setCorsConfigurations(getCorsConfigurations());return welcomePageHandlerMapping;
}
WebMvcConfigurationSupport
@Bean
public BeanNameUrlHandlerMapping beanNameHandlerMapping(@Qualifier("mvcConversionService") FormattingConversionService conversionService,@Qualifier("mvcResourceUrlProvider") ResourceUrlProvider resourceUrlProvider) {BeanNameUrlHandlerMapping mapping = new BeanNameUrlHandlerMapping();mapping.setOrder(2);PathMatchConfigurer pathConfig = getPathMatchConfigurer();if (pathConfig.getPatternParser() != null) {mapping.setPatternParser(pathConfig.getPatternParser());}else {mapping.setUrlPathHelper(pathConfig.getUrlPathHelperOrDefault());mapping.setPathMatcher(pathConfig.getPathMatcherOrDefault());}mapping.setInterceptors(getInterceptors(conversionService, resourceUrlProvider));mapping.setCorsConfigurations(getCorsConfigurations());return mapping;
}@Bean
public RouterFunctionMapping routerFunctionMapping(@Qualifier("mvcConversionService") FormattingConversionService conversionService,@Qualifier("mvcResourceUrlProvider") ResourceUrlProvider resourceUrlProvider) {RouterFunctionMapping mapping = new RouterFunctionMapping();mapping.setOrder(3);mapping.setInterceptors(getInterceptors(conversionService, resourceUrlProvider));mapping.setCorsConfigurations(getCorsConfigurations());mapping.setMessageConverters(getMessageConverters());PathPatternParser patternParser = getPathMatchConfigurer().getPatternParser();if (patternParser != null) {mapping.setPatternParser(patternParser);}return mapping;
}@Bean
@Nullable
public HandlerMapping resourceHandlerMapping(@Qualifier("mvcContentNegotiationManager") ContentNegotiationManager contentNegotiationManager,@Qualifier("mvcConversionService") FormattingConversionService conversionService,@Qualifier("mvcResourceUrlProvider") ResourceUrlProvider resourceUrlProvider) {Assert.state(this.applicationContext != null, "No ApplicationContext set");Assert.state(this.servletContext != null, "No ServletContext set");PathMatchConfigurer pathConfig = getPathMatchConfigurer();ResourceHandlerRegistry registry = new ResourceHandlerRegistry(this.applicationContext,this.servletContext, contentNegotiationManager, pathConfig.getUrlPathHelper());addResourceHandlers(registry);AbstractHandlerMapping handlerMapping = registry.getHandlerMapping();if (handlerMapping == null) {return null;}if (pathConfig.getPatternParser() != null) {handlerMapping.setPatternParser(pathConfig.getPatternParser());}else {handlerMapping.setUrlPathHelper(pathConfig.getUrlPathHelperOrDefault());handlerMapping.setPathMatcher(pathConfig.getPathMatcherOrDefault());}handlerMapping.setInterceptors(getInterceptors(conversionService, resourceUrlProvider));handlerMapping.setCorsConfigurations(getCorsConfigurations());return handlerMapping;
}

PS：WebMvcConfigurationSupport 中定义的 HandlerMapping 不止上述三个，但是有效的只有三个 （SpringBoot 版本 2.6.13），有的 HandlerMapping 需要满足一定条件才生效。

初始化

initHandlerMappings
private void initHandlerMappings(ApplicationContext context) {this.handlerMappings = null;if (this.detectAllHandlerMappings) {// Find all HandlerMappings in the ApplicationContext, including ancestor contexts.Map<String, HandlerMapping> matchingBeans =BeanFactoryUtils.beansOfTypeIncludingAncestors(context, HandlerMapping.class, true, false);if (!matchingBeans.isEmpty()) {this.handlerMappings = new ArrayList<>(matchingBeans.values());// We keep HandlerMappings in sorted order.AnnotationAwareOrderComparator.sort(this.handlerMappings);}}else {try {HandlerMapping hm = context.getBean(HANDLER_MAPPING_BEAN_NAME, HandlerMapping.class);this.handlerMappings = Collections.singletonList(hm);}catch (NoSuchBeanDefinitionException ex) {// Ignore, we'll add a default HandlerMapping later.}}// Ensure we have at least one HandlerMapping, by registering// a default HandlerMapping if no other mappings are found.if (this.handlerMappings == null) {this.handlerMappings = getDefaultStrategies(context, HandlerMapping.class);if (logger.isTraceEnabled()) {logger.trace("No HandlerMappings declared for servlet '" + getServletName() +"': using default strategies from DispatcherServlet.properties");}}for (HandlerMapping mapping : this.handlerMappings) {if (mapping.usesPathPatterns()) {this.parseRequestPath = true;break;}}
}
detectAllHandlerMappings 属性是否为 true （默认为true）
  • true：获取 BeanFactory 中类型为 HandlerMapping 的 beans
  • false : 获取 BeanFactory 中类型为 HandlerMapping，beanName为 handlerMapping 的 bean
如果 detectAllHandlerMappings 属性为 true，则会对查找到的 beans 进行排序，排序规则如下：
  1. HandlerMapping 是否继承 PriorityOrdered 接口，如果都继承 PriorityOrdered 接口，比较getOrder方法返回的值，值越小，优先级越高
  2. HandlerMapping 是否继承 Ordered 接口，如果都继承 Ordered接 口，比较 getOrder 方法返回的值，值越小，优先级越高
  3. HandlerMapping 所属class上是否存在 @Order 注解，如果存在，比较注解设置的值，值越小，优先级越高
  4. HandlerMapping 所属class上是否存在 @Priority 注解，如果存在，比较注解设置的值，值越小，优先级越高
如果从 BeanFactory 中未获取到相关 HandlerMapping，则使用默认 HandlerMapping

默认的 HandlerMapping 定义在 DispatcherServlet.properties 文件中

默认HandlerMapping为

  • BeanNameUrlHandlerMapping
  • RequestMappingHandlerMapping
  • RouterFunctionMapping

请求映射

DispatcherServlet#doDispatch

DispatcherServlet#getHandler

一共有五个 HandlerMapping （SpringBoot 版本 2.6.13，最新版本貌似有6个，大家自行验证一下），即我们上文所分析的在类EnableWebMvcConfiguration、WebMvcConfigurationSupport 中定义的 HandlerMapping

如果某个 HandlerMapping 的 getHandler 方法返回了一个有效的 HandlerExecutionChain，我们就可以认为这个 HandlerMapping 可以处理这个请求。接下里以 RequestMappingHandlerMapping 为例进行分析，大部分请求也都是由这个 HandlerMapping 处理的

PS : WelcomePageHandlerMapping 就是处理欢迎页的

RequestMappingHandlerMapping的实例化

RequestMappingHandlerMapping的类继承关系

通过上图，我们知道其祖父类（AbstractHandlerMethodMapping） 继承 InitializingBean 接口，继承 InitializingBean 接口的类会在bean的实例化过程中执行 afterPropertiesSet 方法

AbstractHandlerMethodMapping#afterPropertiesSet

获取所有类型是 Object 的 beans，并且 beanName 不以 scopedTarget. 开头

AbstractHandlerMethodMapping#processCandidateBean

根据 beanName 获取 beanType

AbstractHandlerMethodMapping#isHandler

如果 beanType 上存在 @Controller 、@RequestMapping 注解则进行处理

AbstractHandlerMethodMapping#detectHandlerMethods

主要有三个方法 selectMethods、getMappingForMethod、registerHandlerMethod

  1. selectMethods ：遍历类中定义的方法以及接口实现方法（方法不能是合成的、桥接的，返回类型不能是Object ），如果某个方法执行接口函数（主体是 getMappingForMethod 方法）的返回值不为null，则将其放入一个类型为 Map<Method, T> 的 Map 中
  2. getMappingForMethod：如果方法存在 @RequestMapping （@GetMapping、@PostMapping、@PutMapping、@DeleteMapping 等）注解，则构建一个 RequestMappingInfo 对象
  3. registerHandlerMethod ： 遍历 selectMethods 方法的返回结果（Map<Method, T>），将其注册到 AbstractHandlerMethodMapping 的 mappingRegistry 属性中

PS : 经过测试，如果存在 @RequestMapping 注解，即使方法的描述符是 private，也可以接受请求

RequestMappingHandlerMapping的getHandler方法

AbstractHandlerMapping#getHandler

RequestMappingInfoHandlerMapping#getHandlerInternal

AbstractHandlerMethodMapping#getHandlerInternal

AbstractHandlerMethodMapping#lookupHandlerMethod

假设有一个UserController，明细由下方所示，我们来看一下这个 mappingRegistry 属性的结构

@RestController
public class UserController {@GetMapping("/user")public String getUser() {return "get user";}@PostMapping("/user")public String postUser() {return "post user";}@PutMapping("/user")public String putUser() {return "put user";}@DeleteMapping("/user")public String deleteUser() {return "delete user";}
}

URI 和具体方法的映射关系，都存储在 mappingRegistry 这个属性中

扩展：自定义HandlerMapping

创建 CustomHandlerMapping
public class CustomHandlerMapping implements HandlerMapping, PriorityOrdered {private ApplicationContext applicationContext;public CustomHandlerMapping(ApplicationContext applicationContext) {this.applicationContext = applicationContext;}@Overridepublic HandlerExecutionChain getHandler(HttpServletRequest request) throws Exception {String beanName = request.getParameter("beanName");String methodName = request.getParameter("method");if (StringUtils.isBlank(beanName) || StringUtils.isBlank(methodName) || !applicationContext.containsBean(beanName)) {return null;}Object object = applicationContext.getBean(beanName);Method method = null;Method[] declaredMethods = object.getClass().getDeclaredMethods();for (Method declaredMethod : declaredMethods) {if (declaredMethod.getName().equals(methodName)) {method = declaredMethod;break;}}if (method == null) {return null;}HandlerMethod handlerMethod = new HandlerMethod(object, method);return new HandlerExecutionChain(handlerMethod);}@Overridepublic int getOrder() {return 0;}
}

继承 PriorityOrdered 接口，让我们自定义的 HandlerMapping 优先级最高

创建 HandlerMappingConfig
@Configuration
public class HandlerMappingConfig implements ApplicationContextAware {private ApplicationContext applicationContext;@Overridepublic void setApplicationContext(ApplicationContext applicationContext) throws BeansException {this.applicationContext = applicationContext;}@Beanpublic CustomHandlerMapping customHandlerMapping() {return new CustomHandlerMapping(applicationContext);}
}
创建 CustomHandlerMappingController 
@Component("chmc")
public class CustomHandlerMappingController {@ResponseBodypublic String hello() {return "hello HandlerMapping! ";}
}
发送请求 localhost:8080?beanName=chmc&method=hello

自定义 handlerMapping 生效

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/pingmian/27271.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

赶紧收藏！2024 年最常见 20道并发编程面试题（五）

赶紧收藏！2024 年最常见 20道并发编程面试题（五）

上一篇地址&#xff1a;赶紧收藏&#xff01;2024 年最常见 20道并发编程面试题&#xff08;四&#xff09;-CSDN博客 九、什么是信号量&#xff08;Semaphores&#xff09;&#xff1f; 信号量&#xff08;Semaphores&#xff09;是一种用于控制多个线程或进程对共享资源访问…
阅读更多...
Docker部署常见应用之桌面版系统ubuntu-desktop

Docker部署常见应用之桌面版系统ubuntu-desktop

文章目录 ubuntu-desktop 简介ubuntu-desktop 部署参考文章 ubuntu-desktop 简介 colinchang/ubuntu-desktop 是一个Docker镜像&#xff0c;基于KasmWeb⁠的 Ubuntu 22.04 桌面版&#xff08;Web&#xff09; Docker Image。镜像替换了阿里云Ubuntu Jammy镜像源&#xff0c;安…
阅读更多...
0074__Microsoft Typography documentation

0074__Microsoft Typography documentation

Microsoft Typography documentation - Typography | Microsoft Learn
阅读更多...
重生之 SpringBoot3 入门保姆级学习（21、场景整合 Redis 定制对象序列化存储）

重生之 SpringBoot3 入门保姆级学习（21、场景整合 Redis 定制对象序列化存储）

重生之 SpringBoot3 入门保姆级学习&#xff08;21、场景整合 Redis 定制对象序列化存储&#xff09; 6.4 定制化 6.4 定制化 需求&#xff1a;保存一个 Person 对象到 redis 创建 Person 类 package com.zhong.redis.entity;import lombok.AllArgsConstructor; import lombok…
阅读更多...
HTML5网页成品（普洱茶购买）

HTML5网页成品（普洱茶购买）

1.完整代码 <!doctype html> <html> <head> <meta charset"utf-8"> <title>无标题文档</title> <style> .span{border: 1px solid #BCB9B9;margin: 2px 5px;color: #6B76EF} </style> </head> …
阅读更多...
浅谈C++基本框架内涵及其学习路线

浅谈C++基本框架内涵及其学习路线

目录 一.C的内涵本质 1. 面向对象编程&#xff08;OOP&#xff09; 2. 低级控制 3. 模板编程 4. 标准库&#xff08;STL&#xff09; 5. 多范式支持 二.学习路线 1. 基础阶段 C基础语法 函数 数组和指针 2. 面向对象编程 类和对象 继承和多态 运算符重载 3. 高级…
阅读更多...
JS 【算法】二分查找

JS 【算法】二分查找

使用场景 在有序数组中查找目标元素 const arr [1, 2, 3, 4, 5, 6, 7, 8, 9] const target 2 console.log(binarySearch1(arr, target)) console.log(binarySearch2(arr, target))循环实现 function binarySearch1(arr, target) {const length arr.lengthif (length 0) re…
阅读更多...
Mysql的基础命令有哪些？

Mysql的基础命令有哪些？

MySQL的基础命令主要涵盖了连接数据库、操作数据库、操作表、插入数据、查询数据等多个方面。以下是对这些基础命令的清晰归纳&#xff1a; 1. 连接MySQL 格式: mysql -h主机地址 -u用户名 -p用户密码 连接到本机上的MySQL: mysql -uroot -p &#xff08;如果root用户没有密码…
阅读更多...
DP专项训练

DP专项训练

第一题 来源:P3609 [USACO17JAN] Hoof, Paper, Scissor G 题意 给你n个蹄子/剪刀/布&#xff0c;在你没改变前出法均相同&#xff0c;可以改k次之后最多的相同的局数有多少。做法 线性DP 因为手势用的字符表示&#xff0c;为方便可以转换为数字 void calc(int i,char a){…
阅读更多...
【服务的主从切换实现原理】

【服务的主从切换实现原理】

文章目录 主从架构介绍zookeeper利用ZK实现主从架构 主从架构介绍 主从服务架构是一种常见的分布式系统设计模式&#xff0c;常用于提高系统的性能、可用性和扩展性。在这种架构中&#xff0c;系统中的节点被分为两类&#xff1a;主节点&#xff08;Master&#xff09;和从节点…
阅读更多...
斯坦福的新工具，生物计算，操作系统与AI融合之路

斯坦福的新工具，生物计算，操作系统与AI融合之路

一支烟花官网&#xff1a; https://agifun.love 智源社区 斯坦福让“GPU高速运转”的新工具火了&#xff0c;比FlashAttention2更快 西风 发自 凹非寺量子位 | 公众号 QbitAIAI算力资源越发紧张的当下&#xff0c;斯坦福新研究将GPU运行效率再提升一波——内核只有100行代码…
阅读更多...
Java基础面试重点-1

Java基础面试重点-1

0. 符号&#xff1a; *&#xff1a;记忆模糊&#xff0c;验证后特别标注的知识点。 &&#xff1a;容易忘记知识点。 *&#xff1a;重要的知识点。 1. 简述一下Java面向对象的基本特征&#xff08;四个&#xff09;&#xff0c;以及你自己的应用&#xff1f; 抽象&#…
阅读更多...
R可视化：ggpubr包学习

R可视化：ggpubr包学习

欢迎大家关注全网生信学习者系列&#xff1a; WX公zhong号&#xff1a;生信学习者 Xiao hong书&#xff1a;生信学习者 知hu&#xff1a;生信学习者 CDSN&#xff1a;生信学习者2 介绍 ggpubr是我经常会用到的R包&#xff0c;它傻瓜式的画图方式对很多初次接触R绘图的人来…
阅读更多...
淘宝/1688获得店铺的所有商品（商品列表）

淘宝/1688获得店铺的所有商品（商品列表）

通过以下步骤&#xff0c;可以获得淘宝或1688店铺的所有商品。请注意&#xff0c;具体步骤可能会因为平台的更新而有所改变&#xff0c;可以根据实际情况进行操作。 更多API调用展示以及获取Key和secret请移步 返回数据格式&#xff1a; {"user": null,"ite…
阅读更多...
python 简单demo

python 简单demo

import pyttsx3def read_poem_with_voice(filename):"""使用女声从文本文件中读取古诗词并朗读:param file_path: 文本文件的路径"""engine pyttsx3.init() # 初始化语音引擎# 设置语速&#xff08;范围通常是50-200&#xff09;engine.setPro…
阅读更多...
提升你的编程体验：自定义 PyCharm 背景图片

提升你的编程体验：自定义 PyCharm 背景图片

首先&#xff0c;打开 PyCharm 的设置菜单&#xff0c;点击菜单栏中的 File > Settings 来访问设置&#xff0c;也可以通过快捷键 CtrlAItS 打开设置。 然后点击Appearance & Behavior > Appearance。 找到Background image...左键双击进入。 Image:传入自己需要设置…
阅读更多...
c++_0基础_讲解4 变量定义

c++_0基础_讲解4 变量定义

变量 C 中的变量是存储数据值的容器&#xff0c;这些值可以在程序执行过程中被修改和使用。在 C 中&#xff0c;变量必须先声明后使用&#xff0c;声明变量也可以称之为定义变量&#xff0c;它告诉编译器在何处以及如何去分配存储空间。接下来我将对 C 中的变量定义进行详细的介…
阅读更多...
常见的 EVM 版本以及它们的区别

常见的 EVM 版本以及它们的区别

EVM&#xff08;以太坊虚拟机&#xff09;版本的演进是为了引入新的特性和改进以太坊平台的安全性、效率和功能性。每个版本通常伴随着以太坊网络的硬分叉&#xff0c;这是以太坊协议的重大升级。以下是一些常见的EVM版本及其主要区别&#xff1a; Homestead (2016年3月)&…
阅读更多...
中国首台！紧随美国，重磅发布100比特中性原子量子计算机

中国首台！紧随美国，重磅发布100比特中性原子量子计算机

2024年6月11日上午&#xff0c;“武汉量子论坛—2024”隆重开幕&#xff0c;国家自然科学基金委员会主任窦贤康院士&#xff0c;武汉大学校长张平文院士&#xff0c;以及叶朝辉、徐红星、祝世宁等院士出席大会。在会议上&#xff0c;中科酷原重磅发布国内首台原子量子计算机——…
阅读更多...
利用 HTML5 Canvas 实现在线签字功能

利用 HTML5 Canvas 实现在线签字功能

目录 前言 一、HTML5 Canvas 简介 二、签字功能的实现 效果演示 完整代码 前言 在现代互联网应用中&#xff0c;有时我们需要让用户在网页上进行签字操作&#xff0c;比如确认文件、填写电子表格或者签署合同。利用 HTML5 的 canvas 画布&#xff0c;我们可以轻松地实现这一…
阅读更多...
最新文章

Copyright @ 2022~2023