SpringMVC中的@RequestBody/@ResponseBody的用法與理解

@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指定韵卤;

@ResponseBody

作用:

該注解用于將Controller的方法返回的對象骗污,通過適當(dāng)?shù)腍ttpMessageConverter轉(zhuǎn)換為指定格式后,寫入到Response對象的body數(shù)據(jù)區(qū)沈条。

使用時(shí)機(jī):

返回的數(shù)據(jù)不是html標(biāo)簽的頁面需忿,而是其他某種格式的數(shù)據(jù)時(shí)(如json、xml等)使用蜡歹;

HttpMessageConverter

[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ù)炕吸。

HttpMessageConverter匹配過程:

@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);

}

補(bǔ)充:

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耳奕。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子屋群,更是在濱河造成了極大的恐慌闸婴,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,858評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件芍躏,死亡現(xiàn)場離奇詭異邪乍,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)纸肉,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,372評論 3 395
  • 文/潘曉璐 我一進(jìn)店門溺欧,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人柏肪,你說我怎么就攤上這事姐刁。” “怎么了烦味?”我有些...
    開封第一講書人閱讀 165,282評論 0 356
  • 文/不壞的土叔 我叫張陵聂使,是天一觀的道長。 經(jīng)常有香客問我谬俄,道長柏靶,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,842評論 1 295
  • 正文 為了忘掉前任溃论,我火速辦了婚禮屎蜓,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘钥勋。我一直安慰自己炬转,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,857評論 6 392
  • 文/花漫 我一把揭開白布算灸。 她就那樣靜靜地躺著扼劈,像睡著了一般。 火紅的嫁衣襯著肌膚如雪菲驴。 梳的紋絲不亂的頭發(fā)上荐吵,一...
    開封第一講書人閱讀 51,679評論 1 305
  • 那天,我揣著相機(jī)與錄音赊瞬,去河邊找鬼先煎。 笑死,一個(gè)胖子當(dāng)著我的面吹牛巧涧,可吹牛的內(nèi)容都是我干的榨婆。 我是一名探鬼主播,決...
    沈念sama閱讀 40,406評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼褒侧,長吁一口氣:“原來是場噩夢啊……” “哼良风!你這毒婦竟也來了谊迄?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,311評論 0 276
  • 序言:老撾萬榮一對情侶失蹤烟央,失蹤者是張志新(化名)和其女友劉穎统诺,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體疑俭,經(jīng)...
    沈念sama閱讀 45,767評論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡粮呢,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,945評論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了钞艇。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片啄寡。...
    茶點(diǎn)故事閱讀 40,090評論 1 350
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖哩照,靈堂內(nèi)的尸體忽然破棺而出挺物,到底是詐尸還是另有隱情,我是刑警寧澤飘弧,帶...
    沈念sama閱讀 35,785評論 5 346
  • 正文 年R本政府宣布识藤,位于F島的核電站,受9級特大地震影響次伶,放射性物質(zhì)發(fā)生泄漏痴昧。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,420評論 3 331
  • 文/蒙蒙 一冠王、第九天 我趴在偏房一處隱蔽的房頂上張望赶撰。 院中可真熱鬧,春花似錦柱彻、人聲如沸豪娜。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,988評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽侵歇。三九已至骂澄,卻和暖如春吓蘑,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背坟冲。 一陣腳步聲響...
    開封第一講書人閱讀 33,101評論 1 271
  • 我被黑心中介騙來泰國打工磨镶, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人健提。 一個(gè)月前我還...
    沈念sama閱讀 48,298評論 3 372
  • 正文 我出身青樓琳猫,卻偏偏與公主長得像,于是被迫代替她去往敵國和親私痹。 傳聞我的和親對象是個(gè)殘疾皇子脐嫂,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,033評論 2 355

推薦閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理统刮,服務(wù)發(fā)現(xiàn),斷路器账千,智...
    卡卡羅2017閱讀 134,659評論 18 139
  • Spring的模型-視圖-控制器(MVC)框架是圍繞一個(gè)DispatcherServlet來設(shè)計(jì)的侥蒙,這個(gè)Servl...
    alexpdh閱讀 2,647評論 0 3
  • 1、@Entity與@Table 先看下栗子: @Entity@Table(name="tbl_user")pub...
    garyhu1閱讀 1,294評論 0 0
  • 題目 字符串APPAPT中包含了兩個(gè)單詞“PAT”匀奏,其中第一個(gè)PAT是第2位(P),第4位(A),第6位(T)鞭衩;第...
    快把節(jié)操撿起來閱讀 564評論 0 0
  • [cp] 我對自己說 ——每個(gè)自己都有三個(gè)感慨歲月的瞬間 每個(gè)自己都有三個(gè)感慨...
    e25c90c2d879閱讀 153評論 0 0