前言
通过 前面两篇文章 的介绍,相信你对HandlerMethodArgumentResolver了解已经很深刻了。但是你或许和我一样还有一种感觉,似乎还缺点什么:
我们使用非常频繁的@RequestBody是怎么封装请求体的呢???这块使用非常广泛的地方却还木有讲解到,因为它的处理方式和前面的不太一样,因此单摘出来到本文进行详细描述。
第四类:基于ContentType消息转换器类型
利用HttpMessageConverter将输入流转换成对应的参数
这类参数解析器的基类是AbstractMessageConverterMethodArgumentResolver:
// @since 3.1 public abstract class AbstractMessageConverterMethodArgumentResolver implements HandlerMethodArgumentResolver { // 默认支持的方法(没有Deleted方法) // httpMethod为null 或者方法不属于这集中 或者没有contendType且没有body 那就返回null // 也就是说如果是Deleted请求,即使body里有值也是返回null的。(因为它不是SUPPORTED_METHODS ) private static final Set<HttpMethod> SUPPORTED_METHODS = EnumSet.of(HttpMethod.POST, HttpMethod.PUT, HttpMethod.PATCH); private static final Object NO_VALUE = new Object(); protected final List<HttpMessageConverter<?>> messageConverters; protected final List<MediaType> allSupportedMediaTypes; // 和RequestBodyAdvice和ResponseBodyAdvice有关的 private final RequestResponseBodyAdviceChain advice; // 构造函数里指定HttpMessageConverter // 此一个参数的构造函数木人调用 public AbstractMessageConverterMethodArgumentResolver(List<HttpMessageConverter<?>> converters) { this(converters, null); } // @since 4.2 public AbstractMessageConverterMethodArgumentResolver(List<HttpMessageConverter<?>> converters, @Nullable List<Object> requestResponseBodyAdvice) { Assert.notEmpty(converters, "'messageConverters' must not be empty"); this.messageConverters = converters; // 它会把所有的消息转换器里支持的MediaType都全部拿出来汇聚起来~ this.allSupportedMediaTypes = getAllSupportedMediaTypes(converters); this.advice = new RequestResponseBodyAdviceChain(requestResponseBodyAdvice); } // 提供一个defualt方法访问 RequestResponseBodyAdviceChain getAdvice() { return this.advice; } // 子类RequestResponseBodyMethodProcessor有复写此方法 @Nullable protected <T> Object readWithMessageConverters(NativeWebRequest webRequest, MethodParameter parameter, Type paramType) throws IOException, HttpMediaTypeNotSupportedException, HttpMessageNotReadableException { HttpInputMessage inputMessage = createInputMessage(webRequest); return readWithMessageConverters(inputMessage, parameter, paramType); } ... }
说明:此抽象类并没有实现resolveArgument()这个接口方法,而只是提供了一些protected方法,作为工具方法给子类调用,比如最为重要的这个方法:readWithMessageConverters()就是利用消息转换器解析HttpInputMessage的核心。
关于此抽象类的描述,可以看 这里,HttpMessageConverter匹配规则
它的继承树如下:
RequestPartMethodArgumentResolver
它用于解析参数被@RequestPart修饰,或者参数类型是MultipartFile | Servlet 3.0提供的javax.servlet.http.Part类型(并且没有被@RequestParam修饰),数据通过 HttpServletRequest获取
当属性被标注为@RequestPart的话,那就会经过HttpMessageConverter结合Content-Type来解析,这个效果特别像@RequestBody的处理方式~
// @since 3.1 @Target(ElementType.PARAMETER) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface RequestPart { @AliasFor("name") String value() default ""; @AliasFor("value") String name() default ""; boolean required() default true; }
// @since 3.1 public class RequestPartMethodArgumentResolver extends AbstractMessageConverterMethodArgumentResolver { // 标注了@RequestPart注解的 // 没有标注@RequestPart并且也没有标注@RequestParam,但是是Multipart类型的也会处理 @Override public boolean supportsParameter(MethodParameter parameter) { if (parameter.hasParameterAnnotation(RequestPart.class)) { return true; } else { if (parameter.hasParameterAnnotation(RequestParam.class)) { return false; } return MultipartResolutionDelegate.isMultipartArgument(parameter.nestedIfOptional()); } } @Override @Nullable public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer, NativeWebRequest request, @Nullable WebDataBinderFactory binderFactory) throws Exception { HttpServletRequest servletRequest = request.getNativeRequest(HttpServletRequest.class); Assert.state(servletRequest != null, "No HttpServletRequest"); RequestPart requestPart = parameter.getParameterAnnotation(RequestPart.class); boolean isRequired = ((requestPart == null || requestPart.required()) && !parameter.isOptional()); // 如果注解没有指定,就取形参名 String name = getPartName(parameter, requestPart); parameter = parameter.nestedIfOptional(); Object arg = null; // resolveMultipartArgument这个方法只处理: // MultipartFile类型以及对应的数组/集合类型 // Part类型以及对应的数组集合类型 // 若形参类型不是以上类型,返回UNRESOLVABLE(空对象) // 最终返回StandardMultipartHttpServletRequest/request.getParts()[0]等~ Object mpArg = MultipartResolutionDelegate.resolveMultipartArgument(name, parameter, servletRequest); if (mpArg != MultipartResolutionDelegate.UNRESOLVABLE) { arg = mpArg; // 是part类型,那就直接赋值吧 } else { // 其它类型 ... } ... } }
此处理器用于解析@RequestPart参数类型,它和多部分文件上传有关。关于Spring MVC中的文件上传,此处就不便展开了。后面有个专题专门讲解Spring MVC中的上传、下载~
AbstractMessageConverterMethodProcessor(重点)
命名为Processor说明它既能处理入参,也能处理返回值,当然本文的关注点是方法入参(和HttpMessageConverter相关)。
请求body体一般是一段字符串/字节流,查询参数可以看做URL的一部分,这两个是位于请求报文的不同地方。
表单参数可以按照一定格式放在请求体中,也可以放在url上作为查询参数。
响应body体则是response返回的具体内容,对于一个普通的html页面,body里面就是页面的源代码。对于HttpMessage响应体里可能就是个json串(但无强制要求)。
响应体一般都会结合Content-Type一起使用,告诉客户端只有知道这个头了才知道如何渲染。
AbstractMessageConverterMethodProcessor源码稍显复杂,它和Http协议、内容协商有很大的关联:
// @since 3.1 public abstract class AbstractMessageConverterMethodProcessor extends AbstractMessageConverterMethodArgumentResolver implements HandlerMethodReturnValueHandler { // 默认情况下:文件们后缀是这些就不弹窗下载 private static final Set<String> WHITELISTED_EXTENSIONS = new HashSet<>(Arrays.asList("txt", "text", "yml", "properties", "csv", "json", "xml", "atom", "rss", "png", "jpe", "jpeg", "jpg", "gif", "wbmp", "bmp")); private static final Set<String> WHITELISTED_MEDIA_BASE_TYPES = new HashSet<>(Arrays.asList("audio", "image", "video")); private static final List<MediaType> ALL_APPLICATION_MEDIA_TYPES = Arrays.asList(MediaType.ALL, new MediaType("application")); private static final Type RESOURCE_REGION_LIST_TYPE = new ParameterizedTypeReference<List<ResourceRegion>>() { }.getType(); // 用于给URL解码 decodingUrlPathHelper.decodeRequestString(servletRequest, filename); private static final UrlPathHelper decodingUrlPathHelper = new UrlPathHelper(); // rawUrlPathHelper.getOriginatingRequestUri(servletRequest); private static final UrlPathHelper rawUrlPathHelper = new UrlPathHelper(); static { rawUrlPathHelper.setRemoveSemicolonContent(false); rawUrlPathHelper.setUrlDecode(false); } // 内容协商管理器 private final ContentNegotiationManager contentNegotiationManager; // 扩展名的内容协商策略 private final PathExtensionContentNegotiationStrategy pathStrategy; private final Set<String> safeExtensions = new HashSet<>(); protected AbstractMessageConverterMethodProcessor(List<HttpMessageConverter<?>> converters) { this(converters, null, null); } // 可以指定内容协商管理器ContentNegotiationManager protected AbstractMessageConverterMethodProcessor(List<HttpMessageConverter<?>> converters, @Nullable ContentNegotiationManager contentNegotiationManager) { this(converters, contentNegotiationManager, null); } // 这个构造器才是重点 protected AbstractMessageConverterMethodProcessor(List<HttpMessageConverter<?>> converters, @Nullable ContentNegotiationManager manager, @Nullable List<Object> requestResponseBodyAdvice) { super(converters, requestResponseBodyAdvice); // 可以看到:默认情况下会直接new一个 this.contentNegotiationManager = (manager != null ? manager : new ContentNegotiationManager()); // 若管理器里有就用管理器里的,否则new PathExtensionContentNegotiationStrategy() this.pathStrategy = initPathStrategy(this.contentNegotiationManager); // 用safeExtensions装上内容协商所支持的所有后缀 // 并且把后缀白名单也加上去(表示是默认支持的后缀) this.safeExtensions.addAll(this.contentNegotiationManager.getAllFileExtensions()); this.safeExtensions.addAll(WHITELISTED_EXTENSIONS); } // ServletServerHttpResponse是对HttpServletResponse的包装,主要是对响应头进行处理 // 主要是处理:setContentType、setCharacterEncoding等等 // 所以子类若要写数据,就调用此方法来向输出流里写吧~~~ protected ServletServerHttpResponse createOutputMessage(NativeWebRequest webRequest) { HttpServletResponse response = webRequest.getNativeResponse(HttpServletResponse.class); Assert.state(response != null, "No HttpServletResponse"); return new ServletServerHttpResponse(response); } // 注意:createInputMessage()方法是父类提供的,对HttpServletRequest的包装 // 主要处理了:getURI()、getHeaders()等方法 // getHeaders()方法主要是处理了:getContentType()... protected <T> void writeWithMessageConverters(T value, MethodParameter returnType, NativeWebRequest webRequest) throws IOException, HttpMediaTypeNotAcceptableException, HttpMessageNotWritableException { ServletServerHttpRequest inputMessage = createInputMessage(webRequest); ServletServerHttpResponse outputMessage = createOutputMessage(webRequest); writeWithMessageConverters(value, returnType, inputMessage, outputMessage); } // 这个方法省略 // 这个方法是消息处理的核心之核心:处理了contentType、消息转换、内容协商、下载等等 // 注意:此处并且还会执行RequestResponseBodyAdviceChain,进行前后拦截 protected <T> void writeWithMessageConverters(@Nullable T value, MethodParameter returnType, ServletServerHttpRequest inputMessage, ServletServerHttpResponse outputMessage) throws IOException, HttpMediaTypeNotAcceptableException, HttpMessageNotWritableException { ... } }