歡迎光臨
每天分享高質量文章

Spring 接口支持傳回多種格式

(點擊上方公眾號,可快速關註)


來源:xiagn ,

xiagn825.github.io/2017/06/23/blog/

1. 簡介

本文介紹使用SpringMVC的後端服務如何通過配置來支持多種傳回值型別(xml,json,html,excel)

這裡的代碼使用的是springboot,下載地址:

https://github.com/xiagn825/springboot-todolist/tree/springboot-ContentNegotiation

2. 基礎概念

2.1 HttpHeader中Content-Type和Accept設置的區別

Accept:接口要傳回給客戶端的資料格式

curl –essay-header ‘Accept:application/json’ http://localhost:8080/todo

Content-Type:客戶端發送給服務器端的資料格式

curl -X PUT –essay-header ‘Content-Type:application/json’ -d ‘{“title”:”周

末日程”,”content”:”睡覺”}’ http://localhost:8080/todo

2.2 SpringMVC生成輸出的兩種方式

1) 當服務端使用Restful的方式,只為客戶端的ajax或其他服務端請求提供資料時,通常會使用@ResponseBody來標識你的傳回,這時候Spring使用HttpMessageConverter來把傳回的物件格式化成所需的格式。

2) 當你需要提供表現層(比如:HTML),這時候SpringMVC使用ViewResolver來將處理你的傳回。

有時候你的應用程式這兩者都要提供

2.3 SpringMVC輸出格式判定

很多時候為了支持多個系統或多個終端,你需要讓相同的資料已不同的表現形式輸出。

SpringMVC使用ContentNegotationStrategy來判定用戶請求希望得到什麼格式的資料。

ContentNegotationStrategy通過三種方式來識別用戶想要傳回什麼樣的資料

  1. 通過請求URL後綴:http://myserver/myapp/accounts/list.html 傳回html格式

  2. 通過請求的引數:http://myserver/myapp/accounts/list?format=xls 該設置預設不開啟,預設key是format。

  3. 通過HTTP Header的Accept:Accept:application/xml 優先級由上至下

請看如下配置

@Override

public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {

    configurer.favorPathExtension(false)

            .favorParameter(true)

            .parameterName(“mediaType”)

            .defaultContentType(MediaType.APPLICATION_JSON)

            .mediaType(“xml”, MediaType.APPLICATION_XML)

            .mediaType(“html”, MediaType.TEXT_HTML)

            .mediaType(“json”, MediaType.APPLICATION_JSON);

}

在你工程的WebMvcConfig中加入以上配置,表示關閉URL後綴的規則,打開請求引數規則並設置請求引數為’mediaType’,預設的傳回格式是json,還支持傳回xml,html。

這三個組件是用來處理傳回不同格式輸出的關鍵

  • Request Mappings: 決定不同的請求到不同的方法並傳回不同的格式.

  • View Resolution: 根據型別傳回合適的表示層.

  • HttpMessageConverters: 將request中的引數轉換成java物件,將java物件轉換成相應的輸出格式到response.

2.4 RequestMappings

2.4.1 RequestMappingHandlerMapping

我們在spring中通常使用的就是RequestMappingHandlerMapping,根據RequestMappingInfo,細化匹配條件,整體的查找過程如下:

AbstractHandlerMethodMapping實現接口getHandlerInternal

1. 使用UrlPathHelper查找request對應的path

2. 查找path對應的HandlerMethod

2.1 從urlMap中直接等值匹配查找匹配條件RequestMappingInfo

2.2 如果等值查找到匹配條件,將其添加到match條件中

2.3 如果沒有找到匹配條件,使用所有的handlerMethod的RequestMappingInfo進行匹配

2.4 對匹配到的Match進行排序,取出最高優先級的Match,並核對是否是唯一的最高優先級

2.5 對匹配到條件,沒有匹配到條件的兩種情況,分別進行封裝

3. 封裝HandlerMethod,確保bean中存的是實體    ContentNegotiationManager其中提供了針對miniType的match條件比較,使框架可以匹配到最合適的處理方法。

2.5 HttpMessageConverter

2.5.1 The Default Message Converters

SpringMvc預設會加載下列HttpMessageConverters:

ByteArrayHttpMessageConverter – converts byte arrays

StringHttpMessageConverter – converts Strings

ResourceHttpMessageConverter – converts org.springframework.core.io.Resource for any type of octet stream

SourceHttpMessageConverter – converts javax.xml.transform.Source

FormHttpMessageConverter – converts form data to/from a MultiValueMap.

Jaxb2RootElementHttpMessageConverter – converts Java objects to/from XML (added only if JAXB2 is present on the classpath)

MappingJackson2HttpMessageConverter – converts JSON (added only if Jackson 2 is present on the classpath)

MappingJacksonHttpMessageConverter – converts JSON (added only if Jackson is present on the classpath)

AtomFeedHttpMessageConverter – converts Atom feeds (added only if Rome is present on the classpath)

RssChannelHttpMessageConverter – converts RSS feeds (added only if Rome is present on the classpath)

我們如果傳回的是使用@ResponseBody來標識的,那麼框架會使用HttpMessageConverter來處理傳回值,預設的xmlCoverter不是特別好用,依賴傳回物體物件上的@XmlRootElement註解,不是很方便所以引入輔助類庫,並自定義MessageConverter這樣可以直接將傳回的物件處理成xml格式。

Gradle import library

compile group: ‘org.springframework’, name: ‘spring-oxm’, version: ‘4.3.9.RELEASE’

compile group: ‘com.thoughtworks.xstream’, name: ‘xstream’, version: ‘1.4.10’

configuration

@Override

public void configureMessageConverters(List> converters) {

    converters.add(createXmlHttpMessageConverter());

    super.configureMessageConverters(converters);

}

private HttpMessageConvertercreateXmlHttpMessageConverter() {

    MarshallingHttpMessageConverter xmlConverter =

            new MarshallingHttpMessageConverter();

    XStreamMarshaller xstreamMarshaller = new XStreamMarshaller();

    xmlConverter.setMarshaller(xstreamMarshaller);

    xmlConverter.setUnmarshaller(xstreamMarshaller);

    return xmlConverter;

}

2.6 View Resolution

2.6.1 頁面render(freemarker)

當需要傳回頁面時就需要由合適的viewResolver來繪製畫面,這裡採用freemarker作為頁面引擎。

Gradle import library

compile(“org.springframework.boot:spring-boot-starter-freemarker”)

看完本文有收穫?請轉發分享給更多人

關註「ImportNew」,看技術乾貨

赞(0)

分享創造快樂