简介:

@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(HTTP消息转化器)

  1. * Strategy interface that specifies a converter that can convert from and to HTTP requests and responses.
  2. *
  3. * @author Arjen Poutsma
  4. * @author Juergen Hoeller
  5. * @since 3.0
  6. */
  7. public interface HttpMessageConverter<T> {
  8. /**
  9. * Indicates whether the given class can be read by this converter.
  10. * @param clazz the class to test for readability
  11. * @param mediaType the media type to read, can be {@code null} if not specified.
  12. * Typically the value of a {@code Content-Type} header.
  13. * @return {@code true} if readable; {@code false} otherwise
  14. */
  15. boolean canRead(Class<?> clazz, MediaType mediaType);
  16. /**
  17. * Indicates whether the given class can be written by this converter.
  18. * @param clazz the class to test for writability
  19. * @param mediaType the media type to write, can be {@code null} if not specified.
  20. * Typically the value of an {@code Accept} header.
  21. * @return {@code true} if writable; {@code false} otherwise
  22. */
  23. boolean canWrite(Class<?> clazz, MediaType mediaType);
  24. /**
  25. * Return the list of {@link MediaType} objects supported by this converter.
  26. * @return the list of supported media types
  27. */
  28. List<MediaType> getSupportedMediaTypes();
  29. /**
  30. * Read an object of the given type form the given input message, and returns it.
  31. * @param clazz the type of object to return. This type must have previously been passed to the
  32. * {@link #canRead canRead} method of this interface, which must have returned {@code true}.
  33. * @param inputMessage the HTTP input message to read from
  34. * @return the converted object
  35. * @throws IOException in case of I/O errors
  36. * @throws HttpMessageNotReadableException in case of conversion errors
  37. */
  38. T read(Class<? extends T> clazz, HttpInputMessage inputMessage)
  39. throws IOException, HttpMessageNotReadableException;
  40. /**
  41. * Write an given object to the given output message.
  42. * @param t the object to write to the output message. The type of this object must have previously been
  43. * passed to the {@link #canWrite canWrite} method of this interface, which must have returned {@code true}.
  44. * @param contentType the content type to use when writing. May be {@code null} to indicate that the
  45. * default content type of the converter must be used. If not {@code null}, this media type must have
  46. * previously been passed to the {@link #canWrite canWrite} method of this interface, which must have
  47. * returned {@code true}.
  48. * @param outputMessage the message to write to
  49. * @throws IOException in case of I/O errors
  50. * @throws HttpMessageNotWritableException in case of conversion errors
  51. */
  52. void write(T t, MediaType contentType, HttpOutputMessage outputMessage)
  53. throws IOException, HttpMessageNotWritableException;
  54. }

该接口定义了四个方法,分别是读取数据时的 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.
  1. ByteArrayHttpMessageConverter: 负责读取二进制格式的数据和写出二进制格式的数据;
  2. StringHttpMessageConverter:   负责读取字符串格式的数据和写出二进制格式的数据;
  3. ResourceHttpMessageConverter:负责读取资源文件和写出资源文件数据;
  4. FormHttpMessageConverter:       负责读取form提交的数据(能读取的数据格式为 application/x-www-form-urlencoded,不能读取multipart/form-data格式数据);负责写入application/x-www-from-urlencoded和multipart/form-data格式的数据;
  5. MappingJacksonHttpMessageConverter:  负责读取和写入json格式的数据;
  6. SouceHttpMessageConverter:                   负责读取和写入 xml 中javax.xml.transform.Source定义的数据;
  7. Jaxb2RootElementHttpMessageConverter:  负责读取和写入xml 标签格式的数据;
  8. AtomFeedHttpMessageConverter:              负责读取和写入Atom格式的数据;
  9. RssChannelHttpMessageConverter:           负责读取和写入RSS格式的数据;
  10. 当使用@RequestBody和@ResponseBody注解时,RequestMappingHandlerAdapter就使用它们来进行读取或者写入相应格式的数据

HttpMessageConverter匹配过程:

@RequestBody注解时: 根据Request对象header部分的Content-Type类型,逐一匹配合适的HttpMessageConverter来读取数据;

spring 3.1源代码如下:

  1. 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. }

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

源代码如下:

  1. 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. }

补充:

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。

参考资料:

1、 Spring 3.1 Doc:

spring-3.1.0/docs/spring-framework-reference/html/mvc.html

2、Spring 3.x MVC 入门4 -- @ResponseBody & @RequestBody

转载地址:http://www.cnblogs.com/qq78292959/p/3760651.html

ok 上面讲解了实现的过程,简单的可以理解为只要有对应协议的解析器,你就可以通过几行配置,几个注解完成协议——对象的转换工作。

注意:Spring默认的json协议解析由Jackson完成,所以要添加jackson.jar包。

使用@ResponseBody  带来的好处就是由spring 将协议转化为对象,不用我们自己再去转化 同样@RequestBody也是,比如我们在前台传递了参数而controller中使用@RequestBody 则可以直接获得pojo对象,不用我们再去获取参数,组装对象。

下面看看小demo

1、前端代码post提交:

  1. function profilep() {
  2. // 组装json格式数据
  3. var mydata = '{"name":"' + $('#name').val() + '","id":"'
  4. + $('#id').val() + '","password":"' + $('#password').val()
  5. + '"}';
  6. $.ajaxSetup({
  7. contentType : 'application/json'
  8. });
  9. $.post('http://localhost:18080/website2/user/save2.do', mydata,
  10. function(data) {
  11. alert("id: " + data.id + "\nname: " + data.name
  12. + "\password: " + data.password);
  13. }, 'json');
  14. }

2、后台代码:

  1. @ResponseBody
  2. @RequestMapping(value = "/save2.do"  ,method = RequestMethod.POST)
  3. // 知己接收对象,因@RequestBody spring 帮我们处理了 协议到对象的这个过程
  4. public User info2(@RequestBody User user) {
  5. String id = user.getId();
  6. String name = user.getName();
  7. String password = user.getPassword();
  8. Map<String, String> map = new HashMap<String, String>();
  9. map.put("id", id);
  10. map.put("name", name);
  11. map.put("password", password);
  12. userService.saveUser(map);
  13. User user2= new User(id,name,password);
  14. // 直接返回对象,因@ResponseBody spring 会帮我们处理对象和协议之间的转化
  15. return user2;
  16. }

3、上面两个都是post方法其实get方法也是一样的:

前端代码:

  1. function profile() {
  2. var url = 'http://localhost:18080/website2/user/save.do?';
  3. var query = 'id=' + $('#id').val() + '&name=' + $('#name').val()
  4. + '&password=' + $('#password').val();
  5. url += query;
  6. $.get(url, function(data) {
  7. alert("id: " + data.id + "\nname: " + data.name + "\nstatus: "
  8. + data.password);
  9. });
  10. }

后台代码:

  1. @ResponseBody
  2. @RequestMapping(value = "/save.do"  ,method = RequestMethod.GET)
  3. public User info(HttpServletRequest request) {
  4. String id = request.getParameter("id");
  5. String name = request.getParameter("name");
  6. String password = request.getParameter("password");
  7. Map<String, String> map = new HashMap<String, String>();
  8. map.put("id", id);
  9. map.put("name", name);
  10. map.put("password", password);
  11. userService.saveUser(map);
  12. User user= new User(id,name,password);
  13. return user;
  14. }

上面的$.get方法是使用GET方式进行异步请求。$.post方法使用POST方式来进行异步请求。

$.get 、$.post 方法的格式相同,这里就以$.get为列:

$.get(url [, data] [, callback] [, type])

url:请求的HTML页的URL地址

data(可选):发送至服务器的key/value数据会未为QueryString附加到请求URL中

callback(可选):载入成功时回调函数(即当Response的返回状态为success才调用)自动将请求结果和状态传递给该方法

type(可选):服务器端返回内容的格式,包括xml,html,script,json,text和_default.

这个格式通过上面的post方法和get方法可以看到,像post的那个方法就比较完整!

@RequestBody 和@ResponseBody 注解详解的更多相关文章

  1. @RequestBody, @ResponseBody 注解详解(转)

    原文地址: https://www.cnblogs.com/qq78292959/p/3760651.html @RequestBody, @ResponseBody 注解详解(转) 引言: 接上一篇 ...

  2. @RequestBody, @ResponseBody 注解详解

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

  3. 【转】@RequestParam @RequestBody @PathVariable 等参数绑定注解详解

    @RequestParam @RequestBody @PathVariable 等参数绑定注解详解 2014-06-02 11:24 23683人阅读 评论(2) 收藏 举报 目录(?)[+] 引言 ...

  4. @PathVariable @RequestParam @RequestBody等参数绑定注解详解

    一.分类 handler method 参数绑定常用的注解,我们根据他们处理的Request的内容不同分为四类: 处理request uri 部分的注解:   @PathVariable;(这里指ur ...

  5. SpringMVC 常用注解 详解

    SpringMVC 常用注解 详解 SpringMVC 常用注解 1.@RequestMapping                                      路径映射 2.@Requ ...

  6. @ModelAttribute注解详解

    @ModelAttribute注解详解 1.@ModelAttribute定义: 被该注解定义的方法,会在该方法所在的controller的任何目标方法执行之前执行 2.@ModelAttribute ...

  7. 在SpringMVC中使用@RequestBody和@ResponseBody注解处理json时,报出HTTP Status 415的解决方案

    我在使用SpringMVC的@RequestBody和@ResponseBody注解处理JSON数据的时候,总是出现415的错误,说是不支持所提交数据格式,我在页面中使用了JQuery的AJAX来发出 ...

  8. Java基础13:反射与注解详解

    Java基础13:反射与注解详解 什么是反射? 反射(Reflection)是Java 程序开发语言的特征之一,它允许运行中的 Java 程序获取自身的信息,并且可以操作类或对象的内部属性. Orac ...

  9. java中的注解详解和自定义注解

    一.java中的注解详解 1.什么是注解 用一个词就可以描述注解,那就是元数据,即一种描述数据的数据.所以,可以说注解就是源代码的元数据.比如,下面这段代码: @Override public Str ...

随机推荐

  1. Java EE JavaBean组件

    一.简介 JavaBean组件是一些可移植.可重用并可组装到应用程序中的Java类,类必须是具体的和公共的. 符合下列设计规则的任何Java类均是以JavaBean: 1.对数据类型“protype” ...

  2. Spring学习(3):Spring概述(转载)

    1. Spring是什么? Spring是一个开源的轻量级Java SE(Java 标准版本)/Java EE(Java 企业版本)开发应用框架,其目的是用于简化企业级应用程序开发. 在面向对象思想中 ...

  3. C# 反射,动态编译

    反射是动态获取程序集的元数据的一种技术,这句话是做.NET程序员面试题目的一个的答案,你可选择记住它,就好比高中生物学里面讲到的细胞的结构的课程时,细胞由细胞膜,细胞质和细胞核组成.根据做程序的经验, ...

  4. RESTful源码笔记之RESTful Framework的基本组件

    快速实例 Quickstart 序列化 创建一个序列化类 简单使用 开发我们的Web API的第一件事是为我们的Web API提供一种将代码片段实例序列化和反序列化为诸如json之类的表示形式的方式. ...

  5. ES6的新特性(21)——Proxy

    Proxy 概述 Proxy 用于修改某些操作的默认行为,等同于在语言层面做出修改,所以属于一种“元编程”(meta programming),即对编程语言进行编程. Proxy 可以理解成,在目标对 ...

  6. Scrum立会报告+燃尽图(十一月十九日总第二十七次):功能开发与修复上一阶段bug

    此作业要求参见:https://edu.cnblogs.com/campus/nenu/2018fall/homework/2284 项目地址:https://git.coding.net/zhang ...

  7. 第9次Scrum会议(10/21)【欢迎来怼】

    一.小组信息 队名:欢迎来怼小组成员队长:田继平成员:李圆圆,葛美义,王伟东,姜珊,邵朔,冉华小组照片 二.开会信息 时间:2017/10/21 17:20~17:45,总计25min.地点:东北师范 ...

  8. ubuntu安装和查看已安装软件

    说明:由于图形化界面方法(如Add/Remove... 和Synaptic Package Manageer)比较简单,所以这里主要总结在终端通过命令行方式进行的软件包安装.卸载和删除的方法. 一.U ...

  9. 基础系列(6)—— C#类和对象

    一.类介绍       类(class)是C#类型中最基础的类型.类是一个数据结构,将状态(字段)和行为(方法和其他函数成员)组合在一个单元中.类提供了用于动态创建类实例的定义,也就是对象(objec ...

  10. rsa加密算法,前后端实现。

    前端js: 下载地址:http://travistidwell.com/jsencrypt/ js第一版本: // 对数据加密 function encrypt(enStr){ //没有加载jsenc ...