SpringBoot2：请求处理原理分析-接口参数解析原理(argumentResolvers)

已于 2024-09-10 09:31:20 修改
阅读量1.1k 收藏 17
点赞数 27
分类专栏： Spring All 文章标签： spring boot
于 2024-09-06 16:42:08 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Brave_heart4pzj/article/details/141959983
版权

一、知识回顾

我们知道，接口的参数，一般都要配上注解来一起使用。
不同的参数注解，决定了传参的方式不同。

为什么会这样？
如果让你设计接口参数解析，你会怎么做？

首先，我们知道方法参数是形参。具体的实参是request中带来的。
那么springboot底层是如何将path中的实参与接口的形参对应上的？

二、源码解读

首先，我们知道接口肯定是归DispatcherServlet类来管理的，所以，我们直接进入这个类
前面的章节，我们已经知道，接口入口方法是：org.springframework.web.servlet.DispatcherServlet#doDispatch
所以，我们进入这个方法进行断点跟踪并分析原理。

DispatcherServlet#doDispatch方法

1、找到对应request的Handler

这里的原理解释在：
SpringBoot2：请求处理原理分析-请求Path与接口的映射关系(HandlerMapping)
在这里插入图片描述

2、找Handler的适配器

在这里插入图片描述
mappedHandler.getHandler()
这个已经拿到具体的controller了，返回类型是HandlerMehod类型
那么，为什么不直接就反射调用了？还弄个适配器干啥？
在这里插入图片描述
我们进入getHandlerAdapter方法
在这里插入图片描述
这里的适配器，有4种
在这里插入图片描述
我们在看看适配器结构
它是一个接口，有三个方法。
在这里插入图片描述
它有以下几个实现类
在这里插入图片描述
这里我们会发现，实现类有6个，为什么，handlerAdapters变量只有4个了？
我们继续看源码，会发现是通过DispatcherServlet.properties配置好的。
在这里插入图片描述在这里插入图片描述
D:/app/maven/repository/org/springframework/spring-webmvc/5.2.9.RELEASE/spring-webmvc-5.2.9.RELEASE.jar!/org/springframework/web/servlet/DispatcherServlet.properties
在这里插入图片描述
继续往下看
通过getHandlerAdapter方法，我们可以看出，Adapters是通过supports方法来确定具体哪个适配器来处理。
supports的具体逻辑就不看了，因为，每个实现的adapter判断逻辑不通。

也就是说，getHandlerAdapter方法循环遍历四个adapters，通过adapter的supports方法，找到了handler对应的HandlerAdapter类。

3、通过适配器处理controller接口参数

我们常用的是@RequestMapping类型的接口注解。
所以这里，我主要解读一下org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter
在这里插入图片描述
这里，我们可以看出ha.handle是具体的哪个adapter来实现的，从而进入对应的实现类里进行处理。
我这里肯定是进入RequestMappingHandlerAdapter类中看具体逻辑。

3.1、查看RequestMappingHandlerAdapter适配器处理逻辑

org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter#handleInternal
在这里插入图片描述
org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter#invokeHandlerMethod
这里设置参数解析器和返回值处理器。
在这里插入图片描述
有26个参数解析器和15个返回值处理器
在这里插入图片描述
26个参数解析器代码位置：
org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter#getDefaultArgumentResolvers
注意ServletModelAttributeMethodProcessor解析器，添加了2次

private List<HandlerMethodArgumentResolver> getDefaultArgumentResolvers() {
		List<HandlerMethodArgumentResolver> resolvers = new ArrayList<>(30);

		// Annotation-based argument resolution
		resolvers.add(new RequestParamMethodArgumentResolver(getBeanFactory(), false));
		resolvers.add(new RequestParamMapMethodArgumentResolver());
		resolvers.add(new PathVariableMethodArgumentResolver());
		resolvers.add(new PathVariableMapMethodArgumentResolver());
		resolvers.add(new MatrixVariableMethodArgumentResolver());
		resolvers.add(new MatrixVariableMapMethodArgumentResolver());
		resolvers.add(new ServletModelAttributeMethodProcessor(false));
		resolvers.add(new RequestResponseBodyMethodProcessor(getMessageConverters(), this.requestResponseBodyAdvice));
		resolvers.add(new RequestPartMethodArgumentResolver(getMessageConverters(), this.requestResponseBodyAdvice));
		resolvers.add(new RequestHeaderMethodArgumentResolver(getBeanFactory()));
		resolvers.add(new RequestHeaderMapMethodArgumentResolver());
		resolvers.add(new ServletCookieValueMethodArgumentResolver(getBeanFactory()));
		resolvers.add(new ExpressionValueMethodArgumentResolver(getBeanFactory()));
		resolvers.add(new SessionAttributeMethodArgumentResolver());
		resolvers.add(new RequestAttributeMethodArgumentResolver());

		// Type-based argument resolution
		resolvers.add(new ServletRequestMethodArgumentResolver());
		resolvers.add(new ServletResponseMethodArgumentResolver());
		resolvers.add(new HttpEntityMethodProcessor(getMessageConverters(), this.requestResponseBodyAdvice));
		resolvers.add(new RedirectAttributesMethodArgumentResolver());
		resolvers.add(new ModelMethodProcessor());
		resolvers.add(new MapMethodProcessor());
		resolvers.add(new ErrorsMethodArgumentResolver());
		resolvers.add(new SessionStatusMethodArgumentResolver());
		resolvers.add(new UriComponentsBuilderMethodArgumentResolver());

		// Custom arguments
		if (getCustomArgumentResolvers() != null) {
			resolvers.addAll(getCustomArgumentResolvers());
		}

		// Catch-all
		resolvers.add(new RequestParamMethodArgumentResolver(getBeanFactory(), true));
		resolvers.add(new ServletModelAttributeMethodProcessor(true));

		return resolvers;
	}

在这里插入图片描述
15个返回值处理器代码位置
org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter#getDefaultReturnValueHandlers

private List<HandlerMethodReturnValueHandler> getDefaultReturnValueHandlers() {
		List<HandlerMethodReturnValueHandler> handlers = new ArrayList<>(20);

		// Single-purpose return value types
		handlers.add(new ModelAndViewMethodReturnValueHandler());
		handlers.add(new ModelMethodProcessor());
		handlers.add(new ViewMethodReturnValueHandler());
		handlers.add(new ResponseBodyEmitterReturnValueHandler(getMessageConverters(),
				this.reactiveAdapterRegistry, this.taskExecutor, this.contentNegotiationManager));
		handlers.add(new StreamingResponseBodyReturnValueHandler());
		handlers.add(new HttpEntityMethodProcessor(getMessageConverters(),
				this.contentNegotiationManager, this.requestResponseBodyAdvice));
		handlers.add(new HttpHeadersReturnValueHandler());
		handlers.add(new CallableMethodReturnValueHandler());
		handlers.add(new DeferredResultMethodReturnValueHandler());
		handlers.add(new AsyncTaskMethodReturnValueHandler(this.beanFactory));

		// Annotation-based return value types
		handlers.add(new ModelAttributeMethodProcessor(false));
		handlers.add(new RequestResponseBodyMethodProcessor(getMessageConverters(),
				this.contentNegotiationManager, this.requestResponseBodyAdvice));

		// Multi-purpose return value types
		handlers.add(new ViewNameMethodReturnValueHandler());
		handlers.add(new MapMethodProcessor());

		// Custom return value types
		if (getCustomReturnValueHandlers() != null) {
			handlers.addAll(getCustomReturnValueHandlers());
		}

		// Catch-all
		if (!CollectionUtils.isEmpty(getModelAndViewResolvers())) {
			handlers.add(new ModelAndViewResolverMethodReturnValueHandler(getModelAndViewResolvers()));
		}
		else {
			handlers.add(new ModelAttributeMethodProcessor(true));
		}

		return handlers;
	}

执行并处理
在这里插入图片描述
org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod#invokeAndHandle
通过这个名字，我们也可以看出，这里invokeForRequest就是已经处理完请求了。
在这里插入图片描述
进入invokeForRequest
关键代码找到了，getMethodArgumentValues获取方法参数值。
在这里插入图片描述
org.springframework.web.method.support.InvocableHandlerMethod#getMethodArgumentValues

	protected Object[] getMethodArgumentValues(NativeWebRequest request, @Nullable ModelAndViewContainer mavContainer,
			Object... providedArgs) throws Exception {

		MethodParameter[] parameters = getMethodParameters();
		if (ObjectUtils.isEmpty(parameters)) {
			return EMPTY_ARGS;
		}

		Object[] args = new Object[parameters.length];
		for (int i = 0; i < parameters.length; i++) {
			MethodParameter parameter = parameters[i];
			parameter.initParameterNameDiscovery(this.parameterNameDiscoverer);
			args[i] = findProvidedArgument(parameter, providedArgs);
			if (args[i] != null) {
				continue;
			}
			if (!this.resolvers.supportsParameter(parameter)) {
				throw new IllegalStateException(formatArgumentError(parameter, "No suitable resolver"));
			}
			try {
				args[i] = this.resolvers.resolveArgument(parameter, mavContainer, request, this.dataBinderFactory);
			}
			catch (Exception ex) {
				// Leave stack trace for later, exception may actually be resolved and handled...
				if (logger.isDebugEnabled()) {
					String exMsg = ex.getMessage();
					if (exMsg != null && !exMsg.contains(parameter.getExecutable().toGenericString())) {
						logger.debug(formatArgumentError(parameter, exMsg));
					}
				}
				throw ex;
			}
		}
		return args;
	}

首先，我们看下参数解析器 规范
有两个方法
supportsParameter用来判断是否支持解析
resolveArgument用来进行具体的解析操作
在这里插入图片描述
这里用了设计模式中的组合模式
HandlerMethodArgumentResolverComposite实现了HandlerMethodArgumentResolver接口
然后，在该类中循环遍历，是否有解析器可以处理当前参数，如果有，具体怎么解析。

关键代码行
args[i] = this.resolvers.resolveArgument(parameter, mavContainer, request, this.dataBinderFactory);
通过断点，我们可以看出，此时args[i]被赋值了。

继续进入this.resolvers.resolveArgument查看逻辑
在这里插入图片描述
在这里插入图片描述
99行，获取形参名，108行才是给形参赋值。
所以，在108行之前，都是解析接口方法形参。
我们在看下resolveName方法，可以看到，这个方法有很多具体的实现类。
我这里以PathVariable为例子。
在这里插入图片描述
org.springframework.web.servlet.mvc.method.annotation.PathVariableMethodArgumentResolver#resolveName
在这里插入图片描述
可以看出，给形参名的值，是从request中获取到的。这样，形参和实参就对应上了。
那么，这里的request.getAttribute是如何处理好的，这里没有说明。
网上说是通过org.springframework.web.util.UrlPathHelper类实现的。
具体有兴趣的同学自己去研究一下。

那么，到这里，源码逻辑就差不多结束了。

三、逻辑梳理

首先，请求接口进入DispatcherServlet#doDispatch方法

先从handlerMapping中获取具体的handler，即找到具体是哪个controller来处理请求。
而handlerMapping类型默认配置了5种。

找到对应的handler后，在找到对应的handlerAdapter
handlerAdapters适配器类型默认配置了4种。

再然后，通过具体的handlerAdapter来解析方法参数
而解析方法参数，用到了参数解析器argumentResolvers
这里，参数解析器，配置了26种。
并且用了组合模式+缓存来优化性能。

遍历循环参数解析器，找到对应参数的解析器后
在通过接口方法的形参信息，如参数类型，参数名称，参数注解等。
进行具体的参数解析，并从request中获取实参值，赋值给形参，完成参数解析。

生产队队长
关注
专栏目录
Web请求与响应（SpringBoot）
xxxzzzqqq_的博客
03-28 505
HTTP（超文本传输协议）是一种用于 Web 服务器和客户端（浏览器）之间通信以通过 Internet 传输数据的协议。HTTP 请求是客户端向服务器发送的请求特定资源（如网页、图像或视频）的消息。HTTP 请求方法决定了请求的类型，例如 GET、POST、PUT、DELETE、HEAD、OPTIONS、CONNECT、TRACE 等。HTTP响应是由服务器向客户发送的对请求的响应。HTTP 响应包含以下组件：HTTP版本状态码状态消息响应头响应体。
SpringBoot源码——请求全过程源码分析——一步一步详细分析
可乐多点冰的博客
10-15 3706
文章目录前言一、SpringBoot源码二、源码分析1.引入库2.读入数据总结 前言 作为java开发，经常使用SpringBoot框架，那么掌握SpringBoot的请求的全流程还是十分必要的。 没有研究源码之前，有一些疑问： 为什么要返回json串的时候需要在方法上加@ResponseBody，或者在类上加@RestController 为什么返回String类型，不加@ResponseBody，就是要去找视图解析器 返回modelAndVIew类型并加@ResponseBody，那返回的json串
第三课 SpringBoot2基础-请求参数处理和原理
QnHyn
04-29 299
第三课 SpringBoot2基础-请求参数处理和原理 tags: Spring Boot 2021尚硅谷 雷丰阳 categories: 静态文件配置 静态文件配置原理 欢迎页和自定义 Favicon Rest表单请求原理 请求映射原理 各种参数使用和原理 文章目录第三课 SpringBoot2基础-请求参数处理和原理第一节 SpringMVC自动配置概览第二节 静态资源访问2.1 静态资源目录2.2 欢迎页和自定义 Favicon2.3 静态资源配置流程2.4 资源处理的默认规则第三节 请求参数
Springboot（请求处理）参数处理原理--源码分析
最新发布
weixin_52091751的博客
07-27 613
SpringMVC功能分析都从 org.springframework.web.servlet.DispatcherServlet->doDispatch（）
SpringBoot 页面请求处理的源码入门
纯纯打工人
02-20 230
静态/动态资源访问 优先找动态资源，再找静态资源 静态资源访问前缀 spring: mvc: #这个是静态资源访问的前缀，所有需要访问的前缀都需要拼这个才能访问 static-path-pattern: /res/** resources: #这个是静态资源的规定文件夹，配置后只有该文件夹下才能被访问 static-location: classpath:/res/ 欢迎页支持 方式一： 建一个index.html 方式二： 建一个@RequestMapping(“in
SpringBoot第七天 - Web参数处理
adas5f1a51的博客
05-21 389
SpringBoot - Web参数处理 探讨SpringBoot接收和处理参数的方式。 1. 注解方式 SpringMVC为我们提供了许多注解来接收参数。 1.1 常用注解 SpringMVC常用的9个参数绑定注解： @RequestParam 接收请求中的参数； @RequestBody 接收请求体内容； @RequestHeader 接收请求头内容； @RequestAttribute 接收Request域中的参数； @PathVariable 接收请求路径
SpringBoot2学习笔记03
xizheng2018的博客
04-29 468
三十二、请求处理- 【源码分析】 -各种类型参数解析原理 前面我们测试了SpringMVC底层的常用注解，很神奇，只要给参数位置标注这些注解，SpringMVC就会按照你的要求自动的在调用目标方法的时候帮这些参数确定好值，下面就可以使用了 但是确定值的过程以及源码是怎么写的，我们可以看一下，我们所有源码都是从DispatcherServlet开始，处理请求的入口，里面也会涉及到SpringMVC的核心组件 debug来到我们的doDispatch方法，前置的流程差不多过一下， mappedHand
SpringMVC流程源码解析及SpringMVC相关知识点（Spring父子容器，SpringBoot对映射处理器功能拓展实现对静态资源的访问原理）
qq_20395245的博客
05-24 330
本文主要对SpringMVC从接收一个请求，到请求处理结束返回给浏览器的整个过程源码进行学习。为了更好明确学习目标，我们先将上篇文章中SpringMVC的工作流程图还是展示一下，针对图中每一个流程在源码上进行解释其设计和实现思路，中间可能会穿插其它相关联的SpringMVC知识点，这部分关联知识点会分别用独立的文章进行链接描述。最后再对整个工作流程的源码实现进行总结。本文中的代码样例来源于上一篇应用文章https://blog.csdn.net/qq_20395245/article/details/...
SpringBoot2源码笔记
qq_43836796的博客
06-24 357
springboot2雷神教学学习笔记
SpringMVC从配置初始化到HTTP请求全流程解析
IT搬砖工在路上
07-24 682
这里是目录启动SpringBoot中DispatcherServlet的配置请求过程RequestMapping过程HandlerAdapter过程ViewResolver过程扩展点 启动 于SpringMVC来说其实没有启动一说，因为它属于SpringFrameWork的一部分，在Spring启动过程中（ApplicationContext初始化过程）就会同时初始化SpringMVC所需要的组件。 而这里我要说的启动其实是说的SpringMVC的原理，其原理也非常简单，即配置并初始化DispatcherS
spring 自定参数解析器（HandlerMethodArgumentResolver）
热门推荐
逆流_Jun
06-23 3万+
由于之前用@RequestParam无法接受request payload 正文格式为json格式的字符串，只能使用@RequestBody整个接收，觉得麻烦，但是spring自带的参数解析器不具有这种功能，只能尝试着用自定义参数解析器去解决。自定义解析器需要实现HandlerMethodArgumentResolver接口，HandlerMethodArgumentResolver接口包含两个接口
SpringMVC源码分析(九)--返回值解析器
zmbw2015的博客
04-01 2142
本文主要介绍了返回值解析器的使用及其原理
SpringBoot之Rest请求及原理
搬运Gong
02-03 1143
Rest 使用 以前的方式：/getUser 获取用户 /deleteUser 删除用户 /editUser 修改用户 /saveUser 保存用户 现在的方式： /user GET-获取用户 DELETE-删除用户 PUT-修改用户 POST-保存用户 通过 http 请求方式来区分对资源的操作 @RestController public class UserController { @GetMapping("/user")
Springboot请求处理源码分析（含源代码详细注释）
编程小白
04-12 2032
文章目录名词解释handlerhandlerMethod大纲请求映射REST映射原理请求映射原理：怎么知道哪个请求谁来处理参数处理原理代码AbstractHandlerMethodAdapter.javaRequestMappingHandlerAdapter.javaHiddenHttpMethodFilter.javaHttpServlet.javaFrameworkServlet.javaDispatcherServlet.javaAbstractHandlerMapping.javaAbstract
springboot Web开发
TheGreatButton的博客
09-09 379
四、Web开发 1、简介 使用SpringBoot； 1）、创建SpringBoot应用，选中我们需要的模块； 2）、SpringBoot已经默认将这些场景配置好了，只需要在配置文件中指定少量配置就可以运行起来 3）、自己编写业务代码； 自动配置原理？ 这个场景SpringBoot帮我们配置了什么？能不能修改？能修改哪些配置？能不能扩展？xxx xxxxAutoConfiguration：帮我们给容器中自动配置组件； xxxxProperties:配置类来封装配置文件的内容； 2、SpringBoot对
SpringBoot -请求处理原理（浅析）
VillWow的博客
06-06 876
SpringBoot -请求处理原理（浅析）
SpringBoot中请求映射的原理
charlong的博客
01-07 853
SpringBoot中请求映射的原理 学习资源 https://www.yuque.com/atguigu/springboot/vgzmgh https://www.bilibili.com/video/BV19K4y1L7MT?p=28 本图是很久以前学习SpringMVC时的，本次学习拿出来对照收获颇多。 带着问题学习：我们写的接口，是如何被处理的。 在SpringBoot中，所有的请求都是会来到DispatcherServlet中，而这也就是SpringMVC中的东西。 从此图可以看出继承树，最
Springboot中一个请求过来的执行过程
lz710117239的博客
07-18 1万+
有时候我们在springboot中写bean的配置的时候可能会这样写： @Bean public WebClient webClient(ApplicationContext applicationContext) { String name = applicationContext.getApplicationName(); System.out.println(name);...
深入理解SpringBoot原理：启动流程与核心注解解析
- 最后，SpringBoot应用开始运行，监听和处理请求。 SpringBoot通过这些机制实现了“约定优于配置”的原则，大大简化了开发流程。了解这些原理有助于我们更好地理解SpringBoot的工作方式，以便更高效地开发和维护...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值