查看: 934|回复: 0

[Java语言] 详解Spring Boot 定制HTTP消息转换器

发表于 2017-12-14 08:00:01

在构建RESTful数据服务过程中,我们定义了controller、repositories,并用一些注解修饰它们,但是到现在为止我们还没执行过对象的转换——将java实体对象转换成HTTP的数据输出流。Spring Boot底层通过HttpMessageConverters依靠Jackson库将Java实体类输出为JSON格式。当有多个转换器可用时,根据消息对象类型和需要的内容类型选择最适合的转换器使用。

在SpringMVC源码剖析之消息转换器HttpMessageConverter一文中,有一张图可以很清楚得表示消息转换器的位置。

消息转换器的位置

消息转换器的目标是:HTTP输入请求格式向Java对象的转换;Java对象向HTTP输出请求的转换。有的消息转换器只支持多个数据类型,有的只支持多个输出格式,还有的两者兼备。例如:MappingJackson2HttpMessageConverter可以将Java对象转换为application/json,而ProtobufHttpMessageConverter仅支持com.google.protobuf.Message类型的输入,但是可以输出application/json、application/xml、text/plain和application/x-protobuf这么多格式。

How Do

在项目中有三种办法配置消息转换器,主要区别是可定制性和易用度的衡量。

在WebConfiguration类中加入@Bean定义

  1. @Beanpublic ByteArrayHttpMessageConverter byteArrayHttpMessageConverter() {
  2. return new ByteArrayHttpMessageConverter();
  3. }
复制代码

重写(override)configureMessageConverters方法,扩展现有的消息转换器链表;

  1. @Overridepublic
  2. void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
  3. converters.add(new ByteArrayHttpMessageConverter());
  4. }
复制代码

更多的控制,可以重写extendMessageConverters方法,首先清空转换器列表,再加入自定义的转换器。

  1. @Overridepublic
  2. void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
  3. converters.clear();
  4. converters.add(new ByteArrayHttpMessageConverter());
  5. }
复制代码

分析

Spring提供了多种方法完成同样的任务,选择哪个取决于我们更侧重便捷性还是更侧重可定制性。

上述提到的三种方法各有什么不同呢?

通过@Bean定义HttpMessageConverter是向项目中添加消息转换器最简便的办法,这类似于之前提到的添加Servlet Filters。如果Spring扫描到HttpMessageConverter类型的bean,就会将它自动添加到调用链中。推荐让项目中的WebConfiguration继承自WebMvcConfigurerAdapter。

通过重写configureMessageConverters方法添加自定义的转换器很方便,但有一个弱点:如果项目中存在多个WebMvcConfigurers的实例(我们自己定义的,或者Spring Boot默认提供的),不能确保重写后的configureMessageConverters方法按照固定顺序执行。

如果需要更精细的控制:清除其他消息转换器或者清楚重复的转换器,可以通过重写extendMessageConverters完成,仍然有这种可能:别的WebMvcConfigurer实例也可以重写这个方法,但是这种几率非常小。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持程序员之家。



回复

使用道具 举报