天天看點

Spring Boot:定制HTTP消息轉換器

在建構restful資料服務過程中,我們定義了controller、repositories,并用一些注解修飾它們,但是到現在為止我們還沒執行過對象的轉換——将java實體對象轉換成http的資料輸出流。spring boot底層通過httpmessageconverters依靠jackson庫将java實體類輸出為json格式。當有多個轉換器可用時,根據消息對象類型和需要的内容類型選擇最适合的轉換器使用。

Spring Boot:定制HTTP消息轉換器

消息轉換器的位置

消息轉換器的目标是:http輸入請求格式向java對象的轉換;java對象向http輸出請求的轉換。有的消息轉換器隻支援多個資料類型,有的隻支援多個輸出格式,還有的兩者兼備。例如:mappingjackson2httpmessageconverter可以将java對象轉換為application/json,而protobufhttpmessageconverter僅支援com.google.protobuf.message類型的輸入,但是可以輸出application/json、application/xml、text/plain和application/x-protobuf這麼多格式。

在項目中有三種辦法配置消息轉換器,主要差別是可定制性和易用度的衡量。

在webconfiguration類中加入@bean定義

重寫(override)configuremessageconverters方法,擴充現有的消息轉換器連結清單;

更多的控制,可以重寫extendmessageconverters方法,首先清空轉換器清單,再加入自定義的轉換器。

spring提供了多種方法完成同樣的任務,選擇哪個取決于我們更側重便捷性還是更側重可定制性。

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

通過@bean定義httpmessageconverter是向項目中添加消息轉換器最簡便的辦法,這類似于之前提到的添加servlet filters。如果spring掃描到httpmessageconverter類型的bean,就會将它自動添加到調用鍊中。推薦讓項目中的webconfiguration繼承自webmvcconfigureradapter。

通過重寫configuremessageconverters方法添加自定義的轉換器很友善,但有一個弱點:如果項目中存在多個webmvcconfigurers的執行個體(我們自己定義的,或者spring boot預設提供的),不能確定重寫後的configuremessageconverters方法按照固定順序執行。

如果需要更精細的控制:清除其他消息轉換器或者清楚重複的轉換器,可以通過重寫extendmessageconverters完成,仍然有這種可能:别的webmvcconfigurer執行個體也可以重寫這個方法,但是這種幾率非常小。