@ResponseBody 和 @RequestBody 注解的区别

Posted 2023-05-02

参考技术A 在详@ResponseBody和@RequestBody注解之前，我们先了解一下@RequestMapping注解，@RequestMapping是一个用来处理请求地址映射的注解，可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径；用于方法上，表示在类的父路径下追加方法上注解中的地址将会访问到该方法。例如，

其对应的相对请求路径就是hello/first，访问该路径就会跳转到hello everyone页面。

2 注解详述

@Responsebody注解表示该方法的返回的结果直接写入 HTTP 响应正文中，一般在异步获取数据时使用；在使用@RequestMapping后，返回值通常解析为跳转路径，加上@Responsebody后返回结果不会被解析为跳转路径，而是直接写入HTTP 响应正文中。例如，异步获取json数据，加上@Responsebody注解后，就会直接返回json数据,前端直接从json里取得相应的数据。（一般前后端分离都用@Responsebody）

@RequestBody注解则是将 HTTP 求正文插入方法中，使用适合的HttpMessageConverter将请求体写入某个对象。

例如，
@RequestMapping(value = "login")
@ResponseBody // 将请求中的数据写入 Person 对象中，把前端携带的信息封装成后端具体的po，后端通过操作po实现后续业务。
public Person login(@RequestBody Person person)

3 扩展

此外介绍一下经常用到的注解@PathVariable，有时间我们在前端请求路径中会携带着动态的参数，此时在与后端交互时候，为了标记该参数，则用到@PathVariable。

如上图：该路径携带了一个动态参数attrId，后天的info()方法中有一个attrIds的参数，为了关联起前端跟后端的参数，则引入@PathVariable来把attrId与attrIds进行绑定，表示就是同一个参数。

Spring 4.1.1 RELEASE 和 @ResponseBody 返回 HTTP 406

【中文标题】Spring 4.1.1 RELEASE 和 @ResponseBody 返回 HTTP 406

【英文标题】：Spring 4.1.1 RELEASE and @ResponseBody return HTTP 406

【发布时间】：2014-12-12 12:27:53

【问题描述】：

我在 Spring MVC 中使用 @ResponseBody 返回 Json 对象。它在版本 4.0.7 和 3.2.11 上按预期工作，但是当我尝试使用最新的 Spring 版本 4.1.1（截至 10/16）且没有任何其他配置更改时，它返回 HTTP 状态 406。这被认为是一个错误还是 4.1.1 需要不同的配置？

最新的 jackson jar 已经在类路径中

<dependency>
    <groupId>org.codehaus.jackson</groupId>
    <artifactId>jackson-mapper-asl</artifactId>
    <version>1.9.13</version>
</dependency>

Spring document 上的示例运行良好

@RequestMapping(value = "/something", method = RequestMethod.PUT)
@ResponseBody
public String helloWorld() 
  return "Hello World";

当返回类型为字符串时。当返回类型是 POJO 时会出现问题。

【参考方案1】：

我在从 3.2 迁移到 spring 4.2 时遇到了类似的问题。 得到了

org.springframework.web.util.NestedServletException：请求处理失败；嵌套异常是 java.lang.IllegalArgumentException: No converter found for return value of type:

把它贴在这里，以便人们可以通过异常名称找到它:) 我花了半天时间才找到这篇文章。感谢@Vito 和@Aias

前面两个答案的组合也可以，如果您不想注册自定义contentNegotiationManager，您可以执行以下操作：

从

中移除所有jackson依赖

pom.xml

并使用最新的

<dependency>
    <groupId>com.fasterxml.jackson.jaxrs</groupId>
    <artifactId>jackson-jaxrs-base</artifactId>
    <version>2.6.1</version>
</dependency>

servlet.xml

<mvc:annotation-driven>
    <mvc:message-converters>
        <bean class="org.springframework.http.converter.StringHttpMessageConverter"/>
        <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter"/>
    </mvc:message-converters>
</mvc:annotation-driven>

【参考方案2】：

Maven pom.xml：

    <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-core</artifactId>
        <version>2.4.3</version>
    </dependency>
    <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-databind</artifactId>
        <version>2.4.3</version>
    </dependency>

和spring mvc配置文件(eg:spring-mvc.xml)

<mvc:annotation-driven>
    <mvc:message-converters>
        <bean class="org.springframework.http.converter.StringHttpMessageConverter"/>
        <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter"/>
    </mvc:message-converters>
</mvc:annotation-driven>

【讨论】：

在我添加了jackson-databind（以及我添加的唯一一个额外的 jar，在 4.1.1 RELEASE 之前不需要）之后，它现在可以工作了。总结一下，为了让 @ResponseBody 在 Spring 4.1.1 上工作，我在配置文件中有 jackson-mapper-asl 和 jackson-databind jar 和 <mvc:annotation-driven />。感谢您的提示。

为什么要包含两个版本的 Jackson？

@DinoTw 你可以阅读这篇文章：github.com/spring-projects/spring-framework/wiki/…

@Vito，感谢您的更新。发现@ResponseBody工作所需的最少jar是spring-webmvc和jackson-databind。

@Vito 你失去了一个依赖：jackson-annotaions。我在 spring 4.2.4 中对其进行了测试，这需要 jackson-annotaions。

【参考方案3】：

在删除 Jackson 1.* 替换为 2.4.4 (JAXRS) 后它可以工作了，它将导入所有其他依赖项，jackson-core、jackson-databind 和 jackson-annotations。

已移除

<dependency>
    <groupId>org.codehaus.jackson</groupId>
    <artifactId>jackson-core-asl</artifactId>
    <version>1.9.13</version>
</dependency>
<dependency>
    <groupId>org.codehaus.jackson</groupId>
    <artifactId>jackson-mapper-asl</artifactId>
    <version>1.9.13</version>
</dependency>

已添加

<dependency>
    <groupId>com.fasterxml.jackson.jaxrs</groupId>
    <artifactId>jackson-jaxrs-base</artifactId>
    <version>2.4.4</version>
</dependency>

http://www.codingpedia.org/ama/jquery-ui-autocomplete-not-working-in-spring-4-1/

在 servlet xml 中

<mvc:annotation-driven  content-negotiation-manager="contentNegotiationManager" />

<bean id="contentNegotiationManager" class="org.springframework.web.accept.ContentNegotiationManagerFactoryBean">
     <property name="favorPathExtension" value="false" />
     <property name="favorParameter" value="true" />
     <property name="mediaTypes" >
          <value>
               json=application/json
               xml=application/xml
          </value>
     </property>
</bean>

如果类文件中引入了jackson注解，也要替换掉

已移除

导入 org.codehaus.jackson.annotate.JsonIgnoreProperties

已添加

导入 com.fasterxml.jackson.annotation.JsonIgnoreProperties

【讨论】：

感谢您的回答，稍后会验证。