Spring MVC之@RequestBody, @ResponseBody 詳解

引言：

接上一篇文章講述處理@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

[java] view plaincopy

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. public interface HttpMessageConverter<T> {  
9.   
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 IOException, 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>  

該接口定義了四個方法，分別是讀取數據時的 canRead(), read() 和 寫入數據時的canWrite(), write()方法。

在使用 <mvc:annotation-driven />標籤配置時，默認配置了RequestMappingHandlerAdapter（注意是RequestMappingHandlerAdapter不是AnnotationMethodHandlerAdapter,詳情查看Spring 3.1 document 「16.14 Configuring Spring MVC」章節），併爲他配置了一下默認的HttpMessageConverter：

 

[java] view plaincopy

1. ByteArrayHttpMessageConverter converts byte arrays.  
2.   
3. StringHttpMessageConverter converts strings.  
4.   
5. ResourceHttpMessageConverter converts to/from org.springframework.core.io.Resource for all media types.  
6.   
7. SourceHttpMessageConverter converts to/from a javax.xml.transform.Source.  
8.   
9. FormHttpMessageConverter converts form data to/from a MultiValueMap<String, String>.  
10.   
11. Jaxb2RootElementHttpMessageConverter converts Java objects to/from XML — added if JAXB2 is present on the classpath.  
12.   
13. MappingJacksonHttpMessageConverter converts to/from JSON — added if Jackson is present on the classpath.  
14.   
15. AtomFeedHttpMessageConverter converts Atom feeds — added if Rome is present on the classpath.  
16.   
17. 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源代碼以下：

[java] view plaincopy

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

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

源代碼以下：

[java] view plaincopy

1. <span style="font-family:Microsoft YaHei;">private void writeWithMessageConverters(Object returnValue,  
2.                 HttpInputMessage inputMessage, HttpOutputMessage outputMessage)  
3.                 throws IOException, HttpMediaTypeNotAcceptableException {  
4.             List<MediaType> acceptedMediaTypes = inputMessage.getHeaders().getAccept();  
5.             if (acceptedMediaTypes.isEmpty()) {  
6.                 acceptedMediaTypes = Collections.singletonList(MediaType.ALL);  
7.             }  
8.             MediaType.sortByQualityValue(acceptedMediaTypes);  
9.             Class<?> returnValueType = returnValue.getClass();  
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 (logger.isDebugEnabled()) {  
17.                                 MediaType contentType = outputMessage.getHeaders().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.addAll(messageConverter.getSupportedMediaTypes());  
31.                 }  
32.             }  
33.             throw new HttpMediaTypeNotAcceptableException(allSupportedMediaTypes);  
34.         }</span>  

 

補充：

MappingJacksonHttpMessageConverter 調用了 objectMapper.writeValue(OutputStream stream, Object)方法，使用@ResponseBody註解返回的對象就傳入Object參數內。若返回的對象爲已經格式化好的json串時，不使用@RequestBody註解，而應該這樣處理：

一、response.setContentType("application/json; charset=UTF-8");

二、response.getWriter().print(jsonStr);

直接輸出到body區，而後的視圖爲void。