HttpMessageConverter 消息转换器

HttpMessageConverter 简介

HttpMessageConverter 是SpringMVC中提供的一个策略接口，它是一个消息转换器类，Spring Mvc中就是由HttpMessageConverter负责转换HTTP的请求和响应。

默认情况下，Spring Boot 会自动加载如下消息类型转换器：

常见消息类型转换器介绍：

StringHttpMessageConverter：负责读取字符串格式的数据和写出二进制格式的数据(当返回值是或者接受值是String类型时，是由这个处理)
MappingJacksonHttpMessageConverter：负责读取和写入json格式的数据；(当返回值是对象或者List，就由这个处理)
ByteArrayHttpMessageConverter：负责读取二进制格式的数据和写出二进制格式的数据；
FormHttpMessageConverter：负责读取form提交的数据（能读取的数据格式为 application/x-www-form-urlencoded，不能读取multipart/form-data格式数据）；负责写入application/x-www-from-urlencoded和multipart/form-data格式的数据；
ResourceHttpMessageConverter：负责读取资源文件和写出资源文件数据；
SourceHttpMessageConverter：负责读取和写入xml中javax.xml.transform.Source定义的数据；
Jaxb2RootElementHttpMessageConverter：负责读取和写入xml 标签格式的数据；
AtomFeedHttpMessageConverter：负责读取和写入Atom格式的数据；
RssChannelHttpMessageConverter：负责读取和写入RSS格式的数据；

数据转换流程

利用SpringMVC框架，可以使得我们在开发时，只要在代码中使用@RequestBody和@ResponseBody两个注解，就可以分别完成从请求报文到对象和从对象到响应报文的转换。而在源码内部，其实这种灵活的消息转换机制就是利用HttpMessageConverter来实现的。

HttpMessageConverter的调用是RequestResponseBodyMethodProcessor类的解析请求参数的方法resolveArgument()和处理返回值的方法handleReturnValue()中进行调用的。这是关于@RequestBody和@ResponseBody两个注解的原理。

消息转换器接口

public interface HttpMessageConverter {

	boolean canRead(Class clazz, @Nullable MediaType mediaType);

	boolean canWrite(Class clazz, @Nullable MediaType mediaType);

	List getSupportedMediaTypes();

	default List getSupportedMediaTypes(Class clazz) {
		return (canRead(clazz, null) || canWrite(clazz, null) ?
				getSupportedMediaTypes() : Collections.emptyList());
	}

	T read(Class clazz, HttpInputMessage inputMessage)
			throws IOException, HttpMessageNotReadableException;

	void write(T t, @Nullable MediaType contentType, HttpOutputMessage outputMessage)
			throws IOException, HttpMessageNotWritableException;

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

转换器加载流程

消息转换器是在项目启动的时候通过WebMvcConfigurationSupport进行加载，当getMessageConverters()被调用的时候会通过configureMessageConverters()、addDefaultHttpMessageConverters()和extendMessageConverters()三个方法进行初始话消息转换器。生成的消息转换器放在List> messageConverters集合中

	protected final List> getMessageConverters() {
        if (this.messageConverters == null) {
            this.messageConverters = new ArrayList();
            // 加载委托给WebMvcConfigurer类型的Bean
            this.configureMessageConverters(this.messageConverters);
            if (this.messageConverters.isEmpty()) {
                // 加载默认的转换器
                this.addDefaultHttpMessageConverters(this.messageConverters);
            }
            // 加载扩展消息转换器
            this.extendMessageConverters(this.messageConverters);
        }
        return this.messageConverters;
    }
1
2
3
4
5
6
7
8
9
10
11
12
13
14

自定义消息转换器

FastJson 、Gson 等组件自带常用json消息转换器
实现HttpMessageConverter 接口
继承 AbstractHttpMessageConverter 类

加载自定义消息转换器

直接注入Bean 的方式替换
实现 WebMvcConfigurer#extendMessageConverters 接口方法

@Configuration
public class CustomWebMvcConfigurer implements WebMvcConfigurer {

    /**
     * 直接注入 HttpMessageConverters
     */
    @Bean
    public HttpMessageConverters customConverters() {
        return new HttpMessageConverters(configFastJsonHttpMessageConverter());
    }

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

    /**
     * 配置JSON 消息转换器
     */
    private HttpMessageConverter