SpringBoot HttpMessageConverter消息转换器的使用详解

 更新时间:2022年06月07日 11:03:27   作者:骑个小蜗牛  
在整个数据流转过程中,前端的请求报文转化为Java对象,Java对象转化为响应报文,这里就用到了消息转换器HttpMessageConverter

消息转化器的作用

  • 将请求报文转化为Java对象
  • 将Java对象转化为响应报文

消息转化器的主要方法

  • getSupportedMediaTypes:获取支持的MediaType集合(如:text/html,text/plain,application/json)
  • canRead:判断是否能读(请求)
  • read:将请求数据进行格式转换(canRead方法返回值为true时调用)
  • canWrite:判断是否能写(响应)
  • write:将响应数据进行格式转换(canWrite方法返回值为true时调用)

默认配置的消息转化器

SpringMVC启动时会自动配置一些HttpMessageConverter(WebMvcConfigurationSupport类的addDefaultHttpMessageConverters)方法

源码如下:

	protected final void addDefaultHttpMessageConverters(List<HttpMessageConverter<?>> messageConverters) {
		messageConverters.add(new ByteArrayHttpMessageConverter());
		messageConverters.add(new StringHttpMessageConverter());
		messageConverters.add(new ResourceHttpMessageConverter());
		messageConverters.add(new ResourceRegionHttpMessageConverter());
		try {
			messageConverters.add(new SourceHttpMessageConverter<>());
		}
		catch (Throwable ex) {
			// Ignore when no TransformerFactory implementation is available...
		}
		messageConverters.add(new AllEncompassingFormHttpMessageConverter());
		if (romePresent) {
			messageConverters.add(new AtomFeedHttpMessageConverter());
			messageConverters.add(new RssChannelHttpMessageConverter());
		}
		if (jackson2XmlPresent) {
			Jackson2ObjectMapperBuilder builder = Jackson2ObjectMapperBuilder.xml();
			if (this.applicationContext != null) {
				builder.applicationContext(this.applicationContext);
			}
			messageConverters.add(new MappingJackson2XmlHttpMessageConverter(builder.build()));
		}
		else if (jaxb2Present) {
			messageConverters.add(new Jaxb2RootElementHttpMessageConverter());
		}
		if (jackson2Present) {
			Jackson2ObjectMapperBuilder builder = Jackson2ObjectMapperBuilder.json();
			if (this.applicationContext != null) {
				builder.applicationContext(this.applicationContext);
			}
			messageConverters.add(new MappingJackson2HttpMessageConverter(builder.build()));
		}
		else if (gsonPresent) {
			messageConverters.add(new GsonHttpMessageConverter());
		}
		else if (jsonbPresent) {
			messageConverters.add(new JsonbHttpMessageConverter());
		}
		if (jackson2SmilePresent) {
			Jackson2ObjectMapperBuilder builder = Jackson2ObjectMapperBuilder.smile();
			if (this.applicationContext != null) {
				builder.applicationContext(this.applicationContext);
			}
			messageConverters.add(new MappingJackson2SmileHttpMessageConverter(builder.build()));
		}
		if (jackson2CborPresent) {
			Jackson2ObjectMapperBuilder builder = Jackson2ObjectMapperBuilder.cbor();
			if (this.applicationContext != null) {
				builder.applicationContext(this.applicationContext);
			}
			messageConverters.add(new MappingJackson2CborHttpMessageConverter(builder.build()));
		}
	}

部分消息转换器解析

名称描述
MappingJackson2HttpMessageConverter负责读、写JSON格式数据(利用Jackson)
AllEncompassingFormHttpMessageConverter负责读、写Form表单数据
Jaxb2RootElementHttpMessageConverter负责读、写XML格式数据(使用JAXB)
ByteArrayHttpMessageConverter负责读、写二进制格式数据
StringHttpMessageConverter负责读、写字符串格式数据
ResourceHttpMessageConverter负责读、写资源文件数据
SourceHttpMessageConverter负责读、写资源数据

注意事项

系统有默认配置的消息转换器集合。

处理过程会按集合顺序匹配合适的消息转换器,如果有合适的,就会使用该消息转换器处理(读、写),后续的消息转换器不再执行。

自定义的消息转换器要想生效,必须放到集合中相同类型的消息转换器前面,原因参考第二点。

思考:既然自定义的消息转换器必须放到集合中相同类型的消息转换器前面,那是否能直接改动集合中原有的消息转换器来达到自定义的效果,而不必在加一个(暂未没研究)。

添加自定义消息转换器时注意默认消息转换器是否生效

  • WebMvcConfigurer.configureMessageConverters方法会覆盖默认消息转换器集合
  • WebMvcConfigurer.extendMessageConverters方法不会覆盖默认消息转换器集合

到此这篇关于SpringBoot HttpMessageConverter消息转换器的使用详解的文章就介绍到这了,更多相关SpringBoot HttpMessageConverter内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • SpringBoot URL带有特殊字符([]/{}等),报400错误的解决

    SpringBoot URL带有特殊字符([]/{}等),报400错误的解决

    这篇文章主要介绍了SpringBoot URL带有特殊字符([]/{}等),报400错误的解决,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-02-02
  • Java CompletableFuture的使用详解

    Java CompletableFuture的使用详解

    这篇文章主要介绍了Java CompletableFuture的使用详解,帮助大家更好的理解和学习使用Java,感兴趣的朋友可以了解下
    2021-03-03
  • MyBatis-Plus中使用EntityWrappe进行列表数据倒序设置方式

    MyBatis-Plus中使用EntityWrappe进行列表数据倒序设置方式

    这篇文章主要介绍了MyBatis-Plus中使用EntityWrappe进行列表数据倒序设置方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-03-03
  • MyBatis查询缓存实例详解

    MyBatis查询缓存实例详解

    查询缓存的使用,主要是为了提高查询访问速度。这篇文章主要介绍了MyBatis查询缓存,需要的朋友可以参考下
    2017-06-06
  • Mybatis报Type interface *.*Mapper is not known to the MapperRegis

    Mybatis报Type interface *.*Mapper is not&

    本文主要介绍了Mybatis报Type interface *.*Mapper is not known to the MapperRegis,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2024-07-07
  • Java合并区间的实现

    Java合并区间的实现

    本文主要介绍了Java合并区间的实现,通过合理使用集合类和排序算法,可以有效地解决合并区间问题,具有一定的参考价值,感兴趣的可以了解一下
    2023-08-08
  • Maven 多profile及指定编译问题的解决

    Maven 多profile及指定编译问题的解决

    这篇文章主要介绍了Maven 多profile及指定编译问题的解决,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • java编程实现邮件定时发送的方法

    java编程实现邮件定时发送的方法

    这篇文章主要介绍了java编程实现邮件定时发送的方法,涉及Java基于定时器实现计划任务的相关技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-11-11
  • 参数校验Spring的@Valid注解用法解析

    参数校验Spring的@Valid注解用法解析

    这篇文章主要介绍了参数校验Spring的@Valid注解用法,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • python实现高斯模糊及原理详解

    python实现高斯模糊及原理详解

    高斯模糊是一种常见的模糊技术,本文主要介绍了python实现高斯模糊及原理详解,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-05-05

最新评论