SpringBoot項目中如何定製HTTP消息轉換器

本文首發於個人網站：Spring Boot項目中如何定製HTTP消息轉換器，如需轉載，請註明來源

在構建RESTful數據服務過程中，我們定義了controller、repositories，並用一些註解修飾它們，但是到現在爲止我們還沒執行過對象的轉換——將java實體對象轉換成HTTP的數據輸出流。

Spring Boot底層通過HttpMessageConverters和Jackson庫將Java實體類輸出爲JSON格式。當有多個轉換器可用時，根據消息對象類型和需要的內容類型選擇最適合的轉換器使用。

在SpringMVC源碼剖析（五)-消息轉換器HttpMessageConverter一文中，有一張圖可以很清楚得表示消息轉換器的位置。

消息轉換器的目標是：

1. HTTP輸入請求格式向Java對象的轉換；
2. Java對象向HTTP輸出請求的轉換。

有的消息轉換器只支持多個數據類型，有的只支持多個輸出格式，還有的兩者兼備。

例如：MappingJackson2HttpMessageConverter可以將Java對象轉換爲application/json，而ProtobufHttpMessageConverter僅支持com.google.protobuf.Message類型的輸入，但是可以輸出application/json、application/xml、text/plain和application/x-protobuf這麼多格式。

實踐

在項目中有三種辦法配置消息轉換器，主要是從可定製性和易用度兩個方面進行衡量。

1. 在WebConfiguration類中加入@Bean定義

@Bean
public ByteArrayHttpMessageConverter byteArrayHttpMessageConverter() {
    return new ByteArrayHttpMessageConverter();
}

1. 重寫（override）configureMessageConverters方法，擴展現有的消息轉換器鏈表；

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

1. 更多的控制，可以重寫extendMessageConverters方法，首先清空轉換器列表，再加入自定義的轉換器。

@Override
public 
void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
    converters.clear();
    converters.add(new ByteArrayHttpMessageConverter());
}

分析

Spring Boot提供了多種方法完成同樣的任務，選擇哪個取決於我們更側重便捷性還是更側重可定製性。

上述提到的三種方法各有什麼不同呢？

通過@Bean定義HttpMessageConverter是向項目中添加消息轉換器最簡便的辦法，這類似於之前提到的添加Servlet Filters。如果Spring掃描到HttpMessageConverter類型的bean，就會將它自動添加到調用鏈中。推薦讓項目中的WebConfiguration繼承自WebMvcConfigurerAdapter。

通過重寫configureMessageConverters方法添加自定義的轉換器很方便，但有一個弱點：如果項目中存在多個WebMvcConfigurers的實例（我們自己定義的，或者Spring Boot默認提供的），不能確保重寫後的configureMessageConverters方法按照固定順序執行。

如果需要更精細的控制：清除其他消息轉換器或者清楚重複的轉換器，可以通過重寫extendMessageConverters完成，仍然有這種可能：別的WebMvcConfigurer實例也可以重寫這個方法，但是這種機率非常小。

Spring Boot 1.x系列

1. Spring Boot的自動配置、Command-line-Runner
2. 瞭解Spring Boot的自動配置
3. Spring Boot的@PropertySource註解在整合Redis中的使用

本文由博客一文多發平臺 OpenWrite 發佈！