Java学习之SpringMVC中的@RequestBody
引⾔：
接上⼀篇⽂章讲述处理@RequestMapping的⽅法参数绑定之后，详细介绍下@RequestBody、@ResponseBody的具体⽤法和使⽤时机；
简介：
@RequestBody
作⽤：
i) 该注解⽤于读取Request请求的body部分数据，使⽤系统默认配置的HttpMessageConverter进⾏解析，然后把相应的数据绑定到要返回的对象上；
ii) 再把HttpMessageConverter返回的对象数据绑定到 controller中⽅法的参数上。
使⽤时机：
A) GET、POST⽅式提时，根据request header Content-Type的值来判断:
application/x-www-form-urlencoded，可选（即⾮必须，因为这种情况的数据@RequestParam, @ModelAttribute也可以处理，当然@RequestBody也能处理）；
multipart/form-data, 不能处理（即使⽤@RequestBody不能处理这种格式的数据）；
其他格式，必须（其他格式包括application/json, application/xml等。这些格式的数据，必须使⽤@RequestBody来处理）；
B) PUT⽅式提交时，根据request header Content-Type的值来判断:
application/x-www-form-urlencoded，必须；
multipart/form-data, 不能处理；
其他格式，必须；
说明：request的body部分的数据编码格式由header部分的Content-Type指定；
@ResponseBody
作⽤：
该注解⽤于将Controller的⽅法返回的对象，通过适当的HttpMessageConverter转换为指定格式后，写⼊到Response对象的body数据区。
使⽤时机：
返回的数据不是html标签的页⾯，⽽是其他某种格式的数据时（如json、xml等）使⽤；
HttpMessageConverter
该接⼝定义了四个⽅法，分别是读取数据时的 canRead(), read() 和 写⼊数据时的canWrite(), write()⽅法。
在使⽤ <mvc:annotation-driven />标签配置时，默认配置了RequestMappingHandlerAdapter （注意是RequestMappingHandlerAdapter 不是AnnotationMethodHandlerAdapter，详情查看Spring 3.1 document “16.14 Configuring Spring MVC”章节），并为他配置了⼀下默认的HttpMessageConverter ：01. <span >/** 02.  * Strategy interface that specifies a converter that can convert from and to HTTP requests and responses. 03.  * 04.  * @author Arjen Poutsma  05.  * @author Juergen Hoeller  06.  * @since 3.0 07.  */  08. public  interface  HttpMessageConverter<T> {  09.  10.    /** 11.      * Indicates whether the given class can be read by
this converter. 12.      * @param clazz the class to test for readability  13.      * @param mediaType the media type to read, can be {@code null} if not specified. 14.      * Typically the value of a {@code Content-Type} header. 15.      * @return {@code true} if readable; {@code false} otherwise  16.      */  17.    boolean  canRead(Class<?> clazz, MediaType mediaType);  18.  19.    /** 20.      * Indicates whether the given class can be written by this converter. 21.      * @param clazz the class to test for writability  22.      * @param mediaType the media type to write, can be {@code null} if not specified. 23.      * Typically the value of an {@code Accept} header. 24.      * @return {@code true} if writable; {@code false} otherwise  25.      */  26.    boolean  canWrite(Class<?> clazz, MediaType mediaType);  27.  28.    /** 29.      * Return the list of {@link MediaType} objects supported by this converter. 30.      * @return the list of supported media types  31.      */  32.    List<MediaType> getSupportedMediaTypes();  33.  34.    /** 35.      * Read an object of the given type form the given input message, and returns it. 36.      * @param clazz the type of object to return. This type must have previously been passed to the  37.      * {@link #canRead canRead} method of this interface, which must have returned {@code true}. 38.      * @param inputMessage the HTTP input message to read from  39.      * @return the converted object  40.      * @throws IOException in case of I/O errors  41.      * @throws HttpMessageNotReadableException in case of conversion errors  42.      */  43.    T read(Class<? extends  T> clazz, HttpInputMessage inputMessage)  44.            throws  IOExc
eption, HttpMessageNotReadableException;  45.  46.    /** 47.      * Write an given object to the given output message. 48.      * @param t the object to write to the output message. The type of this object must have previously been  49.      * passed to the {@link #canWrite canWrite} method of this interface, which must have returned {@code true}. 50.      * @param contentType the content type to use when writing. May be {@code null} to indicate that the  51.      * default content type of the converter must be used. If not {@code null}, this media type must have  52.      * previously been passed to the {@link #canWrite canWrite} method of this interface, which must have  53.      * returned {@code true}. 54.      * @param outputMessage the message to write to  55.      * @throws IOException in case of I/O errors  56.      * @throws HttpMessageNotWritableException in case of conversion errors  57.      */  58.    void  write(T t, MediaType contentType, HttpOutputMessage outputMessage)  59.            throws  IOException, HttpMessageNotWritableException;  60.  61. }  62. </span>
17.
ByteArrayHttpMessageConverter: 负责读取⼆进制格式的数据和写出⼆进制格式的数据；
StringHttpMessageConverter：负责读取字符串格式的数据和写出⼆进制格式的数据；
ResourceHttpMessageConverter：负责读取资源⽂件和写出资源⽂件数据；
FormHttpMessageConverter：负责读取form提交的数据（能读取的数据格式为 application/x-www-form-urlencoded，不能读取multipart/form-data格式数据）；负责写⼊application/x-www-from-urlencoded和multipart/form-data格式的数据；
MappingJacksonHttpMessageConverter:  负责读取和写⼊json格式的数据；
SouceHttpMessageConverter：负责读取和写⼊ xml 中ansform.Source定义的数据；
Jaxb2RootElementHttpMessageConverter:  负责读取和写⼊xml 标签格式的数据；
AtomFeedHttpMessageConverter:              负责读取和写⼊Atom格式的数据；
RssChannelHttpMessageConverter:          负责读取和写⼊RSS格式的数据；
当使⽤@RequestBody和@ResponseBody注解时，RequestMappingHandlerAdapter就使⽤它们来进⾏读取或者写⼊相应格式的数据。HttpMessageConverter匹配过程：
@RequestBody注解时：根据Request对象header部分的Content-Type类型，逐⼀匹配合适的HttpMessageConverter来读取数据；spring 3.1源代码如下：
@ResponseBody 注解时： 根据Request 对象header 部分的Accept 属性（逗号分隔），逐⼀按accept 中的类型，去遍历到能处理的HttpMessageConverter ；
源代码如下：补充：30. [java]
01. <span >private  void  writeWithMessageConverters(Object returnValue,  02.                HttpInputMessage inputMessage, HttpOutputMessage outputMessage)  03.                throws  IOException, HttpMediaTypeNotAcceptableException {  04.            List<MediaType> acceptedMediaTypes = Headers().getAccept();  05.            if  (acceptedMediaTypes.isEmpty()) {  06.                acceptedMediaTypes = Collections.singletonList(MediaType.ALL);  07.            }  08.            MediaType.sortByQualityValue(acceptedMediaTypes);  09.            Class<?> returnValueType = Class();  10.            List<MediaType> allSupportedMediaTypes = new  ArrayList<MediaType>();  11.            if  (getMessageConverters() != null ) {  12.                for  (MediaType acceptedMediaType : acceptedMediaTypes) {  13.                    for  (HttpMessageConverter messageConverter : getMessageConverters()) {  14.                        if  (messageConverter.canWrite(returnValueType, acceptedMediaType)) {  15.                            messageConverter.write(returnValue, acceptedMediaType, outputMessage);  16.                            if 
springmvc常用标签(logger.isDebugEnabled()) {  17.                                MediaType contentType = Headers().getContentType();  18.                                if  (contentType == null ) {  19.                                    contentType = acceptedMediaType;  20.                                }  21.                                logger.debug("Written [" + returnValue + "] as \"" + contentType +  22.                                        "\" using [" + messageConverter + "]");  23.                            }  24.                            this .responseArgumentUsed = true ;  25.                            return ;  26.                        }  27.                    }  28.                }  29.                for  (HttpMessageConverter messageConverter : messageConverters) {  30.                    allSupportedMediaTypes.SupportedMediaTypes());  31.                }  32.            }  33.            throw  new  HttpMediaTypeNotAcceptableException(allSupportedMediaTypes);  34.        }</span>
MappingJacksonHttpMessageConverter 调⽤了 objectMapper.writeValue(OutputStream stream, Object)⽅法，使⽤@ResponseBody注解返回的对象就传⼊Object参数内。若返回的对象为已经格式化好的json串时，不使⽤@RequestBody注解，⽽应该这样处理：
1、response.setContentType("application/json; charset=UTF-8");
2、Writer().print(jsonStr);
直接输出到body区，然后的视图为void。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。