如何在Spring Boot中自定義一個(gè)HTTP消息轉(zhuǎn)換器

這篇文章將為大家詳細(xì)講解有關(guān)如何在Spring Boot中自定義一個(gè)HTTP消息轉(zhuǎn)換器，文章內(nèi)容質(zhì)量較高，因此小編分享給大家做個(gè)參考，希望大家閱讀完這篇文章后對(duì)相關(guān)知識(shí)有一定的了解。

在構(gòu)建RESTful數(shù)據(jù)服務(wù)過程中，我們定義了controller、repositories，并用一些注解修飾它們，但是到現(xiàn)在為止我們還沒執(zhí)行過對(duì)象的轉(zhuǎn)換——將java實(shí)體對(duì)象轉(zhuǎn)換成HTTP的數(shù)據(jù)輸出流。Spring Boot底層通過HttpMessageConverters依靠Jackson庫將Java實(shí)體類輸出為JSON格式。當(dāng)有多個(gè)轉(zhuǎn)換器可用時(shí)，根據(jù)消息對(duì)象類型和需要的內(nèi)容類型選擇最適合的轉(zhuǎn)換器使用。

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

消息轉(zhuǎn)換器的位置

消息轉(zhuǎn)換器的目標(biāo)是：HTTP輸入請(qǐng)求格式向Java對(duì)象的轉(zhuǎn)換；Java對(duì)象向HTTP輸出請(qǐng)求的轉(zhuǎn)換。有的消息轉(zhuǎn)換器只支持多個(gè)數(shù)據(jù)類型，有的只支持多個(gè)輸出格式，還有的兩者兼?zhèn)?。例如：MappingJackson2HttpMessageConverter可以將Java對(duì)象轉(zhuǎn)換為application/json，而ProtobufHttpMessageConverter僅支持com.google.protobuf.Message類型的輸入，但是可以輸出application/json、application/xml、text/plain和application/x-protobuf這么多格式。

How Do

在項(xiàng)目中有三種辦法配置消息轉(zhuǎn)換器，主要區(qū)別是可定制性和易用度的衡量。

在WebConfiguration類中加入@Bean定義

@Beanpublic ByteArrayHttpMessageConverter byteArrayHttpMessageConverter() {
  return new ByteArrayHttpMessageConverter();
}

重寫（override）configureMessageConverters方法，擴(kuò)展現(xiàn)有的消息轉(zhuǎn)換器鏈表；

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

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

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

分析

Spring提供了多種方法完成同樣的任務(wù)，選擇哪個(gè)取決于我們更側(cè)重便捷性還是更側(cè)重可定制性。

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

通過@Bean定義HttpMessageConverter是向項(xiàng)目中添加消息轉(zhuǎn)換器最簡便的辦法，這類似于之前提到的添加Servlet Filters。如果Spring掃描到HttpMessageConverter類型的bean，就會(huì)將它自動(dòng)添加到調(diào)用鏈中。推薦讓項(xiàng)目中的WebConfiguration繼承自WebMvcConfigurerAdapter。

通過重寫configureMessageConverters方法添加自定義的轉(zhuǎn)換器很方便，但有一個(gè)弱點(diǎn)：如果項(xiàng)目中存在多個(gè)WebMvcConfigurers的實(shí)例（我們自己定義的，或者Spring Boot默認(rèn)提供的），不能確保重寫后的configureMessageConverters方法按照固定順序執(zhí)行。

如果需要更精細(xì)的控制：清除其他消息轉(zhuǎn)換器或者清楚重復(fù)的轉(zhuǎn)換器，可以通過重寫extendMessageConverters完成，仍然有這種可能：別的WebMvcConfigurer實(shí)例也可以重寫這個(gè)方法，但是這種幾率非常小。

關(guān)于如何在Spring Boot中自定義一個(gè)HTTP消息轉(zhuǎn)換器就分享到這里了，希望以上內(nèi)容可以對(duì)大家有一定的幫助，可以學(xué)到更多知識(shí)。如果覺得文章不錯(cuò)，可以把它分享出去讓更多的人看到。