@RequestBody
作用:
i) 該注解用于讀取Request請求的body部分?jǐn)?shù)據(jù),使用系統(tǒng)默認(rèn)配置的HttpMessageConverter進(jìn)行解析望门,然后把相應(yīng)的數(shù)據(jù)綁定到要返回的對象上篮迎;
ii) 再把HttpMessageConverter返回的對象數(shù)據(jù)綁定到 controller中方法的參數(shù)上乍惊。
使用時(shí)機(jī):
A) GET乓搬、POST方式提時(shí)蟹但, 根據(jù)request header Content-Type的值來判斷:
application/x-www-form-urlencoded癣缅, 可選(即非必須,因?yàn)檫@種情況的數(shù)據(jù)@RequestParam, @ModelAttribute也可以處理岂傲,當(dāng)然@RequestBody也能處理)览露;
multipart/form-data, 不能處理(即使用@RequestBody不能處理這種格式的數(shù)據(jù));
其他格式譬胎, 必須(其他格式包括application/json, application/xml等差牛。這些格式的數(shù)據(jù),必須使用@RequestBody來處理)堰乔;
B) PUT方式提交時(shí)偏化, 根據(jù)request header Content-Type的值來判斷:
application/x-www-form-urlencoded, 必須镐侯;
multipart/form-data, 不能處理侦讨;
其他格式驶冒, 必須;
說明:request的body部分的數(shù)據(jù)編碼格式由header部分的Content-Type指定韵卤;
作用:
該注解用于將Controller的方法返回的對象骗污,通過適當(dāng)?shù)腍ttpMessageConverter轉(zhuǎn)換為指定格式后,寫入到Response對象的body數(shù)據(jù)區(qū)沈条。
使用時(shí)機(jī):
返回的數(shù)據(jù)不是html標(biāo)簽的頁面需忿,而是其他某種格式的數(shù)據(jù)時(shí)(如json、xml等)使用蜡歹;
[java]view plaincopy
/**
*?Strategy?interface?that?specifies?a?converter?that?can?convert?from?and?to?HTTP?requests?and?responses.
*
*?@author?Arjen?Poutsma
*?@author?Juergen?Hoeller
*?@since?3.0
*/
publicinterfaceHttpMessageConverter?{
/**
*?Indicates?whether?the?given?class?can?be?read?by?this?converter.
*?@param?clazz?the?class?to?test?for?readability
*?@param?mediaType?the?media?type?to?read,?can?be?{@code?null}?if?not?specified.
*?Typically?the?value?of?a?{@code?Content-Type}?header.
*?@return?{@code?true}?if?readable;?{@code?false}?otherwise
*/
booleancanRead(Class?clazz,?MediaType?mediaType);
/**
*?Indicates?whether?the?given?class?can?be?written?by?this?converter.
*?@param?clazz?the?class?to?test?for?writability
*?@param?mediaType?the?media?type?to?write,?can?be?{@code?null}?if?not?specified.
*?Typically?the?value?of?an?{@code?Accept}?header.
*?@return?{@code?true}?if?writable;?{@code?false}?otherwise
*/
booleancanWrite(Class?clazz,?MediaType?mediaType);
/**
*?Return?the?list?of?{@link?MediaType}?objects?supported?by?this?converter.
*?@return?the?list?of?supported?media?types
*/
List?getSupportedMediaTypes();
/**
*?Read?an?object?of?the?given?type?form?the?given?input?message,?and?returns?it.
*?@param?clazz?the?type?of?object?to?return.?This?type?must?have?previously?been?passed?to?the
*?{@link?#canRead?canRead}?method?of?this?interface,?which?must?have?returned?{@code?true}.
*?@param?inputMessage?the?HTTP?input?message?to?read?from
*?@return?the?converted?object
*?@throws?IOException?in?case?of?I/O?errors
*?@throws?HttpMessageNotReadableException?in?case?of?conversion?errors
*/
T?read(Class?clazz,?HttpInputMessage?inputMessage)
throwsIOException,?HttpMessageNotReadableException;
/**
*?Write?an?given?object?to?the?given?output?message.
*?@param?t?the?object?to?write?to?the?output?message.?The?type?of?this?object?must?have?previously?been
*?passed?to?the?{@link?#canWrite?canWrite}?method?of?this?interface,?which?must?have?returned?{@code?true}.
*?@param?contentType?the?content?type?to?use?when?writing.?May?be?{@code?null}?to?indicate?that?the
*?default?content?type?of?the?converter?must?be?used.?If?not?{@code?null},?this?media?type?must?have
*?previously?been?passed?to?the?{@link?#canWrite?canWrite}?method?of?this?interface,?which?must?have
*?returned?{@code?true}.
*?@param?outputMessage?the?message?to?write?to
*?@throws?IOException?in?case?of?I/O?errors
*?@throws?HttpMessageNotWritableException?in?case?of?conversion?errors
*/
voidwrite(T?t,?MediaType?contentType,?HttpOutputMessage?outputMessage)
throwsIOException,?HttpMessageNotWritableException;
}
該接口定義了四個(gè)方法屋厘,分別是讀取數(shù)據(jù)時(shí)的 canRead(), read() 和 寫入數(shù)據(jù)時(shí)的canWrite(), write()方法。
在使用 標(biāo)簽配置時(shí)月而,默認(rèn)配置了RequestMappingHandlerAdapter(注意是RequestMappingHandlerAdapter不是AnnotationMethodHandlerAdapter,詳情查看spring3.1 document “16.14?Configuring Spring MVC”章節(jié))汗洒,并為他配置了一下默認(rèn)的HttpMessageConverter:
[java]view plaincopy
ByteArrayHttpMessageConverter?convertsbytearrays.
StringHttpMessageConverter?converts?strings.
ResourceHttpMessageConverter?converts?to/from?org.springframework.core.io.Resourceforall?media?types.
SourceHttpMessageConverter?converts?to/from?a?javax.xml.transform.Source.
FormHttpMessageConverter?converts?form?data?to/from?a?MultiValueMap.
Jaxb2RootElementHttpMessageConverter?converts?Java?objects?to/from?XML?—?addedifJAXB2?is?present?on?the?classpath.
MappingJacksonHttpMessageConverter?converts?to/from?JSON?—?addedifJackson?is?present?on?the?classpath.
AtomFeedHttpMessageConverter?converts?Atom?feeds?—?addedifRome?is?present?on?the?classpath.
RssChannelHttpMessageConverter?converts?RSS?feeds?—?addedifRome?is?present?on?the?classpath.
ByteArrayHttpMessageConverter: 負(fù)責(zé)讀取二進(jìn)制格式的數(shù)據(jù)和寫出二進(jìn)制格式的數(shù)據(jù);
StringHttpMessageConverter:?? 負(fù)責(zé)讀取字符串格式的數(shù)據(jù)和寫出二進(jìn)制格式的數(shù)據(jù)父款;
ResourceHttpMessageConverter:負(fù)責(zé)讀取資源文件和寫出資源文件數(shù)據(jù)溢谤;
FormHttpMessageConverter:?????? 負(fù)責(zé)讀取form提交的數(shù)據(jù)(能讀取的數(shù)據(jù)格式為 application/x-www-form-urlencoded,不能讀取multipart/form-data格式數(shù)據(jù))憨攒;負(fù)責(zé)寫入application/x-www-from-urlencoded和multipart/form-data格式的數(shù)據(jù)世杀;
MappingJacksonHttpMessageConverter:? 負(fù)責(zé)讀取和寫入json格式的數(shù)據(jù);
SouceHttpMessageConverter:?????????????????? 負(fù)責(zé)讀取和寫入 xml 中javax.xml.transform.Source定義的數(shù)據(jù)浓恶;
Jaxb2RootElementHttpMessageConverter:? 負(fù)責(zé)讀取和寫入xml 標(biāo)簽格式的數(shù)據(jù);
AtomFeedHttpMessageConverter:????????????? 負(fù)責(zé)讀取和寫入Atom格式的數(shù)據(jù)结笨;
RssChannelHttpMessageConverter:?????????? 負(fù)責(zé)讀取和寫入RSS格式的數(shù)據(jù)包晰;
當(dāng)使用@RequestBody和@ResponseBody注解時(shí),RequestMappingHandlerAdapter就使用它們來進(jìn)行讀取或者寫入相應(yīng)格式的數(shù)據(jù)炕吸。
@RequestBody注解時(shí): 根據(jù)Request對象header部分的Content-Type類型伐憾,逐一匹配合適的HttpMessageConverter來讀取數(shù)據(jù);
spring 3.1源代碼如下:
[java]view plaincopy
privateObject?readWithMessageConverters(MethodParameter?methodParam,?HttpInputMessage?inputMessage,?Class?paramType)
throwsException?{
MediaType?contentType?=?inputMessage.getHeaders().getContentType();
if(contentType?==null)?{
StringBuilder?builder?=newStringBuilder(ClassUtils.getShortName(methodParam.getParameterType()));
String?paramName?=?methodParam.getParameterName();
if(paramName?!=null)?{
builder.append('?');
builder.append(paramName);
}
thrownewHttpMediaTypeNotSupportedException(
"Cannot?extract?parameter?("+?builder.toString()?+"):?no?Content-Type?found");
}
List?allSupportedMediaTypes?=newArrayList();
if(this.messageConverters?!=null)?{
for(HttpMessageConverter?messageConverter?:this.messageConverters)?{
allSupportedMediaTypes.addAll(messageConverter.getSupportedMediaTypes());
if(messageConverter.canRead(paramType,?contentType))?{
if(logger.isDebugEnabled())?{
logger.debug("Reading?["+?paramType.getName()?+"]?as?\""+?contentType
+"\"?using?["+?messageConverter?+"]");
}
returnmessageConverter.read(paramType,?inputMessage);
}
}
}
thrownewHttpMediaTypeNotSupportedException(contentType,?allSupportedMediaTypes);
}
@ResponseBody注解時(shí): 根據(jù)Request對象header部分的Accept屬性(逗號分隔)赫模,逐一按accept中的類型树肃,去遍歷找到能處理的HttpMessageConverter;
源代碼如下:
[java]view plaincopy
privatevoidwriteWithMessageConverters(Object?returnValue,
HttpInputMessage?inputMessage,?HttpOutputMessage?outputMessage)
throwsIOException,?HttpMediaTypeNotAcceptableException?{
List?acceptedMediaTypes?=?inputMessage.getHeaders().getAccept();
if(acceptedMediaTypes.isEmpty())?{
acceptedMediaTypes?=?Collections.singletonList(MediaType.ALL);
}
MediaType.sortByQualityValue(acceptedMediaTypes);
Class?returnValueType?=?returnValue.getClass();
List?allSupportedMediaTypes?=newArrayList();
if(getMessageConverters()?!=null)?{
for(MediaType?acceptedMediaType?:?acceptedMediaTypes)?{
for(HttpMessageConverter?messageConverter?:?getMessageConverters())?{
if(messageConverter.canWrite(returnValueType,?acceptedMediaType))?{
messageConverter.write(returnValue,?acceptedMediaType,?outputMessage);
if(logger.isDebugEnabled())?{
MediaType?contentType?=?outputMessage.getHeaders().getContentType();
if(contentType?==null)?{
contentType?=?acceptedMediaType;
}
logger.debug("Written?["+?returnValue?+"]?as?\""+?contentType?+
"\"?using?["+?messageConverter?+"]");
}
this.responseArgumentUsed?=true;
return;
}
}
}
for(HttpMessageConverter?messageConverter?:?messageConverters)?{
allSupportedMediaTypes.addAll(messageConverter.getSupportedMediaTypes());
}
}
thrownewHttpMediaTypeNotAcceptableException(allSupportedMediaTypes);
}
MappingJacksonHttpMessageConverter 調(diào)用了 objectMapper.writeValue(OutputStream stream, Object)方法瀑罗,使用@ResponseBody注解返回的對象就傳入Object參數(shù)內(nèi)胸嘴。若返回的對象為已經(jīng)格式化好的json串時(shí),不使用@RequestBody注解斩祭,而應(yīng)該這樣處理:
1劣像、response.setContentType("application/json; charset=UTF-8");
2、response.getWriter().print(jsonStr);
直接輸出到body區(qū)摧玫,然后的視圖為void耳奕。