经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置：技术经验 » Java相关 » Spring » 查看文章
Spring MVC 中 HttpMessageConverter 转换器 - Rainbow-Sea
来源：cnblogs　　作者：Rainbow-Sea　　时间：2024/7/13 19:20:21　　对本文有异议

1. Spring MVC 中 HttpMessageConverter 转换器

@

目录

2. 补充：什么是 HTTP 消息

HTTP 消息其实就是 HTTP 协议。HTTP 协议包括 请求协议 和 响应协议。
以下是一份HTTP POST请求协议：

  1. POST /springmvc/user/login HTTP/1.1																												--请求行
  2. Content-Type: application/x-www-form-urlencoded																						--请求头
  3. Content-Length: 32
  4. Host: www.example.com
  5. User-Agent: Mozilla/5.0
  6. Connection: Keep-Alive
  7. Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
  8.                                                                                           --空白行
  9. username=admin&password=1234																															--请求体

以下是一份HTTP GET请求协议：

  1. GET /springmvc/user/del?id=1&name=zhangsan HTTP/1.1																				--请求行
  2. Host: www.example.com																																			--请求头
  3. User-Agent: Mozilla/5.0
  4. Connection: Keep-Alive
  5. Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8

以下是一份HTTP响应协议：

  1. HTTP/1.1 200 OK																																					--状态行
  2. Date: Thu, 01 Jul 2021 06:35:45 GMT																											--响应头
  3. Content-Type: text/plain; charset=utf-8
  4. Content-Length: 12
  5. Connection: keep-alive
  6. Server: Apache/2.4.43 (Win64) OpenSSL/1.1.1g
  7.                                                                                         --空白行
  8. <!DOCTYPE html>																																					--响应体
  9. <html>
  10.   <head>
  11.     <title>hello</title>
  12.   </head>
  13.   <body>
  14.     <h1>Hello World!</h1>
  15.   </body>
  16. </html>

3. 转换器

HttpMessageConverter 是 Spring MVC 中非常重要的一个接口。翻译为：HTTP消息转换器。

该接口下提供了很多实现类，不同的实现类有不同的转换方式。

在这里插入图片描述

3.1 转换器转换的是什么

转换的是HTTP协议与Java程序中的对象之间的互相转换。请看下图：
在这里插入图片描述

上图是我们之前经常写的代码。请求体中的数据是如何转换成 user 对象的，底层实际上使用了 HttpMessageConverter 接口的其中的一个实现类 FormHttpMessageConverter 。

通过上图可以看出 FormHttpMessageConverter 是负责将 请求协议转换为 Java对象 的。

在这里插入图片描述

上图的代码也是之前我们经常写的，Controller 返回值看做逻辑视图名称，视图解析器将其转换成物理视图名称，生成视图对象，StringHttpMessageConverter 负责将视图对象中的 HTML 字符串写入到 HTTP协议的响应体中。最终完成响应。

通过上图可以看出 StringHttpMessageConverter 是负责将 Java对象 转换为响应协议 的。

通过以上内容的学习，大家应该能够了解到 HttpMessageConverter接口是用来做什么的了：

在这里插入图片描述

如上图所示：HttpMessageConverter 接口的可以将请求协议转换成 Java对象；也可以把 Java对象转换为响应协议。

HttpMessageConverter 是接口，Spring MVC 帮我们提供了非常多而丰富的实现类。每个实现类都有自己不同的转换风格。

对于我们程序员来说，Spring MVC 已经帮助我们写好了，我们只需要在不同的业务场景下，选择合适的HTTP消息转换器即可。

怎么选择呢？当然是通过 Spring MVC 为我们提供的注解，我们通过使用不同的注解来启用不同的消息转换器。

我们重点牢牢把握住下面的这两个注解，两个类 ；

  • 两个注解：

@ResponseBody

@RequestBody

  • 两个类：

ResponseEntity

RequestEntity

4. Spring MVC中的 AJAX 请求

SpringMVC+Vue3+Thymeleaf+Axios发送一个简单的AJAX请求。

引入 Vue 和 Axios的js文件：

在这里插入图片描述

导入相关的 jar 依赖

在这里插入图片描述

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <modelVersion>4.0.0</modelVersion>
  7.     <groupId>com.rainbowsea</groupId>
  8.     <artifactId>springmvc-008</artifactId>
  9.     <version>1.0-SNAPSHOT</version>
  10.     <packaging>war</packaging>
  12.     <properties>
  13.         <maven.compiler.source>17</maven.compiler.source>
  14.         <maven.compiler.target>17</maven.compiler.target>
  15.     </properties>
  18.     <dependencies>
  19.         <!--springmvc依赖-->
  20.         <dependency>
  21.             <groupId>org.springframework</groupId>
  22.             <artifactId>spring-webmvc</artifactId>
  23.             <version>6.1.4</version>
  24.         </dependency>
  25.         <!--logback依赖-->
  26.         <dependency>
  27.             <groupId>ch.qos.logback</groupId>
  28.             <artifactId>logback-classic</artifactId>
  29.             <version>1.5.3</version>
  30.         </dependency>
  31.         <!--servlet依赖-->
  32.         <dependency>
  33.             <groupId>jakarta.servlet</groupId>
  34.             <artifactId>jakarta.servlet-api</artifactId>
  35.             <version>6.0.0</version>
  36.             <scope>provided</scope>
  37.         </dependency>
  38.         <!--thymeleaf和spring6整合的依赖-->
  39.         <dependency>
  40.             <groupId>org.thymeleaf</groupId>
  41.             <artifactId>thymeleaf-spring6</artifactId>
  42.             <version>3.1.2.RELEASE</version>
  43.         </dependency>
  45.         <!--        引入jackson依赖，可以将java对象转换为json格式字符串-->
  46.         <!--        专门负责将Java对象转换成JSON格式字符串的组件，
  47.         当然，它也可以将JSON格式的字符串转换成Java对象-->
  48.         <dependency>
  49.             <groupId>com.fasterxml.jackson.core</groupId>
  50.             <artifactId>jackson-databind</artifactId>
  51.             <version>2.17.0</version>
  52.         </dependency>
  53.     </dependencies>
  55. </project>

web.xml 文件的相关配置信息内容：

在这里插入图片描述

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <web-app xmlns="https://jakarta.ee/xml/ns/jakartaee"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="https://jakarta.ee/xml/ns/jakartaee https://jakarta.ee/xml/ns/jakartaee/web-app_5_0.xsd"
  5.          version="5.0">
  8.     <!--    字符编码过滤器-->
  9.     <filter>
  10.         <filter-name>CharacterEncodingFilter</filter-name>
  11.         <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
  12.         <init-param>
  13.             <param-name>encoding</param-name>
  14.             <param-value>UTF-8</param-value>
  15.         </init-param>
  16.         <init-param>
  17.             <param-name>forceRequestEncoding</param-name>
  18.             <param-value>true</param-value>
  19.         </init-param>
  20.         <init-param>
  21.             <param-name>forceResponseEncoding</param-name>
  22.             <param-value>true</param-value>
  23.         </init-param>
  24.     </filter>
  25.     <filter-mapping>
  26.         <filter-name>CharacterEncodingFilter</filter-name>
  27.         <url-pattern>/*</url-pattern>
  28.     </filter-mapping>
  30.     <!--    前端控制器-->
  31.     <servlet>
  32.         <servlet-name>DispatcherServlet</servlet-name>
  33.         <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
  34.         <init-param>
  35.             <param-name>contextConfigLocation</param-name>
  36.             <param-value>classpath:springmvc.xml</param-value>
  37.         </init-param>
  38.     </servlet>
  39.     <servlet-mapping>
  40.         <servlet-name>DispatcherServlet</servlet-name>
  41.         <!--        除了 jsp 页面其他的都走这个-->
  42.         <url-pattern>/</url-pattern>
  43.     </servlet-mapping>
  46.     <!--    添加一个过滤器，这个过滤器是springmvc提前写好的，直接用就行了，这个过滤器可以帮助你将请求
  47.     POST转换成PUT请求/DELETE请求-->
  48.     <!--    同时注意：该过滤器一定要在字符编码过滤器后面配置，不然，先设置的话，可能会出现获取到的请求数据是乱码-->
  50.     <filter>
  51.         <filter-name>HiddenHttpMethodFilter</filter-name>
  52.         <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
  53.     </filter>
  54.     <filter-mapping>
  55.         <filter-name>HiddenHttpMethodFilter</filter-name>
  56.         <!--        表示任意的 请求-->
  57.         <url-pattern>/*</url-pattern>
  58.     </filter-mapping>
  59. </web-app>

相关 springmvc.xml 文件配置信息的编写：

其中重点是：静态资源处理、开启注解驱动、视图控制器映射等相关配置。

在这里插入图片描述

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <beans xmlns="http://www.springframework.org/schema/beans"
  3.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.        xmlns:context="http://www.springframework.org/schema/context"
  5.        xmlns:mvc="http://www.springframework.org/schema/mvc"
  6.        xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd">
  9.     <!--    组件扫描-->
  10.     <context:component-scan
  11.             base-package="com.rainbowsea.springmvc.controller,com.rainbowsea.springmvc.service"></context:component-scan>
  13.     <!--视图解析器-->
  14.     <bean id="thymeleafViewResolver" class="org.thymeleaf.spring6.view.ThymeleafViewResolver">
  15.         <property name="characterEncoding" value="UTF-8"/>
  16.         <property name="order" value="1"/>
  17.         <property name="templateEngine">
  18.             <bean class="org.thymeleaf.spring6.SpringTemplateEngine">
  19.                 <property name="templateResolver">
  20.                     <bean class="org.thymeleaf.spring6.templateresolver.SpringResourceTemplateResolver">
  21.                         <property name="prefix" value="/WEB-INF/thymeleaf/"/>
  22.                         <property name="suffix" value=".html"/>
  23.                         <property name="templateMode" value="HTML"/>
  24.                         <property name="characterEncoding" value="UTF-8"/>
  25.                     </bean>
  26.                 </property>
  27.             </bean>
  28.         </property>
  29.     </bean>
  32.     <!--    视图控制器映射-->
  33.     <mvc:view-controller path="/" view-name="index"></mvc:view-controller>
  35.     <!--    开启注解驱动-->
  36.     <mvc:annotation-driven></mvc:annotation-driven>
  38.     <!--    静态资源处理-->
  39.     <mvc:default-servlet-handler></mvc:default-servlet-handler>
  42. </beans>

Vue3 + Thymeleaf + Axios 发送 AJAX 请求：

在这里插入图片描述

  1. <!DOCTYPE html>
  2. <html lang="en" xmlns:th="http://www.thymeleaf.org">
  3. <head>
  4.     <meta charset="UTF-8">
  5.     <title>首页</title>
  6.     <script th:src="@{/static/js/vue3.4.21.js}"></script>
  7.     <script th:src="@{/static/js/axios.min.js}"></script>
  8. </head>
  9. <body>
  10. <h1>使用 Vue3 + axios + Thymeleaf + SpringMVC 发送 AJAX 请求</h1>
  11. <hr>
  12. <div id="app">
  13.     <h1>{{message}}</h1>
  14.     <button @click="getMessage">获取消息</button>
  15. </div>
  17. <script th:inline="javascript">
  18.     Vue.createApp({
  19.         data() {
  20.             return {
  21.                 message: ''
  22.             }
  23.         },
  24.         methods: {
  25.             //异步方法(ajax请求多数情况下都是异步请求)
  26.             async getMessage() {
  27.                 try {
  28.                     // 发送 ajax请求
  29.                     // await axios.get('/springmvc/ajax')
  30.                     //动态获取 应用的根/springmvc/
  31.                     const response = await axios.get([[@{/}]] + 'ajax')
  32.                         // 将返回的数据交给 message
  33.                         this.message = response.data
  34.                 }catch
  35.                     (e)
  36.                     {
  37.                         console.error(e)
  38.                     }
  39.                 }
  40.             }
  41.         }).mount("#app")
  42. </script>
  45. </body>
  46. </html>

重点来了，Controller 怎么写呢？

之前我们都是传统的请求，Controller 返回一个 逻辑视图名 。然后交给 视图解析器 —>进行解析，最后跳转页面。而 AJAX 请求是不需要跳转页面的，因为 AJAX 是页面局部刷新，以前我们在 Servlet 中使用 response.getWriter( ).print("message") 的方式响应。在 Spring MVC 中怎么办呢？当然，我们在 Spring MVC 中也可以使用 Servelt 原生API 来完成整个功能，代码如下：

在这里插入图片描述

或者这样也行：不需要有返回值

在这里插入图片描述

  2. import jakarta.servlet.http.HttpServletResponse;
  3. import org.springframework.stereotype.Controller;
  4. import org.springframework.web.bind.annotation.RequestMapping;
  5. import org.springframework.web.bind.annotation.RequestMethod;
  7. import java.io.IOException;
  8. import java.io.PrintWriter;
  10. @Controller  // 交给 Spring IOC 容器管理
  11. public class AJAXController {
  13.     @RequestMapping(value = "/ajax",method = RequestMethod.GET)
  14.     public void ajax(HttpServletResponse response) throws IOException {
  15.         PrintWriter writer = response.getWriter();
  16.         writer.print("hell ajax,my name is Spring MVC");
  18.     }
  20. }

启动服务器测试：http://localhost:8080/springmvc/

在这里插入图片描述

注意：如果采用这种方式响应，则和 springmvc.xml 文件中配置的视图解析器没有关系，不走视图解析器了。

难道我们以后 AJAX 请求 要使用上面这种原生Servlet API吗？

不需要，我们可以使用 SpringMVC 中提供的 HttpMessageConverter 消息转换器。

我们要向前端响应一个字符串 "hell ajax,my name is Spring MVC" ，这个 "hell ajax,my name is Spring MVC" 就是响应协议中的响应体。
我们可以使用 @ResponseBody注解 来启用对应的消息转换器。而这种消息转换器只负责将Controller返回的信息以响应体的形式写入响应协议。

5. @ResponseBody 将服务器端的 return 返回值转化为“字符串(JSON格式的字符串)”再返回给客户端

在这里插入图片描述

上面的 AJAX 案例，Controller的代码可以修改为：

在这里插入图片描述

  3. import jakarta.servlet.http.HttpServletResponse;
  4. import org.springframework.stereotype.Controller;
  5. import org.springframework.web.bind.annotation.RequestBody;
  6. import org.springframework.web.bind.annotation.RequestMapping;
  7. import org.springframework.web.bind.annotation.RequestMethod;
  8. import org.springframework.web.bind.annotation.ResponseBody;
  10. import java.io.IOException;
  11. import java.io.PrintWriter;
  13. @Controller  // 交给 Spring IOC 容器管理
  14. public class AJAXController {
  17.     @RequestMapping(value = "/ajax", method = RequestMethod.GET)
  18.     @ResponseBody   // 由于你使用了 @ResponseBody 注解
  19.     public String ajax() {
  20.         // 当前处理器方法上添加了 @ResponseBoay 注解，
  21.         // 那么这个方法的返回值不再是逻辑视图名称了
  22.         // 而是作为响应协议的响应体进行响应。
  23.         return "hell ajax,my name is Spring MVC";
  24.     }

最核心需要理解的位置是：return "hell ajax,my name is Spring MVC";

这里的 "hell ajax,my name is Spring MVC" 不是逻辑视图名称了，而是作为响应体的内容进行响应。直接输出到浏览器客户端。

以上程序中使用的消息转换器是：StringHttpMessageConverter，为什么会启用这个消息转换器呢？因为你添加了 @ResponseBody 这个注解了。

启动服务器测试：http://localhost:8080/springmvc/

在这里插入图片描述

通常 AJAX 请求需要服务器给返回一段JSON格式的字符串，可以返回JSON格式的字符串吗？

这是完全可以的，此时底层使用的消息转换器还是：StringHttpMessageConverter

当然可以，代码如下：

在这里插入图片描述

  3. import jakarta.servlet.http.HttpServletResponse;
  4. import org.springframework.stereotype.Controller;
  5. import org.springframework.web.bind.annotation.RequestBody;
  6. import org.springframework.web.bind.annotation.RequestMapping;
  7. import org.springframework.web.bind.annotation.RequestMethod;
  8. import org.springframework.web.bind.annotation.ResponseBody;
  10. import java.io.IOException;
  11. import java.io.PrintWriter;
  13. @Controller  // 交给 Spring IOC 容器管理
  14. public class AJAXController {
  17.     @RequestMapping(value = "/ajax", method = RequestMethod.GET)
  18.     @ResponseBody   // 由于你使用了 @ResponseBody 注解
  19.     public String ajax() {
  20.         // 当前处理器方法上添加了 @ResponseBoay 注解，
  21.         // 那么这个方法的返回值不再是逻辑视图名称了
  22.         // 而是作为响应协议的响应体进行响应。
  24.         // JSON 格式的字符串，然后响应到浏览器
  25.         return "{\"username\":\"zhangsan\",\"password\":\"1234\"}";
  26.         //return "hell ajax,my name is Spring MVC";
  27.     }
  28. }

启动服务器测试：http://localhost:8080/springmvc/

在这里插入图片描述

这是完全可以的，此时底层使用的消息转换器还是：StringHttpMessageConverter

那如果在程序中是一个POJO对象，怎么将POJO对象 以 JSON格式 的字符串响应给浏览器呢 ？两种方式：

  • 第一种方式：自己写代码 将POJO对象 转换成JSON格式的字符串（如上面所示 return "{"username":"zhangsan","password":"1234"}"; ），用上面的方式直接 return即可。

  • 第二种方式：启用MappingJackson2HttpMessageConverter消息转换器。

第二种方式：启用MappingJackson2HttpMessageConverter消息转换器。

启用 MappingJackson2HttpMessageConverter 消息转换器的步骤如下：

第一步： 引入 jackson依赖，可以将 java对象 转换为 json格式字符串

在这里插入图片描述

  1.   <!--        引入jackson依赖，可以将java对象转换为json格式字符串-->
  2.         <!--        专门负责将Java对象转换成JSON格式字符串的组件，
  3.         当然，它也可以将JSON格式的字符串转换成Java对象-->
  4.         <dependency>
  5.             <groupId>com.fasterxml.jackson.core</groupId>
  6.             <artifactId>jackson-databind</artifactId>
  7.             <version>2.17.0</version>
  8.         </dependency>

第二步： 开启注解驱动
这一步非常关键，开启注解驱动后，在 HandlerAdapter 中会自动装配一个消息转换器：MappingJackson2HttpMessageConverter

在这里插入图片描述

  1. <mvc:annotation-driven/>

第三步： 我们想将以 POJO对象转换为 JOSN 格式的字符串，返回给客户端，我们需要创建一个 POJO对象。

在这里插入图片描述

  1. package com.rainbowsea.springmvc.pojo;
  3. public class User {
  5.     private Long id;
  6.     private String name;
  7.     private String password;
  10.     public User() {
  11.     }
  13.     public User(Long id, String name, String password) {
  14.         this.id = id;
  15.         this.name = name;
  16.         this.password = password;
  17.     }
  20.     @Override
  21.     public String toString() {
  22.         return "User{" +
  23.                 "id=" + id +
  24.                 ", name='" + name + '\'' +
  25.                 ", password='" + password + '\'' +
  26.                 '}';
  27.     }
  29.     public Long getId() {
  30.         return id;
  31.     }
  33.     public void setId(Long id) {
  34.         this.id = id;
  35.     }
  37.     public String getName() {
  38.         return name;
  39.     }
  41.     public void setName(String name) {
  42.         this.name = name;
  43.     }
  45.     public String getPassword() {
  46.         return password;
  47.     }
  49.     public void setPassword(String password) {
  50.         this.password = password;
  51.     }
  52. }

第四步： 控制器方法使用 @ResponseBody 注解标注(非常重要），控制器方法返回这个POJO对象

在这里插入图片描述

  3. import com.rainbowsea.springmvc.pojo.User;
  4. import jakarta.servlet.http.HttpServletResponse;
  5. import org.springframework.stereotype.Controller;
  6. import org.springframework.web.bind.annotation.RequestBody;
  7. import org.springframework.web.bind.annotation.RequestMapping;
  8. import org.springframework.web.bind.annotation.RequestMethod;
  9. import org.springframework.web.bind.annotation.ResponseBody;
  11. import java.io.IOException;
  12. import java.io.PrintWriter;
  14. @Controller  // 交给 Spring IOC 容器管理
  15. public class AJAXController {
  18.     @RequestMapping(value = "/ajax", method = RequestMethod.GET)
  19.     @ResponseBody   // 由于你使用了 @ResponseBody 注解
  20.     public User ajax() {
  21.         // 当前处理器方法上添加了 @ResponseBoay 注解，
  22.         // 那么这个方法的返回值不再是逻辑视图名称了
  23.         // 而是作为响应协议的响应体进行响应。
  25.         // 将 POJO对象转换为 JSON格式的字符串，然后响应到浏览器端
  26.         User user = new User(111L, "李华", "123");
  27.         return user;
  30.         // JSON 格式的字符串，然后响应到浏览器
  31.         //return "{\"username\":\"zhangsan\",\"password\":\"1234\"}";
  33.         //return "hell ajax,my name is Spring MVC";
  34.     }
  37. }

启动服务器测试：http://localhost:8080/springmvc/

在这里插入图片描述

以上代码底层启动的就是： MappingJackson2HttpMessageConverter 消息转换器。

它的功能很强大，可以将 POJO对象转换成 JSON格式的字符串，响应给前端。

其实这个消息转换器MappingJackson2HttpMessageConverter 本质上只是比： StringHttpMessageConverter 稍微多了一个 JSON 字符串的转换，其他的还是一样的。

6. 补充：@RestController = (@Controller + @ResponseBody )

在这里插入图片描述

因为我们现代的开发方式都是基于 AJAX 方式的，因此 @ResponseBody注解非常重要，很常用。 为了方便，Spring MVC中提供了一个注解 @RestController。这一个注解代表了：@Controller + @ResponseBody。 @RestController标注在类上即可。

被它标注的@RestController中所有的方法上都会自动标注 @ResponseBody

在这里插入图片描述

  2. import com.rainbowsea.springmvc.pojo.User;
  3. import jakarta.servlet.http.HttpServletResponse;
  4. import org.springframework.stereotype.Controller;
  5. import org.springframework.web.bind.annotation.RequestBody;
  6. import org.springframework.web.bind.annotation.RequestMapping;
  7. import org.springframework.web.bind.annotation.RequestMethod;
  8. import org.springframework.web.bind.annotation.ResponseBody;
  9. import org.springframework.web.bind.annotation.RestController;
  11. import java.io.IOException;
  12. import java.io.PrintWriter;
  15. @RestController  // @Controller + @ResponseBody
  16. public class AJAXController {
  19.     @RequestMapping(value = "/ajax", method = RequestMethod.GET)
  20.     public User ajax() {
  21.         // 当前处理器方法上添加了 @ResponseBoay 注解，
  22.         // 那么这个方法的返回值不再是逻辑视图名称了
  23.         // 而是作为响应协议的响应体进行响应。
  25.         // 将 POJO对象转换为 JSON格式的字符串，然后响应到浏览器端
  26.         User user = new User(111L, "李华", "123");
  27.         return user;
  28.     }
  29. }

在这里插入图片描述

7. @RequestBody 将前端的请求体的信息转换Java程序中的 POJO对象

在这里插入图片描述

该注解只能使用在处理器方法的形参上，
这个注解的作用是直接将请求体传递给Java程序，在Java程序中可以直接使用一个String 类型的变量接收这个请求体的内容。
底层使用的HTTP消息转换器是：FormHttpMessageConvertor

在这里插入图片描述

没有保持一致的话，会赋值失败。

在这里插入图片描述

在这里插入图片描述

在没有使用 @RequestBody 这个注解的时候：

当请求体提交的数据是：

在这里插入图片描述

  1. username=admin&password=123

那么 Spring MVC会自动使用 FormHttpMessageConverter消息转换器，将请求体转换成 对应的 POJO对象，这里是 user对象。

  1. package com.rainbowsea.springmvc.controller;
  4. import com.rainbowsea.springmvc.pojo.User;
  5. import org.springframework.http.HttpHeaders;
  6. import org.springframework.http.HttpMethod;
  7. import org.springframework.http.MediaType;
  8. import org.springframework.http.RequestEntity;
  9. import org.springframework.stereotype.Controller;
  10. import org.springframework.web.bind.annotation.RequestBody;
  11. import org.springframework.web.bind.annotation.RequestMapping;
  12. import org.springframework.web.bind.annotation.RequestMethod;
  14. import java.net.URI;
  17. @Controller  // 交给 Spring IOC 容器管理
  18. public class RequestBodyController {
  19.     @RequestMapping(value = "/save", method = RequestMethod.POST)
  20.     public String saveUser( User user) {
  21.         // @RequestBody 将 将请求体转换成user对象。在方法上使用
  22.         System.out.println(user);
  23.         // 不是逻辑视图，是普通字符串，因为前端发送的请求是 AJAX 请求
  24.         return "ok";
  26.     }
  29. }

在这里插入图片描述

当使用这个注解的时候：这个注解只能出现在方法的参数上。

在这里插入图片描述

  2. import com.rainbowsea.springmvc.bean.User;
  3. import org.springframework.http.HttpHeaders;
  4. import org.springframework.http.HttpMethod;
  5. import org.springframework.http.MediaType;
  6. import org.springframework.http.RequestEntity;
  7. import org.springframework.stereotype.Controller;
  8. import org.springframework.web.bind.annotation.RequestBody;
  9. import org.springframework.web.bind.annotation.RequestMapping;
  10. import org.springframework.web.bind.annotation.RequestMethod;
  12. import java.net.URI;
  15. @Controller  // 交给 Spring IOC 容器管理
  16. public class RequestBodyController {
  18.     @RequestMapping(value = "/save", method = RequestMethod.POST)
  19.     public String save(@RequestBody String requestBodyStr) {
  20.         // @RequestBody 将 将请求体转换成user对象。在方法上使用
  21.          System.out.println("请求体:" + requestBodyStr);
  23.         return "ok";
  25.     }
  26. }

在这里插入图片描述

Spring MVC仍然会使用 FormHttpMessageConverter消息转换器，将请求体直接以字符串形式传递给 requestBodyStr 变量。

7.1 MappingJackson2HttpMessageConverter 将前端提交的 JSON 格式的字符串，转换为 Java程序中的POJO对象

如果在请求体中提交的是一个 JSON 格式的字符串，这个 JSON 字符串传递给 Spring MVC 之后，能不能将 JSON 字符串转换成 POJO 对象呢？

答案是：可以的

此时必须使用 @RequetBody 注解来完成，并且底层使用的消息转换器是：MappingJackson2HttpMessageConverter 。实现步骤如下：

  1. 第一步：引入 jackson 依赖

在这里插入图片描述

  1. 第二步：开启注解驱动

在这里插入图片描述

  1. 第三步：创建POJO类，将POJO类作为控制器方法的参数，并使用 @RequestBody 注解标注该参数。

在这里插入图片描述

  2. import com.rainbowsea.springmvc.pojo.User;
  3. import org.springframework.http.HttpHeaders;
  4. import org.springframework.http.HttpMethod;
  5. import org.springframework.http.MediaType;
  6. import org.springframework.http.RequestEntity;
  7. import org.springframework.stereotype.Controller;
  8. import org.springframework.web.bind.annotation.RequestBody;
  9. import org.springframework.web.bind.annotation.RequestMapping;
  10. import org.springframework.web.bind.annotation.RequestMethod;
  12. import java.net.URI;
  15. @Controller  // 交给 Spring IOC 容器管理
  16. public class RequestBodyController {
  17.     @RequestMapping(value = "/save2", method = RequestMethod.POST)
  18.     public String saveUser(@RequestBody User user) {
  19.         // @RequestBody 将 将请求体转换成user对象。在方法上使用
  20.         System.out.println(user);
  21.         System.out.println(user.getName());
  22.         System.out.println(user.getPassword());
  23.         // 不是逻辑视图，是普通字符串，因为前端发送的请求是 AJAX 请求
  24.         return "ok";
  26.     }
  27. }

第四步：在前端 请求体中提交 json格式 的数据。

在这里插入图片描述

  1. <!DOCTYPE html>
  2. <html lang="en" xmlns:th="http://www.thymeleaf.org">
  3. <head>
  4.     <meta charset="UTF-8">
  5.     <title>首页</title>
  6.     <script th:src="@{/static/js/vue3.4.21.js}"></script>
  7.     <script th:src="@{/static/js/axios.min.js}"></script>
  8. </head>
  9. <body>
  10. <h1>使用 Vue3 + axios + Thymeleaf + SpringMVC 发送 AJAX 请求</h1>
  11. <hr>
  12. <div id="app">
  13.     <h1>{{message}}</h1>
  14.     <button @click="getMessage">获取消息</button>
  15. </div>
  19. <script th:inline="javascript">
  21.     // 发送 ajax post 请求，并且在请求体当中提交json数据
  22.     // 注意：name ,password 要于对应将 json 转换为 Bean对象上的属性名一致
  23.     let jsonObj = {"name": "李华", "password": "123"}
  24.     Vue.createApp({
  25.         data() {
  26.             return {
  27.                 message: ''
  28.             }
  29.         },
  30.         methods: {
  31.             //异步方法(ajax请求多数情况下都是异步请求)
  32.             async getMessage() {
  33.                 console.log("sendjson")
  34.                 try {
  35.                     // 发送 ajax请求
  36.                     // await axios.get('/springmvc/ajax')
  37.                     //动态获取 应用的根/springmvc/
  38.                     const response = await axios.post([[@{/}]] + 'save2',JSON.stringify(jsonObj),{
  39.                         headers
  40.                 :
  41.                     {
  42.                         // 请求体的状态信息
  43.                         "Content-Type"
  44.                     :
  45.                         "application/json"
  46.                     }
  47.                 })
  49.                     // 将返回的数据交给 message
  50.                     this.message = response.data
  51.                 } catch
  52.                     (e) {
  53.                     console.error(e)
  54.                 }
  55.             }
  56.         }
  57.     }).mount("#app")
  58. </script>
  60. </body>
  61. </html>

测试结果：

在这里插入图片描述

8. RequestEntity 类

RequestEntity 不是一个注解，是一个普通的类，这个类的实例封装了整个请求协议：包括请求行，请求头，请求体所有信息。

该 RequestEntity 类出现在控制器方法的参数上。

在这里插入图片描述

使用测试：如下是对应的 html 页面

  1. <!DOCTYPE html>
  2. <html lang="en" xmlns:th="http://www.thymeleaf.org">
  3. <head>
  4.     <meta charset="UTF-8">
  5.     <title>首页</title>
  6.     <script th:src="@{/static/js/vue3.4.21.js}"></script>
  7.     <script th:src="@{/static/js/axios.min.js}"></script>
  8. </head>
  9. <body>
  10. <h1>使用 Vue3 + axios + Thymeleaf + SpringMVC 发送 AJAX 请求</h1>
  11. <hr>
  12. <div id="app">
  13.     <h1>{{message}}</h1>
  14.     <button @click="getMessage">获取消息</button>
  15. </div>
  19. <script th:inline="javascript">
  21.     // 发送 ajax post 请求，并且在请求体当中提交json数据
  22.     // 注意：name ,password 要于对应将 json 转换为 Bean对象上的属性名一致
  23.     let jsonObj = {"name": "李华", "password": "123"}
  24.     Vue.createApp({
  25.         data() {
  26.             return {
  27.                 message: ''
  28.             }
  29.         },
  30.         methods: {
  31.             //异步方法(ajax请求多数情况下都是异步请求)
  32.             async getMessage() {
  33.                 console.log("sendjson")
  34.                 try {
  35.                     // 发送 ajax请求
  36.                     // await axios.get('/springmvc/ajax')
  37.                     //动态获取 应用的根/springmvc/
  38.                     const response = await axios.post([[@{/}]] + 'save2',JSON.stringify(jsonObj),{
  39.                         headers
  40.                 :
  41.                     {
  42.                         // 请求体的状态信息
  43.                         "Content-Type"
  44.                     :
  45.                         "application/json"
  46.                     }
  47.                 })
  49.                     // 将返回的数据交给 message
  50.                     this.message = response.data
  51.                 } catch
  52.                     (e) {
  53.                     console.error(e)
  54.                 }
  55.             }
  56.         }
  57.     }).mount("#app")
  58. </script>
  60. </body>
  61. </html>

在这里插入图片描述

  1. package com.rainbowsea.springmvc.controller;
  4. import com.rainbowsea.springmvc.pojo.User;
  5. import org.springframework.http.HttpHeaders;
  6. import org.springframework.http.HttpMethod;
  7. import org.springframework.http.MediaType;
  8. import org.springframework.http.RequestEntity;
  9. import org.springframework.stereotype.Controller;
  10. import org.springframework.web.bind.annotation.RequestBody;
  11. import org.springframework.web.bind.annotation.RequestMapping;
  12. import org.springframework.web.bind.annotation.RequestMethod;
  14. import java.net.URI;
  17. @Controller  // 交给 Spring IOC 容器管理
  18. public class RequestBodyController {
  19.     @RequestMapping(value = "/save2", method = RequestMethod.POST)
  20.     public String saveUser(RequestEntity<User> requestEntity) {
  21.         // 获取请求方法
  22.         HttpMethod method = requestEntity.getMethod();
  23.         System.out.println(method);
  25.         // 获取请求URL
  26.         URI url = requestEntity.getUrl();
  27.         System.out.println(url);
  29.         // 获取请求头
  30.         HttpHeaders headers = requestEntity.getHeaders();
  31.         System.out.println(headers);
  33.         // 获取请求头中的内容类型
  34.         MediaType contentType = headers.getContentType();
  35.         System.out.println(contentType);
  37.         // 获取请求体：
  38.         User user = requestEntity.getBody();
  39.         System.out.println(user);
  42.         return "ok";
  44.     }
  46. }

测试结果：

在这里插入图片描述

9. ResponseEntity 类

在这里插入图片描述

ResponseEntity 不是注解，而是一个类。使用该类的实例可以封装响应协议，包括：状态行，响应头，响应体。 也就是说：如果你想定制属于自己的响应协议，可以使用该类。

举例：这里假如我们有这么一个需求：

前端提交一个 id，后端根据 id 进行查询，如果返回 null，请在前端显示 404 错误，如果返回不是 null，则输出返回 User 对象。

前端页面设置：

在这里插入图片描述

后端处理：

首先编写一个 Service 进行一个查询处理，这里我们就简单判断一下，就不连接数据库了。

在这里插入图片描述

  1. package com.rainbowsea.springmvc.service;
  4. import com.rainbowsea.springmvc.pojo.User;
  5. import org.springframework.stereotype.Service;
  8. // 注意使用了注解，要用上组件扫描上
  9. @Service
  10. public class UserService {
  13.     public User getById(Long id) {
  14.         if(id == 1) {
  15.             return new User(11L,"张三","123");
  16.         }
  17.         return null;
  18.     }
  19. }

最后是对应 Controller 控制器的编写

在这里插入图片描述

在这里插入图片描述

  1. package com.rainbowsea.springmvc.controller;
  5. import com.rainbowsea.springmvc.pojo.User;
  6. import com.rainbowsea.springmvc.service.UserService;
  7. import org.springframework.beans.factory.annotation.Autowired;
  8. import org.springframework.http.HttpStatus;
  9. import org.springframework.http.ResponseEntity;
  10. import org.springframework.stereotype.Controller;
  11. import org.springframework.web.bind.annotation.PathVariable;
  12. import org.springframework.web.bind.annotation.RequestMapping;
  13. import org.springframework.web.bind.annotation.RequestMethod;
  15. @Controller
  16. public class UserController {
  18.     @Autowired  // Spring 自动赋值，管理
  19.     private UserService userService;
  21.     @RequestMapping(value = "/user/{id}",method = RequestMethod.GET)
  22.     public ResponseEntity<User> getById(@PathVariable("id") Long id) {
  23.         User user = userService.getById(id);
  24.         if(user == null) {
  25.             // HttpStatus.NOT_FOUND  找不到错误  HTTP ERROR 404
  26.             return ResponseEntity.status(HttpStatus.NOT_FOUND).body(null);
  27.         } else {
  28.             return ResponseEntity.ok(user);
  29.         }
  31.     }
  33. }

测试：当用户存在时

在这里插入图片描述

测试：当用户不存在时

在这里插入图片描述

10. 总结：

  1. HTTP 协议包括 请求协议 和 响应协议。
  2. @ResponseBody 将服务器端的 return 返回值转化为“字符串(JSON格式的字符串)”再返回给客户端。
  3. @ResponseBody 将POJO对象 以 JSON格式 的字符串响应给浏览器
    1. 第一种方式：自己写代码 将POJO对象 转换成JSON格式的字符串（如上面所示 return "{"username":"zhangsan","password":"1234"}"; ），用上面的方式直接 return即可。
    2. 第二种方式：启用MappingJackson2HttpMessageConverter消息转换器。
    3. 需要注意的时需要添加：涉及到 JSON格式的转换，都需要导入相关的jar包，以及开启注解驱动。
  4. @RestController = (@Controller + @ResponseBody ), 被它标注的@RestController中所有的方法上都会自动标注 @ResponseBody
  5. @RequestBody 将前端的请求体的信息转换Java程序中的 POJO对象,该注解只能使用在处理器方法的形参上，还可以将 前端的请求体直接以字符串形式传递给 requestBodyStr 变量。
  6. @RequetBody 注解将前端提交的 JSON 格式的字符串，转换为 Java程序中的POJO对象，涉及到 JSON格式的转换，都需要导入相关的jar包，以及开启注解驱动。
  7. RequestEntity 类是一个普通的类，这个类的实例封装了整个请求协议：包括请求行，请求头，请求体所有信息。 该 RequestEntity 类出现在控制器方法的参数上。
  8. ResponseEntity 是一个类。使用该类的实例可以封装响应协议，包括：状态行，响应头，响应体。 也就是说：如果你想定制属于自己的响应协议，可以使用该类。
  9. 无论是那个，只要涉及到 JSON格式的转换，都需要导入相关的jar包，以及开启注解驱动。

11. 最后：

“在这个最后的篇章中，我要表达我对每一位读者的感激之情。你们的关注和回复是我创作的动力源泉，我从你们身上吸取了无尽的灵感与勇气。我会将你们的鼓励留在心底，继续在其他的领域奋斗。感谢你们，我们总会在某个时刻再次相遇。”

在这里插入图片描述

原文链接：https://www.cnblogs.com/TheMagicalRainbowSea/p/18300522

 友情链接：直通硅谷 　点职佳 　北美留学生论坛

Spring热门文章

  • 解决springboot+activemq启动报注解错误的问题
  • Springboot整合Rabbitmq之Confirm和Return机制
  • SpringBoot SpringEL表达式的使用
  • SpringBoot自动配置原理,你真的懂吗?(简单易懂)
  • Spring源码：Bean生命周期（终章）
  • Springboot-Management的项目实践
  • 解决springboot 启动找不到主类的问题
  • Spring5路径匹配器PathPattern解析
  • SpringAOP如何获取方法参数上的注解
  • java与es8实战之五：SpringBoot应用中操作es8(带安全检查：https、账号密码、API Key)

    • Spring推荐文章

  • SpringBoot Session共享，配置不生效问题排查 → 你竟然在代码里下毒！
  • 【Spring源码分析】Spring Scope功能中的动态代理 - Scoped Proxy
  • Spring AOP概念及原理
  • SpringBoot2.7还是任性的，就是不支持Logback1.3，你能奈他何
  • SpringBoot+ Sharding Sphere 轻松实现数据库字段加解密
  • Spring MVC 中视图的实现原理，在Spring MVC 中实现重定向和转发，以及访问静态资源 - Rainbow-Sea
  • Spring MVC 中 HttpMessageConverter 转换器 - Rainbow-Sea
  • SpringBoot+mail 轻松实现各类邮件自动推送
  • Spring MVC 获取三个域(request请求域，session 会话域，application 应用域)对象的方式 - Rainbow-Sea
  • SpringBoot3整合SpringDoc实现在线接口文档

    • 本站QQ群：前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

    W3xue 的所有内容仅供测试，对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
    关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接（目前9元/月）请联系QQ：27243702 沸活量
    皖ICP备17017327号-2　皖公网安备34020702000426号