引言:

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

简介:

@RequestBody

作用:

i) 该注解用于读取Request请求的body部分数据,使用系统默认配置的HttpMessageConverter进行解析,然后把相应的数据绑定到要返回的对象上;

ii) 再把HttpMessageConverter返回的对象数据绑定到 controller中方法的参数上。

使用时机:

A) GET、POST方式提时, 根据request header Content-Type的值来判断:

B) PUT方式提交时, 根据request header Content-Type的值来判断:

说明: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. * 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:

[java] view plaincopy
  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源代码如下:

[java] view plaincopy
  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;

源代码如下:

[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>

Spring MVC之@RequestBody, @ResponseBody 详解相关推荐

  1. Spring MVC 框架搭建及详解

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

  2. Spring MVC 拦截器 interceptor 详解

    Spring MVC-拦截器 今天就是把有关拦截器的知识做一个总结. 1.拦截器概述 1.1 什么是拦截器? Spring MVC中的拦截器(Interceptor)类似于Servlet中的过滤器(F ...

  3. Spring MVC原理及配置详解

    转载自 http://blog.csdn.net/jianyuerensheng/article/details/51258942 [Spring]Spring MVC原理及配置 1.Spring M ...

  4. Spring MVC 之@Controller@RequestMapping详解

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

  5. Spring MVC的处理流程详解

    本文来说下Spring MVC 的处理流程是怎样的 文章目录 Spring MVC概述 Spring MVC的处理流程 曾经的王者-Servlet 想要更进一步 Spring MVC-两级控制器方式 ...

  6. 【Spring】Spring MVC原理及配置详解

    [Spring]Spring MVC原理及配置 1.Spring MVC概述: Spring MVC是Spring提供的一个强大而灵活的web框架.借助于注解,Spring MVC提供了几乎是POJO ...

  7. Spring 3.0 注解注入详解

    Spring 3.0 注解注入详解 2011-04-15 09:44 17ZOUGUO ITEYE博客 我要评论(1) 字号:T | T AD: 一.各种注解方式 1.@Autowired注解(不推荐 ...

  8. spring(7)---深入理解Spring核心技术——Spring中的各模块详解

    深入理解Spring核心技术--Spring中的各模块详解 Spring框架的两个基本概念IOC容器和AOP,相信大家现在对Spring中的这两个部分的基本概念有了一定的认识,好了,那么今天我们就来正 ...

  9. ResponseBody详解

    ResponseBody详解 @ResponseBody的作用其实是将java对象转为json格式的数据. @responseBody注解的作用是将controller的方法返回的对象通过适当的转换器 ...

最新文章

  1. oracle共享时监听,Oracle监听---共享连接参数配置介绍
  2. 一次线上Redis类转换异常排查引发的思考
  3. 软件架构阅读笔记11
  4. Oracle访问数据的存取方法
  5. kylinH5框架之项目开发调试
  6. ubuntu 操作记录
  7. 没有编程基础可以学python_没有任何编程基础可以直接学习python语言吗?学会后能够做什么?...
  8. paip.提升用户体验----注册用户名可修改\
  9. mysql 中文 转 拼音_MySQL中文转换成拼音的函数
  10. 测试用例报告——模板
  11. python视频教程马哥_【进阶】51CTO马哥Python从入门到精通视频 60课
  12. 【PCB设计工具】在线 mil到mm单位转换、mm到mils换算
  13. 新医改背景下,民营医院如何通过绩效变革支持高质量发展?
  14. restful 验证码平台请求验证
  15. TeamViewer14 ubuntu 破解商业环境
  16. 洛谷刷题P1914 小书童——凯撒密码(c语言)
  17. 深入理解以太网PHY自协商及调试心得
  18. 猜成语游戏c语言程序设计教程课后答案,猜成语的灯谜和答案
  19. Java计算圆的体积,面积
  20. CVS Health验厂须知

热门文章

  1. 洛谷刷题C语言:陶瓷项链、Cow Gymnastics B、Where Am I? B、Hello, 2020!、SIR 模型
  2. ElasticSearch练习二:聚合语法学习(aggs、bucket、metric、hitogram、date hitogram)
  3. 【Android 系统开发】下载 编译 Android源代码 和 Android kernel源代码
  4. 什么是大数据,猴子怎么看大象(1)
  5. ALtera DE2开发板学习03
  6. 金蝶专业版过账提示运行时错误5_金蝶专业版过账提示运行时错误5_金蝶KIS专业版常见故障及解决办法...
  7. 金蝶导出明细账到计算机桌面,怎么用金蝶将所有科目的明细账导到一张表格上?...
  8. 服务器换完主板之后系统用重装么,win10电脑换主板之后需要重装系统吗
  9. 我们平时常见的SEO百度关键词排名方法
  10. 2021年双流永安中学高考成绩查询,双流永安中学2020年高考升学率高不高?