引言：

接上一篇文章講述處理@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, 不能處理；
•     其他格式， 必須；
  

@ResponseBody

作用： 

      該註解用於將Controller的方法返回的物件，通過適當的HttpMessageConverter轉換為指定格式後，寫入到Response物件的body資料區。

使用時機：

      返回的資料不是html標籤的頁面，而是其他某種格式的資料時（如json、xml等）使用；

HttpMessageConverter

1. <span style=
   "font-family:Microsoft YaHei;">/** 
2.  * Strategy interface that specifies a converter that can convert from and to HTTP requests and responses. 
3.  * 
4.  * @author Arjen Poutsma 
5.  * @author Juergen Hoeller 
6.  * @since 3.0 
7.  */
8. publicinterface HttpMessageConverter<T> {  
9.     /** 
10.      * Indicates whether the given class can be read by this converter. 
11.      * @param clazz the class to test for readability 
12.      * @param mediaType the media type to read, can be {@code null} if not specified. 
13.      * Typically the value of a {@code Content-Type} header. 
14.      * @return {@code true} if readable; {@code false} otherwise 
15.      */
16.     boolean canRead(Class<?> clazz, MediaType mediaType);  
17.     /** 
18.      * Indicates whether the given class can be written by this converter. 
19.      * @param clazz the class to test for writability 
20.      * @param mediaType the media type to write, can be {@code null} if not specified. 
21.      * Typically the value of an {@code Accept} header. 
22.      * @return {@code true} if writable; {@code false} otherwise 
23.      */
24.     boolean canWrite(Class<?> clazz, MediaType mediaType);  
25.     /** 
26.      * Return the list of {@link MediaType} objects supported by this converter. 
27.      * @return the list of supported media types 
28.      */
29.     List<MediaType> getSupportedMediaTypes();  
30.     /** 
31.      * Read an object of the given type form the given input message, and returns it. 
32.      * @param clazz the type of object to return. This type must have previously been passed to the 
33.      * {@link #canRead canRead} method of this interface, which must have returned {@code true}. 
34.      * @param inputMessage the HTTP input message to read from 
35.      * @return the converted object 
36.      * @throws IOException in case of I/O errors 
37.      * @throws HttpMessageNotReadableException in case of conversion errors 
38.      */
39.     T read(Class<? extends T> clazz, HttpInputMessage inputMessage)  
40.             throws IOException, HttpMessageNotReadableException;  
41.     /** 
42.      * Write an given object to the given output message. 
43.      * @param t the object to write to the output message. The type of this object must have previously been 
44.      * passed to the {@link #canWrite canWrite} method of this interface, which must have returned {@code true}. 
45.      * @param contentType the content type to use when writing. May be {@code null} to indicate that the 
46.      * default content type of the converter must be used. If not {@code null}, this media type must have 
47.      * previously been passed to the {@link #canWrite canWrite} method of this interface, which must have 
48.      * returned {@code true}. 
49.      * @param outputMessage the message to write to 
50.      * @throws IOException in case of I/O errors 
51.      * @throws HttpMessageNotWritableException in case of conversion errors 
52.      */
53.     void write(T t, MediaType contentType, HttpOutputMessage outputMessage)  
54.             throws IOException, HttpMessageNotWritableException;  
55. }  
56. </span>  

在使用 <mvc:annotation-driven />標籤配置時，預設配置了RequestMappingHandlerAdapter（注意是RequestMappingHandlerAdapter不是AnnotationMethodHandlerAdapter,詳情檢視Spring 3.1 document “16.14 Configuring Spring MVC”章節），併為他配置了一下預設的HttpMessageConverter：

1. ByteArrayHttpMessageConverter converts byte arrays.  
2. StringHttpMessageConverter converts strings.  
3. ResourceHttpMessageConverter converts to/from org.springframework.core.io.Resource for all media types.  
4. SourceHttpMessageConverter converts to/from a javax.xml.transform.Source.  
5. FormHttpMessageConverter converts form data to/from a MultiValueMap<String, String>.  
6. Jaxb2RootElementHttpMessageConverter converts Java objects to/from XML — added if JAXB2 is present on the classpath.  
7. MappingJacksonHttpMessageConverter converts to/from JSON — added if Jackson is present on the classpath.  
8. AtomFeedHttpMessageConverter converts Atom feeds — added if Rome is present on the classpath.  
9. RssChannelHttpMessageConverter converts RSS feeds — added if Rome is present on the classpath.  

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 中javax.xml.transform.Source定義的資料；

Jaxb2RootElementHttpMessageConverter:  負責讀取和寫入xml 標籤格式的資料；

AtomFeedHttpMessageConverter:              負責讀取和寫入Atom格式的資料；

RssChannelHttpMessageConverter:           負責讀取和寫入RSS格式的資料；

當使用@RequestBody和@ResponseBody註解時，RequestMappingHandlerAdapter就使用它們來進行讀取或者寫入相應格式的資料。

HttpMessageConverter匹配過程：

@RequestBody註解時： 根據Request物件header部分的Content-Type型別，逐一匹配合適的HttpMessageConverter來讀取資料；

spring 3.1原始碼如下：

1. <span style="font-family:Microsoft YaHei;">private Object readWithMessageConverters(MethodParameter methodParam, HttpInputMessage inputMessage, Class paramType)  
2.             throws Exception {  
3.         MediaType contentType = inputMessage.getHeaders().getContentType();  
4.         if (contentType == null) {  
5.             StringBuilder builder = new StringBuilder(ClassUtils.getShortName(methodParam.getParameterType()));  
6.             String paramName = methodParam.getParameterName();  
7.             if (paramName != null) {  
8.                 builder.append(' ');  
9.                 builder.append(paramName);  
10.             }  
11.             thrownew HttpMediaTypeNotSupportedException(  
12.                     "Cannot extract parameter (" + builder.toString() + "): no Content-Type found");  
13.         }  
14.         List<MediaType> allSupportedMediaTypes = new ArrayList<MediaType>();  
15.         if (this.messageConverters != null) {  
16.             for (HttpMessageConverter<?> messageConverter : this.messageConverters) {  
17.                 allSupportedMediaTypes.addAll(messageConverter.getSupportedMediaTypes());  
18.                 if (messageConverter.canRead(paramType, contentType)) {  
19.                     if (logger.isDebugEnabled()) {  
20.                         logger.debug("Reading [" + paramType.getName() + "] as \"" + contentType  
21.                                 +"\" using [" + messageConverter + "]");  
22.                     }  
23.                     return messageConverter.read(paramType, inputMessage);  
24.                 }  
25.             }  
26.         }  
27.         thrownew HttpMediaTypeNotSupportedException(contentType, allSupportedMediaTypes);  
28.     }</span>  

@ResponseBody註解時： 根據Request物件header部分的Accept屬性（逗號分隔），逐一按accept中的型別，去遍歷找到能處理的HttpMessageConverter；

原始碼如下：