转载:Spring MVC之@RequestBody, @ResponseBody 详解

之前练习springboot+mybatis实现Restful服务,给予HTTP/JSON格式传输,但是在新增的时候出现一个维妮塔,就是我传的参数到数据库为Null值,我仔细检查了个个层的代码,后面发现实在Controller中将@Requestbody写成了@ResponseBody,因为我这里只需直接添加数据,使用postman工具进行测试,不需要返回值,所以导致出错,下面就说下这两者的区别吧。

简介:

@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 * 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     /** 
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     /** 
19      * Indicates whether the given class can be written by this converter. 
20      * @param clazz the class to test for writability 
21      * @param mediaType the media type to write, can be {@code null} if not specified. 
22      * Typically the value of an {@code Accept} header. 
23      * @return {@code true} if writable; {@code false} otherwise 
24      */  
25     boolean canWrite(Class<?> clazz, MediaType mediaType);  
26   
27     /** 
28      * Return the list of {@link MediaType} objects supported by this converter. 
29      * @return the list of supported media types 
30      */  
31     List<MediaType> getSupportedMediaTypes();  
32   
33     /** 
34      * Read an object of the given type form the given input message, and returns it. 
35      * @param clazz the type of object to return. This type must have previously been passed to the 
36      * {@link #canRead canRead} method of this interface, which must have returned {@code true}. 
37      * @param inputMessage the HTTP input message to read from 
38      * @return the converted object 
39      * @throws IOException in case of I/O errors 
40      * @throws HttpMessageNotReadableException in case of conversion errors 
41      */  
42     T read(Class<? extends T> clazz, HttpInputMessage inputMessage)  
43             throws IOException, HttpMessageNotReadableException;  
44   
45     /** 
46      * Write an given object to the given output message. 
47      * @param t the object to write to the output message. The type of this object must have previously been 
48      * passed to the {@link #canWrite canWrite} method of this interface, which must have returned {@code true}. 
49      * @param contentType the content type to use when writing. May be {@code null} to indicate that the 
50      * default content type of the converter must be used. If not {@code null}, this media type must have 
51      * previously been passed to the {@link #canWrite canWrite} method of this interface, which must have 
52      * returned {@code true}. 
53      * @param outputMessage the message to write to 
54      * @throws IOException in case of I/O errors 
55      * @throws HttpMessageNotWritableException in case of conversion errors 
56      */  
57     void write(T t, MediaType contentType, HttpOutputMessage outputMessage)  
58             throws IOException, HttpMessageNotWritableException;  
59   
60 }  

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

在使用 <mvc:annotation-driven />标签配置时,默认配置了RequestMappingHandlerAdapter(注意是RequestMappingHandlerAdapter不是AnnotationMethodHandlerAdapter,详情查看Spring 

ByteArrayHttpMessageConverter converts byte arrays.  
  
StringHttpMessageConverter converts strings.  
  
ResourceHttpMessageConverter converts to/from org.springframework.core.io.Resource for all media types.  
  
SourceHttpMessageConverter converts to/from a javax.xml.transform.Source.  
  
FormHttpMessageConverter converts form data to/from a MultiValueMap<String, String>.  
  
Jaxb2RootElementHttpMessageConverter converts Java objects to/from XML — added if JAXB2 is present on the classpath.  
  
MappingJacksonHttpMessageConverter converts to/from JSON — added if Jackson is present on the classpath.  
  
AtomFeedHttpMessageConverter converts Atom feeds — added if Rome is present on the classpath.  
  
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就使用它们来进行读取或者写入相应格式的数据。

补充:

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。

本文转载自:http://blog.csdn.net/kobejayandy/article/details/12690555
原文地址:https://www.cnblogs.com/jbml-154312/p/8275219.html