HttpMessageConverter报文信息转换器的深入讲解

目录

• 前言
• HttpMessageConverter 介绍
• 一、@RequestBody 请求体注解
• 1.1、表单提交模拟
• 1.2、控制器方法示例
• 二、RequestEntity 请求封装对象
• 2.1、控制器方式示例
• 2.2、输出结果
• 三、@ResponseBody 响应体注解
• 3.1、控制器方式示例
• 3.2、SpringMVC 添加Json格式转换器
• 3.3、控制器使用 Json 格式转换器示例
• 3.4、@RestController注解
• 四、ResponseEntity 响应封装对象
• 总结

前言

HttpMessageConverter，报文信息转换器，将请求报文转换为Java对象，或将Java对象转换为响应报文。

HttpMessageConverter提供了两个注解和两个类型：@RequestBody，@ResponseBody，RequestEntity，ResponseEntity。

HttpMessageConverter 介绍

org.springframework.http.converter.HttpMessageConverter 是一个策略接口，接口说明如下：

Strategy interface that specifies a converter that can convert from and to HTTP requests and responses. 简单说就是 HTTP request (请求)和response (响应)的转换器。该接口有只有5个方法，简单来说就是获取支持的 MediaType（application/json之类），接收到请求时判断是否能读（canRead），能读则读（read）；返回结果时判断是否能写（canWrite），能写则写（write）。这几个方法先有个印象即可：

boolean canRead(Class<?> clazz, MediaType mediaType);
boolean canWrite(Class<?> clazz, MediaType mediaType);
List<MediaType> getSupportedMediaTypes();
T read(Class<? extends T> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException;
void write(T t, MediaType contentType, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException;

一、@RequestBody 请求体注解

@RequestBody可以获取请求体，需要在控制器方法设置一个形参。

使用@RequestBody进行标识，当前请求的请求体就会为当前注解所标识的形参赋值。

1.1、表单提交模拟

<form th:action="@{/testRequestBody}" method="post">
    用户名：<input type="text" name="username"><br>
    密码：<input type="password" name="password"><br>
    <input type="submit">
</form>

1.2、控制器方法示例

@RequestMapping("/testRequestBody")
public String testRequestBody(@RequestBody String requestBody){
    System.out.println("requestBody:"+requestBody);
    return "success";
}

输出结果：

requestBody:username=admin&password=123456

二、RequestEntity 请求封装对象

RequestEntity 封装请求报文的一种类型，需要在控制器方法的形参中设置该类型的形参，当前请求的请求报文就会赋值给该形参。

• 通过getHeaders()获取请求头信息
• 通过getBody()获取请求体信息

2.1、控制器方式示例

@RequestMapping("/testRequestEntity")
public String testRequestEntity(RequestEntity<String> requestEntity){
    System.out.println("requestHeader:"+requestEntity.getHeaders());
    System.out.println("requestBody:"+requestEntity.getBody());
    return "success";
}

2.2、输出结果

requestHeader:[host:"localhost:8080", connection:"keep-alive", content-length:"27", cache-control:"max-age=0", sec-ch-ua:"" Not A;Brand";v="99", "Chromium";v="90", "Google Chrome";v="90"", sec-ch-ua-mobile:"?0", upgrade-insecure-requests:"1", origin:"http://localhost:8080", user-agent:"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.93 Safari/537.36"] requestBody:username=admin&password=123

三、@ResponseBody 响应体注解

@ResponseBody用于标识一个控制器方法，可以将该方法的返回值直接作为响应报文的响应体响应到浏览器。

3.1、控制器方式示例

@RequestMapping("/testResponseBody")
@ResponseBody
public String testResponseBody(){
    return "success";
}

结果：浏览器页面显示 success

3.2、SpringMVC 添加Json格式转换器

首先：导入jackson的依赖

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

然后：在SpringMVC的核心配置文件中开启mvc的注解驱动。

此时在HandlerAdaptor中会自动装配一个消息转换器：MappingJackson2HttpMessageConverter，可以将响应到浏览器的Java对象转换为Json格式的字符串。

<mvc:annotation-driven />

3.3、控制器使用 Json 格式转换器示例

在处理器方法上使用 @ResponseBody 注解进行标识。

将Java对象直接作为控制器方法的返回值返回，就会自动转换为Json格式的字符串

@RequestMapping("/testResponseUser")
@ResponseBody
public User testResponseUser(){
    return new User(1001,"admin","123456",23,"男");
}

浏览器的页面中展示的结果：

{"id":1001,"username":"admin","password":"123456","age":23,"sex":"男"}

3.4、@RestController注解

@RestController注解是springMVC提供的一个复合注解，标识在控制器的类上。

相当于为类添加了@Controller注解，并且为其中的每个方法添加了@ResponseBody注解。

四、ResponseEntity 响应封装对象

ResponseEntity 用于控制器方法的返回值类型，该控制器方法的返回值就是响应到浏览器的响应报文。

总结

到此这篇关于HttpMessageConverter报文信息转换器的文章就介绍到这了,更多相关HttpMessageConverter报文信息转换器内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！