Spring - Controller的方法出入参不同注解时由谁解析？

原创已于 2023-08-30 17:12:33 修改 · 158 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#spring #java #前端

于 2023-08-24 17:19:40 首次发布

spring 专栏收录该内容

9 篇文章

订阅专栏

本文详细解释了DispatcherServlet在处理请求时，如何通过HandlerMethodArgumentResolver解析不同类型的参数，如@RequestBody、RequestParam和MultipartFile，以及HttpMessageConverter在其中的作用和注意事项。

在DispatcherServlet#doDispatch处理外部请求的过程中，执行到方法 ServletInvocableHandlerMethod#invokeAndHandle 逻辑：

HandlerMethodArgumentResolver#resolveArgument 解析入参；使用条件由 #supportsParameter 自定义实现。
HandlerMethodReturnValueHandler#handleReturnValue 包装出参。使用条件由 #supportsReturnType 自定义实现。

接口方法是GET或POST，复杂对象类型入参的注解都可以声明是@RequestBody，关键是：一定要指定contentType(eg. MediaType.APPLICATION_JSON_UTF8)。
否则在解析入参过程里，执行到AbstractMessageConverterMethodArgumentResolver#readWithMessageConverters时会默认设置为MediaType.APPLICATION_OCTET_STREAM；
可能会因没有支持的HttpMessageConverter，导致解析不了入参所以 报错HttpMediaTypeNotSupportedException ！

HttpMessageConverter的#canRead、#canWrite方法会依据支持的对象Class和MediaType来判定是否支持读写；#getSupportedMediaTypes方法返回它支持的MediaType集合.

归纳成以下几种：

@RequestBody ：RequestResponseBodyMethodProcessor
@RequestPart ： RequestPartMethodArgumentResolver
@PathVariable ：PathVariableMethodArgumentResolver
@ModelAttribute ： ModelAttributeMethodProcessor
@RequestParam ： RequestParamMethodArgumentResolver
无注解的 Map ： RequestParamMapMethodArgumentResolver

无注解的复杂类型 - ModelAttributeMethodProcessor.

在#resolveArgument过程里： #createAttribute创建了入参对象实例后，

#bindRequestParameters -> ServletRequestDataBinder#bind ->DataBinder#applyPropertyValues绑定对象属性key对应的入参值（最终是用的setter的Method#invoke）

#validateIfApplicable 将在之后被执行来参数值校验。

无注解的简单类型 - RequestParamMethodArgumentResolver .

要注意的是：显性声明@RequestParam是 'required=true' 的，无注解时默认是非必须的！！

在AbstractNamedValueMethodArgumentResolver#resolveArgument方法体逻辑内，会用来判定执行是否是必传、是否有默认值。

对于MultipartFile类型可以申明为@RequestParam和 @RequestPart 。

在RequestParamMethodArgumentResolver 和RequestPartMethodArgumentResolver里都会提前判定执行到 MultipartResolutionDelegate#resolveMultipartArgument，所以都是可以有效读入文件流的！