HttpMessageConverter(消息转换器)

1. HttpMessageConverter 的概述

我们先看HttpMessageConverter的介绍

/**
 * Strategy interface for converting from and to HTTP requests and responses.
 */
public interface HttpMessageConverter<T> {

简单说就是 HTTP request (请求)和response (响应)的转换器。该接口有只有5个方法，简单来说就是获取支持的 MediaType（application/json之类），接收到请求时判断是否能读（canRead），能读则读（read）；返回结果时判断是否能写（canWrite），能写则写（write）

HttpMessageConverter 是 Spring 框架中的一个核心组件，用于在 HTTP 请求和响应之间进行消息转换。它的主要作用是将请求和响应的数据从 Java 对象转换为 HTTP 协议所需的格式，或者将 HTTP 协议中的数据转换为 Java 对象。

在 Spring MVC 中，当客户端发送一个 HTTP 请求时，Spring MVC 会根据请求中的内容类型（Content-Type）选择合适的 HttpMessageConverter 来处理请求体的数据。同样地，当服务器返回一个 HTTP 响应时，Spring MVC 会根据请求中的 Accept 头部信息选择合适的 HttpMessageConverter 来处理响应体的数据。

2. HttpMessageConverter的使用

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

特别说明一下RestController这个注解是一个复合注解，包含了@ResponseBody注解的

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController {

2.1 @RequestBody请求体注解

@RequestBody注解：在控制器方法参数上使用@RequestBody注解，表示将HTTP请求体转换为Java对象。它通常与POST、PUT等HTTP方法一起使用，用于接收客户端发送的数据。Spring框架会根据请求的Content-Type选择适当的HttpMessageConverter进行请求体的解析，并将解析后的Java对象作为方法参数传递给控制器方法。

示例代码片段：

@PostMapping("/example")
public void handleRequest(@RequestBody ExampleRequest requestBody) {
    // 处理请求体数据
}

2.2 RequestEntity请求封装对象

RequestEntity类型：RequestEntity是一个泛型类，用于表示完整的HTTP请求实体，包括请求头、请求体、请求方法和URI等信息。可以在方法参数或返回值中使用RequestEntity类型来获取或定义更多请求信息，例如自定义请求头、响应状态等。它提供了更灵活的方式来处理HTTP请求，允许对请求进行更细粒度的控制。

示例代码片段：

@PostMapping("/example")
public ResponseEntity<String> handleRequest(RequestEntity<ExampleRequest> requestEntity) {
    ExampleRequest requestBody = requestEntity.getBody();
    HttpHeaders requestHeaders = requestEntity.getHeaders();
    
    // 处理请求体和请求头信息
    // 构建响应实体并返回
}

2.3 @ResponseBody响应体注解

@ResponseBody是Spring框架中的一个注解，用于将方法的返回值转换为HTTP响应体。

当在控制器方法上使用@ResponseBody注解时，Spring会通过适当的HttpMessageConverter将方法的返回值转换为HTTP响应体，并设置响应的Content-Type头部。

使用@ResponseBody注解可以方便地将Java对象、字符串等转换为HTTP响应体，常用于返回JSON数据或纯文本数据给客户端。

• 使用的时候首先引入jackjson

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

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

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

示例代码片段：

@GetMapping("/example")
@ResponseBody
public ExampleResponse getExample() {
    ExampleResponse response = new ExampleResponse();
    response.setMessage("Hello, World!");
    return response;
}

2.4 ResponseEntity响应封装对象

ResponseEntity是Spring框架中的一个泛型类，用于表示完整的HTTP响应实体，包括响应头、响应体和响应状态等信息。

通过使用ResponseEntity，我们可以更灵活地构建和定制HTTP响应，包括设置自定义的响应状态码、响应头部和响应体。它允许在控制器方法中明确指定特定的HTTP响应细节，并能够返回不同类型的响应内容（例如JSON、字符串、字节数组等）。

示例代码片段：

@GetMapping("/example")
public ResponseEntity<String> getExample() {
    String responseBody = "Hello, World!";
    HttpHeaders responseHeaders = new HttpHeaders();
    responseHeaders.setContentType(MediaType.TEXT_PLAIN);
    HttpStatus status = HttpStatus.OK;
    
    return new ResponseEntity<>(responseBody, responseHeaders, status);
}

在上述示例中，getExample()方法返回一个ResponseEntity<String>对象，它将字符串"Hello, World!“作为响应体，并设置了Content-Type头部为"text/plain”，状态码为200 OK。

ResponseEntity还提供其他方法来获取和设置响应实体的各个部分，例如：getBody()获取响应体，getHeaders()获取响应头部，getStatusCode()获取响应状态码等。

3. 自定义消息转换器

3.1 步骤一：自定义消息转化器

3.11 FastJson、Gson 等组件自带常用json消息转换器

3.12 实现HttpMessageConverter接口

package com.xmc.hello.config;

import cn.hutool.core.collection.ListUtil;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpInputMessage;
import org.springframework.http.HttpOutputMessage;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
import org.springframework.util.StreamUtils;

import java.io.IOException;
import java.nio.charset.Charset;
import java.util.List;

/**
 * 自定义消息转化器(实现HttpMessageConverter)
 *
 * @author xmc
 */
public class MyHttpMessageConverter implements HttpMessageConverter<Object> {

    private MappingJackson2HttpMessageConverter defaultConverter;

    public MyHttpMessageConverter() {
        this.defaultConverter = new MappingJackson2HttpMessageConverter();
    }

    @Override
    public boolean canRead(Class<?> clazz, MediaType mediaType) {
        // 在此处指定支持的类和媒体类型
        return true;
    }

    @Override
    public boolean canWrite(Class<?> clazz, MediaType mediaType) {
        // 在此处指定支持的类和媒体类型
        return true;
    }

    @Override
    public List<MediaType> getSupportedMediaTypes() {
        // 指定支持的媒体类型
        return ListUtil.of(MediaType.APPLICATION_JSON);
    }

    @Override
    public Object read(Class<?> clazz, HttpInputMessage inputMessage) throws IOException {
        // 自定义读取请求消息的逻辑
        String requestBody = StreamUtils.copyToString(inputMessage.getBody(), Charset.defaultCharset());
        // 在这里进行转换操作，并返回相应的对象
        return null;
    }

    @Override
    public void write(Object o, MediaType contentType, HttpOutputMessage outputMessage) throws IOException {
        // 自定义写入响应消息的逻辑
        HttpHeaders headers = outputMessage.getHeaders();
        // 设置响应头部信息
        headers.setContentType(contentType);
        // 在这里进行转换操作，并将结果写入输出流
    }

    // 其他未覆盖的方法可以继续实现，根据需要进行自定义
}

在上述示例中，我们创建了一个名为 MyHttpMessageConverter 的类，它实现了 HttpMessageConverter<Object> 接口。根据需要，可以设置支持的类和媒体类型，以及自定义读取请求消息和写入响应消息的逻辑。

3.13 继承AbstractHttpMessageConverter类

package com.xmc.hello.config;

import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpInputMessage;
import org.springframework.http.HttpOutputMessage;
import org.springframework.http.MediaType;
import org.springframework.http.converter.AbstractHttpMessageConverter;
import org.springframework.util.StreamUtils;

import java.io.IOException;
import java.nio.charset.Charset;

/**
 * 自定义消息转化器(实现HttpMessageConverter)
 *
 * @author xmc
 */
public class CustomHttpMessageConverter extends AbstractHttpMessageConverter<Object> {
    public CustomHttpMessageConverter() {
        super(MediaType.APPLICATION_JSON);
    }

    @Override
    protected boolean supports(Class<?> clazz) {
        // 在此处指定支持的类
        return true;
    }

    @Override
    protected Object readInternal(Class<? extends Object> clazz, HttpInputMessage inputMessage)
            throws IOException {
        // 自定义读取请求消息的逻辑
        String requestBody = StreamUtils.copyToString(inputMessage.getBody(), Charset.defaultCharset());
        // 在这里进行转换操作，并返回相应的对象
        return null;
    }

    @Override
    protected void writeInternal(Object o, HttpOutputMessage outputMessage) throws IOException {
        // 自定义写入响应消息的逻辑
        HttpHeaders headers = outputMessage.getHeaders();
        // 设置响应头部信息
        headers.setContentType(MediaType.APPLICATION_JSON);
        // 在这里进行转换操作，并将结果写入输出流
    }
}

在上述示例中，我们创建了一个名为CustomHttpMessageConverter 的类，它继承了AbstractHttpMessageConverter<Object> 抽象类。通过调用父类的构造函数并传入媒体类型，我们指定了该自定义消息转换器支持的媒体类型。

然后，我们重写了 supports 方法来指定支持的类。在 readInternal 方法中，您可以实现自定义的请求消息读取逻辑，并在 writeInternal 方法中实现自定义的响应消息写入逻辑。

3.2 步骤二：加载自定义消息转换器

3.21 实现WebMvcConfigurer#configureMessageConverters接口方法

package com.xmc.hello.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import java.util.List;

/**
 * web资源配置
 * @author xmc
 */
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        converters.add(new MyHttpMessageConverter());
    }

}

在上述示例中，我们创建了一个名为WebMvcConfig的配置类，并重写了configureMessageConverters方法，将自定义的消息转换器直接添加到转换器列表中。

3.22 实现WebMvcConfigurer#extendMessageConverters接口方法

package com.xmc.hello.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import java.util.List;

/**
 * web资源配置
 * @author xmc
 */
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    /**
     * 实现 WebMvcConfigurer#extendMessageConverters 接口
     */
    @Override
    public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
        // 注意加载顺序
        converters.add(0, new CustomHttpMessageConverter());
    }

}

在上述示例中，我们创建了一个名为WebMvcConfig的配置类，我们在extendMessageConverters方法中将CustomHttpMessageConverter转换器添加到默认的转换器列表中。

4. 推荐博客

HttpMessageConverter是这样转换数据的

【SpringMVC从入门到精通】06-HttpMessageConverter