SpringMVC中的@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

/**

*?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;

}

该接口定义了四个方法,分别是读取数据时的 canRead(), read() 和 写入数据时的canWrite(), write()方法。

在使用 标签配置时,默认配置了RequestMappingHandlerAdapter(注意是RequestMappingHandlerAdapter不是AnnotationMethodHandlerAdapter,详情查看spring3.1 document “16.14?Configuring Spring MVC”章节),并为他配置了一下默认的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: 负责读取二进制格式的数据和写出二进制格式的数据;

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

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注解时: 根据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 调用了 objectMapper.writeValue(OutputStream stream, Object)方法,使用@ResponseBody注解返回的对象就传入Object参数内。若返回的对象为已经格式化好的json串时,不使用@RequestBody注解,而应该这样处理:

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

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

直接输出到body区,然后的视图为void。

最后编辑于
?著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,100评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,308评论 3 388
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事?!?“怎么了?”我有些...
    开封第一讲书人阅读 159,718评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,275评论 1 287
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,376评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,454评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,464评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,248评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,686评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,974评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,150评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,817评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,484评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,140评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,374评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,012评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,041评论 2 351

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,644评论 18 139
  • Spring的模型-视图-控制器(MVC)框架是围绕一个DispatcherServlet来设计的,这个Servl...
    alexpdh阅读 2,643评论 0 3
  • 1、@Entity与@Table 先看下栗子: @Entity@Table(name="tbl_user")pub...
    garyhu1阅读 1,276评论 0 0
  • 题目 字符串APPAPT中包含了两个单词“PAT”,其中第一个PAT是第2位(P),第4位(A),第6位(T);第...
    快把节操捡起来阅读 555评论 0 0
  • [cp] 我对自己说 ——每个自己都有三个感慨岁月的瞬间 每个自己都有三个感慨...
    e25c90c2d879阅读 151评论 0 0