Spring Boot：定制HTTP消息转换器

爱被打了一巴掌 2022-05-16 06:50 186阅读 0赞

在构建RESTful数据服务过程中，我们定义了controller、repositories，并用一些注解修饰它们，但是到现在
    为止我们还没执行过对象的转换——将java实体对象转换成HTTP的数据输出流。Spring Boot底层通过
    HttpMessageConverters依靠Jackson库将Java实体类输出为JSON格式。当有多个转换器可用时，根据消息对象
    类型和需要的内容类型选择最适合的转换器使用。
    
    
    在SpringMVC源码剖析（五)-消息转换器HttpMessageConverter一文中，有一张图可以很清楚得表示消息转换器
    的位置。

![æ¶æ¯è½¬æ¢å¨çä½ç½®][f3.png]

消息转换器的目标是：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定义
    
    @Bean
    public ByteArrayHttpMessageConverter byteArrayHttpMessageConverter() {
        return new ByteArrayHttpMessageConverter();
    }
    
    重写（override）configureMessageConverters方法，扩展现有的消息转换器链表；
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        converters.add(new ByteArrayHttpMessageConverter());
    }
    
    更多的控制，可以重写extendMessageConverters方法，首先清空转换器列表，再加入自定义的转换器。
    @Override
    public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
        converters.clear();
        converters.add(new ByteArrayHttpMessageConverter());
    }
    
    分析
    Spring提供了多种方法完成同样的任务，选择哪个取决于我们更侧重便捷性还是更侧重可定制性。
    
    
    上述提到的三种方法各有什么不同呢？
    
    通过@Bean定义HttpMessageConverter是向项目中添加消息转换器最简便的办法，这类似于之前提到的添加
    Servlet Filters。如果Spring扫描到HttpMessageConverter类型的bean，就会将它自动添加到调用链中。
    推荐让项目中的WebConfiguration继承自WebMvcConfigurerAdapter。
    
    
    通过重写configureMessageConverters方法添加自定义的转换器很方便，但有一个弱点：如果项目中存在多
    个WebMvcConfigurers的实例（我们自己定义的，或者Spring Boot默认提供的），不能确保重写后的
    configureMessageConverters方法按照固定顺序执行。
    
    
    如果需要更精细的控制：清除其他消息转换器或者清除重复的转换器，可以通过重写
    extendMessageConverters完成，仍然有这种可能：别的WebMvcConfigurer实例也可以重写这个方法，但是
    这种几率非常小。

转自：杜琪

[f3.png]: /images/20220516/1bb4f5eec54d42a09520906551b06925.png