简介:

@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

  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. * 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>

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

在使用 <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. throw new 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. throw new HttpMediaTypeNotSupportedException(contentType, allSupportedMediaTypes);
  28. }</span>

@ResponseBody注解时: 根据Request对象header部分的Accept属性(逗号分隔),逐一按accept中的类型,去遍历找到能处理的HttpMessageConverter;

源代码如下:

  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注解,而应该这样处理:
1、response.setContentType("application/json; charset=UTF-8");
2、response.getWriter().print(jsonStr);
直接输出到body区,然后的视图为void。

Spring MVC之@RequestBody, @ResponseBody 详解(转)的更多相关文章

  1. 《转载》Spring MVC之@RequestBody, @ResponseBody 详解

    引言: 接上一篇文章讲述处理@RequestMapping的方法参数绑定之后,详细介绍下@RequestBody.@ResponseBody的具体用法和使用时机: 简介: @RequestBody 作 ...

  2. Spring MVC之@RequestBody@ResponseBody详解

    引言: 接上一篇文章讲述处理@RequestMapping的方法参数绑定之后,详细介绍下@RequestBody.@ResponseBody的具体用法和使用时机: 简介: @RequestBody 作 ...

  3. Spring MVC之@RequestBody, @ResponseBody 详解

    http://blog.csdn.net/kobejayandy/article/details/12690555

  4. @requestbody @responsebody详解

    @requestbody @responsebody详解 会唤起spring mvc的httpmessageconveter转换类进行数据转换 简介: @RequestBody 作用: i) 该注解用 ...

  5. Spring学习 6- Spring MVC (Spring MVC原理及配置详解)

    百度的面试官问:Web容器,Servlet容器,SpringMVC容器的区别: 我还写了个文章,说明web容器与servlet容器的联系,参考:servlet单实例多线程模式 这个文章有web容器与s ...

  6. spring mvc 框架搭建及详解

    现 在主流的Web MVC框架除了Struts这个主力 外,其次就是Spring MVC了,因此这也是作为一名程序员需要掌握的主流框架,框架选择多了,应对多变的需求和业务时,可实行的方案自然就多了.不 ...

  7. Spring MVC框架搭建及其详解

    现在主流的Web MVC框架除了Struts这个主力 外,其次就是Spring MVC了,因此这也是作为一名程序员需要掌握的主流框架,框架选择多了,应对多变的需求和业务时,可实行的方案自然就多了.不过 ...

  8. Spring MVC原理及配置详解

    Spring MVC概述: Spring MVC是Spring提供的一个强大而灵活的web框架.借助于注解,Spring MVC提供了几乎是POJO的开发模式,使得控制器的开发和测试更加简单.这些控制 ...

  9. Spring MVC 之@Controller@RequestMapping详解

    一:配置web.xml 1)问题:spring项目中有多个配置文件mvc.xml   dao.xml 2)解决:在web.xml中 <init-param> <param-name& ...

随机推荐

  1. github不支持tlsv1.1后, 出现SSL connect error

    过完年回来, github不安分了, 发了博文说不支持TLSv1/TLSv1.1: Weak cryptographic standards removed, 没看到这篇博文之前, 还以为是代理问题, ...

  2. 深入理解Javascript封装DOMContentLoaded事件

    最近在写一个Javascript的框架,刚把DOMContentLoaded事件封装好,略带小兴奋,把开发过程中遇到的原理和兼容性问题做篇笔记,省的忘记到处找. 我们在写js代码的时候,一般都会添加w ...

  3. 跨域策略文件crossdomain.xml文件

    使用crossdomain.xml让Flash可以跨域传输数据 一.crossdomain.xml文件的作用    跨域,顾名思义就是需要的资源不在自己的域服务器上,需要访问其他域服务器.跨域策略文件 ...

  4. indexOf.substr,substring,charAt的区别

    var a = "asdfghjkl" alert(a.substr(1, 3));        //  从下标为1开始,往右数3个长度的数, 显示 sdf; alert(a.s ...

  5. 每隔5s执行一次动作

    TimeSpan timespan; //第一次获取系统时间 DateTime d1 = DateTime.Now; while (true) { //第二次获取系统时间 DateTime d2 = ...

  6. Spring课程 Spring入门篇 5-2 配置切面aspect

    本节主要讲了在xml中配置切面的demo 1 解析 1.1 配置切面xml 1.2 配置切面xml 1.3 问:什么是动态代理? 2 代码演练 2.1 配置切面xml 1 解析 1.1 配置切面xml ...

  7. stark——快速过滤list_filter

    一.获取过滤字段 1.给自定义配置类配置list_filter app01/stark.py: class BookConfig(ModelStark): list_display = [" ...

  8. 洛谷P1730 最小密度路径(floyd)

    题意 题目链接 Sol zz floyd. 很显然的一个dp方程\(f[i][j][k][l]\)表示从\(i\)到\(j\)经过了\(k\)条边的最小权值 可以证明最优路径的长度一定\(\leqsl ...

  9. cf888G. Xor-MST(Boruvka最小生成树 Trie树)

    题意 题目链接 给出\(n\)点,每个点有一个点权\(a[i]\),相邻两点之间的边权为\(a[i] \oplus a[j]\),求最小生成树的值 Sol 非常interesting的一道题,我做过两 ...

  10. 学习 JavaScript 树

    学习 JavaScript 树 树(Tree) 在计算机科学中,数据结构是一门研究非数值计算的程序设计问题中计算机的操作对象(数据元素)以及它们之间的操作和运算等的学科. 它包含三方面的内容: 数据的 ...