Spring MVC : 框架缺省的控制器方法参数解析器

最新推荐文章于 2025-07-02 08:00:00 发布
原创 最新推荐文章于 2025-07-02 08:00:00 发布 · 1.2k 阅读 · 2 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#HandlerMethodArgumentResolver

本文介绍SpringMVC中参数解析器HandlerMethodArgumentResolver的工作原理及其重要实现类。通过不同的解析器，SpringMVC能有效处理@RequestParam、@PathVariable等注解，并支持简单及复杂类型的参数解析。

使用Spring MVC进行Web应用开发时，请求参数接收是很重要的一个方面。一般情况下，我们可以通过request.getParameter(name)这种方式来获取指定名称参数的值，这种方式是由Servlet容器自身提供的。但使用这种方式会导致开发人员必须在控制器方法中书写仅用于接收参数的逻辑，在参数量多的情况下，这部分代码甚至占据了方法体的大部分，而核心业务逻辑反而淹没其中。为了使开发人员从这种窘境中解脱出来提高生产效率，关注核心业务，Spring MVC提供了各种便利工具来接收参数，同时也将该关注点从主业务逻辑中分离出来。

Spring MVC所提供的这些工具，有@PathVariable,@RequestParam,@RequestBody,@RequestParam,@CookieValue等注解，也有对一些类直接支持逻辑。本文不讲这些注解或者被支持的类如何使用以及它们的目的，而是看看针对这些便利工具，Spring MVC在背后所提供的参数解析器：HandlerMethodArgumentResolver。

下表是Spring Web MVC所提供的参数解析器实现类：

控制器方法参数解析器所能解析的参数的类型特征
RequestParamMethodArgumentResolver@RequestParam并且参数类型不是Map
RequestParamMapMethodArgumentResolver@RequestParam并且参数类型是Map
PathVariableMethodArgumentResolver@PathVariable并且参数类型不是Map
PathVariableMapMethodArgumentResolver@PathVariable并且参数类型是Map
MatrixVariableMethodArgumentResolver@MatrixVariable并且参数类型不是Map
MatrixVariableMapMethodArgumentResolver@MatrixVariable并且参数类型是Map
ServletModelAttributeMethodProcessor@ModelAttribute,Servlet相关
RequestResponseBodyMethodProcessor@RequestBody,@ResponseBody
RequestPartMethodArgumentResolver@RequestPart
RequestHeaderMethodArgumentResolver@RequestHeader并且参数类型不是Map
RequestHeaderMapMethodArgumentResolver@RequestHeader并且参数类型是Map
ServletCookieValueMethodArgumentResolver@CookieValue
ExpressionValueMethodArgumentResolver@Value
SessionAttributeMethodArgumentResolver@SessionAttribute
RequestAttributeMethodArgumentResolver@RequestAttribute
ServletRequestMethodArgumentResolverWebRequest,
ServletRequest,
MultipartRequest,
HttpSession,
PushBuilder,
Principal,
InputStream,
Reader,
HttpMethod,
Locale,
TimeZone,
java.time.ZoneId
ServletResponseMethodArgumentResolverServletResponse,OutputStream,Writer
HttpEntityMethodProcessorHttpEntity,RequestEntity,ResponseEntity
RedirectAttributesMethodArgumentResolverRedirectAttributes
ModelMethodProcessorModel类型的参数和返回值
MapMethodProcessorMap类型的参数和返回值
ErrorsMethodArgumentResolverErrors
SessionStatusMethodArgumentResolverSessionStatus
UriComponentsBuilderMethodArgumentResolverUriComponentsBuilder

Spring MVC应用缺省使用类型为RequestMappingHandlerAdapter 的bean组件requestMappingHandlerAdapter调用每个请求对应的控制器方法。在bean组件requestMappingHandlerAdapter初始化时，它会构建一个HandlerMethodArgumentResolverComposite对象，该对象是多个HandlerMethodArgumentResolver的一个集合：

    // RequestMappingHandlerAdapter 代码片段
    // RequestMappingHandlerAdapter 的初始化方法
	@Override
	public void afterPropertiesSet() {
		// Do this first, it may add ResponseBody advice beans
		initControllerAdviceCache();

		if (this.argumentResolvers == null) {
			// 获取缺省的 HandlerMethodArgumentResolver， 多个
			List<HandlerMethodArgumentResolver> resolvers = getDefaultArgumentResolvers();
			// 构造 HandlerMethodArgumentResolverComposite 对象，
			// 包装缺省的多个 HandlerMethodArgumentResolver
			this.argumentResolvers = 
				new HandlerMethodArgumentResolverComposite().addResolvers(resolvers);
		}
		if (this.initBinderArgumentResolvers == null) {
			List<HandlerMethodArgumentResolver> resolvers = getDefaultInitBinderArgumentResolvers();
			this.initBinderArgumentResolvers = 
				new HandlerMethodArgumentResolverComposite().addResolvers(resolvers);
		}
		if (this.returnValueHandlers == null) {
			List<HandlerMethodReturnValueHandler> handlers = getDefaultReturnValueHandlers();
			this.returnValueHandlers = 
				new HandlerMethodReturnValueHandlerComposite().addHandlers(handlers);
		}
	}

从上面的代码可见，缺省使用的控制器方法参数解析器由getDefaultInitBinderArgumentResolvers()提供。该方法实现如下：

	// RequestMappingHandlerAdapter 代码片段
	private List<HandlerMethodArgumentResolver> getDefaultArgumentResolvers() {
		List<HandlerMethodArgumentResolver> resolvers = new ArrayList<>();

		// 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 ， 如果上面的参数解析器都处理不了，尝试使用下面的解析器尝试兜底
		// true 表示 : 即使不使用注解 @RequestParam ，简单类型的方法参数也会被认为是请求参数被解析，
		// 此时请求参数名称会根据方法参数名称派生而来。
		resolvers.add(new RequestParamMethodArgumentResolver(getBeanFactory(), true));
		// true 表示 : 即使不使用注解 @ModelAttribute,非简单类型的方法参数和返回值也会被认为
		// 是 model attribute 
		resolvers.add(new ServletModelAttributeMethodProcessor(true));

		return resolvers;
	}

上面方法中参数解析器添加的顺序很重要，因为为每个参数寻找参数解析器时，会按照以上添加顺序去寻找第一个能够解析该参数的参数解析器。

另外，以上这些的HandlerMethodArgumentResolver继承/实现关系如下所示 :

  • HandlerMethodArgumentResolver
    • AbstractNamedValueMethodArgumentResolver
      • AbstractCookieValueMethodArgumentResolver
        • ServletCookieValueMethodArgumentResolver
      • ExpressionValueMethodArgumentResolver
      • RequestHeaderMethodArgumentResolver
      • RequestParamMethodArgumentResolver
      • MatrixVariableMethodArgumentResolver
      • PathVariableMethodArgumentResolver
      • RequestAttributeMethodArgumentResolver
      • SessionAttributeMethodArgumentResolver
    • AbstractWebArgumentResolverAdapter
      • ServletWebArgumentResolverAdapter
    • ErrorsMethodArgumentResolver
    • MapMethodProcessor
    • ModelAttributeMethodProcessor
      • ServletModelAttributeMethodProcessor
    • ModelMethodProcessor
    • RequestHeaderMapMethodArgumentResolver
    • RequestParamMapMethodArgumentResolver
    • SessionStatusMethodArgumentResolver
    • AbstractMessageConverterMethodArgumentResolver
      • AbstractMessageConverterMethodProcessor
        • HttpEntityMethodProcessor
        • RequestResponseBodyMethodProcessor
      • RequestPartMethodArgumentResolver
    • MatrixVariableMapMethodArgumentResolver
    • PathVariableMapMethodArgumentResolver
    • RedirectAttributesMethodArgumentResolver
    • ServletRequestMethodArgumentResolver
    • ServletResponseMethodArgumentResolver
    • UriComponentsBuilderMethodArgumentResolver
    • HandlerMethodArgumentResolverComposite

参考文章

SpringBoot编程基础教程：Spring MVC框架
AI天才研究院
10-16 491
Spring是一个开源的Java开发框架，它提供了基于Java的轻量级WEB开发的最佳实践。在WEB应用开发中，SpringMVC是其中的一个重要组件。它基于Servlet API构建，帮助开发者快速创建、测试及部署WEB应用。但是，学习SpringMVC并不是一件容易的事情。对于初级到中级开发人员来说，掌握SpringMVC可能比较困难。因此，本文将从以下几个方面进行讲解：1.Spring Boot简介：这是一种快速启动的Java应用程序框架，可以轻松创建独立运行的Spring应用。
全面解读Spring Cloud Zuul：从配置到优化的实战指南
热门推荐
曾经“等你生日那天”都遥远得像未来，如今却可欢愉的挥手说“下个十年见”
02-14 168万+
在微服务架构中，API网关作为核心组件之一，承担着请求路由、负载均衡、安全认证等重要功能。Spring Cloud Zuul作为一款功能强大的API网关解决方案，得到了广泛应用。本文将深入探讨Spring Cloud Zuul的各项功能，从基础配置到工作原理，再到多层负载和应用优化，全面解析其在实际应用中的最佳实践与实用技巧，为开发者提供一站式指导，助力其打造高性能、高可用的微服务架构。
Spring 参数解析器
大魔王的博客
09-12 1280
一、背景 在实际开发中，某些场景下要求开发者对前台传入的参数进行个性化解析、校验、或者获取header中信息等等，这时候我们就需要利用自定义参数解析器来满足这些需求 二、DispatcherServlet运行流程 DispatcherServlet 的结构如下，可以看出这个本质上还是个servlet 在实际的调用逻辑中，前端请求过来之后执行 servlet 的 service() 方法，方法核心调用 DispatcherServlet 的 doservice() 方法，其中最核心的是 dodis
spring参数解析器介绍和自定义参数解析器
生而为人我很抱歉
07-18 796
参数解析器属于spring-web包中提供的组件，springmvc框架中对应提供了很多参数解析器。@PostMapping("/save")//此处request对象就是通过Springmvc提供的参数解析器帮我们注入的publicStringsaveUser(HttpServletRequestrequest){}}在上面的saveUser方法中，我们声明了一个类型为的参数，这个对象就是通过springmvc提供的这个参数解析器帮我们注入的。}和。当方法返回true时，才会调用。...
Spring参数解析器
骑个小蜗牛的博客
09-21 5516
RequestMappingHandlerAdapter 请求映射处理适配器 HandlerMethodArgumentResolver 参数解析器 HandlerMethodArgumentResolver和AbstractNamedValueMethodArgumentResolver是解析策略的上层定义和抽象。 关于这两个类可以参考https://securitit.blog.youkuaiyun.com/article/details/110110872的解析。 HandlerMethodArgumentRe
Spring MVC的参数解析器【一】
weixin_44117861的博客
11-13 197
form表单参数传入后，SpringMVC解析
自定义 Spring 参数解析器
weixin_49137820的博客
12-31 532
因为业务需求, 有时候在handler中多次处理同一个逻辑并将结束后的对象传递给业务层, 此时我们也想像 Spring 自动解析handler上的参数一样简单, 于是就可以实现 Spring 提供的 HandlerMethodArgumentResolver 拓展接口, 然后交给 Spring MVC 进行管理.
SpringBoot Spring MVC
专注基础架构领域
03-17 6146
这个注释的意思是，当调用这个方法的时候，会从一个名叫accountCache的缓存中查询，如果没有，则执行实际的方法（即查询数据库），并将执行的结果存入缓存中，否则返回缓存中的对象。作用：@responseBody注解的作用是将controller的方法返回的对象通过适当的转换器转换为指定的格式之后，写入到response对象的body区，通常用来返回JSON数据，需要注意的是，在使用此注解之后不会再走视图处理器，而是直接将数据写入到输入流中，他的效果等同于通过response对象输出指定格式的数据。
外文翻译Spring的MVC构架模式
05-11
Spring 的 Web MVC 构架模式是 Spring 框架中的一种重要部分，它提供了一个基于模型-视图-控制器（MVC）架构的 Web 应用程序开发模式。这种模式使得开发者可以更容易地开发和维护大型 Web 应用程序。 1. 介绍 ...
外文翻译-Spring的web-MVC-构架模式 (2).pdf
10-27
缺省控制器接口简单，可以支持多层控制结构，如AbstractController、AbstractCommandController、MultiActionController等。 - **模型与视图**：Spring的数据绑定机制允许灵活地操作和验证模型对象，而不局限于特定...
springmvc自定义属性编辑器和参数解析器
08-03
springmvc自定义属性编辑器和参数解析器
spring 自定义参数解析器
12-10 601
一、自定义参数解析器说明 spring最为优秀的地方在于，它的设计方式。依赖注入的bean管理方式、和面向接口编程的设计方式。很多模块或者功能，它提供了接口规范，和默认实现。开发者可以很方便的去自己实现它定义的接口，就具备了相应的功能。spring mvn 的自定义参数解析器...
Spring中常见的参数解析器
欢迎一起学习交流
06-23 344
Spring中常见的参数解析器
认识Spring参数解析器
BASK2312的博客
12-10 423
子菜单用children存放。
SpringMVC系列-4 参数解析器
shengyu
10-06 3809
本文作为SpringMVC系列的第四篇，介绍参数解析器。本文讨论的参数解析表示从HTTP消息中解析出JAVA对象或流对象并传参给Controller接口的过程。 本文内容包括介绍参数解析器工作原理、常见的参数解析器、自定义参数解析器等三部分。其中，原理部分会结合源码进行说明。
【Spring】Spring源码分析 参数解析器 HandlerMethodArgumentResolver
九师兄
06-30 300
RequestParam注解我们用到的比较多，被这个注解标注的参数，会从request的请求参数中取值，参数值为request.getParameter(“@RequestParam注解name的值”)/*** 对应request中参数名称*//*** 同value*//*** 请求中是否必须有这个参数*//*** 默认值*/
Spring 源码学习 10：参数解析器
最新发布
梦幻天空
07-02 991
本文介绍了Spring框架中处理控制器方法参数的解析器，主要探讨了RequestParamMethodArgumentResolver的用法。通过示例展示了如何解析带有@RequestParam注解的参数、未注解参数以及使用环境变量的默认值参数。文章还指出需要配合数据绑定工厂和Bean工厂才能实现完整功能，并介绍了使用HandlerMethodArgumentResolverComposite组合多个解析器的方法。通过MockHttpServletRequest模拟HTTP请求，演示了参数解析的具体过程，包
Spring核心接口：HandlerMethodArgumentResolver参数解析器
five-five
03-25 2060
在Spring中，参数解析器是一个接口，它负责将HTTP请求中的参数解析为控制器方法的参数。Spring提供了许多内置的参数解析器，用于处理不同类型的请求参数，例如查询参数、路径变量、请求头、请求体等。开发人员还可以自定义参数解析器，以处理特定的请求参数。除了Spring提供的内置参数解析器外，开发人员还可以自定义参数解析器，以处理特定的请求参数。自定义参数解析器需要实现HandlerMethodArgumentResolver接口，并在配置类中将其添加到WebMvcConfigurer中。
springMVC源码分析--RequestParamMethodArgumentResolver参数解析器（三）
井底之蛙
01-10 1万+
之前两篇博客springMVC源码分析--HandlerMethodArgumentResolver参数解析器（一）和 springMVC源码解析--HandlerMethodArgumentResolverComposite参数解析器集合（二）我们对参数解析器有一些了解了，接下来这篇博客我们选取一个HandlerMethodArgumentResolver的具体实现类RequestParamMe
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值