spring REST中的內容協商(同一資源,多種展示:xml,json,html)

一.REST內容協商介紹 

RESTful服務中很重要的一個特性便是同一資源,多種表述.也即以下面描述的三種方式:

1.使用http request header: Accept

GET /user/123 HTTP/1.1  
Accept: application/xml                 //將返回xml格式數據  
  
GET /user/123 HTTP/1.1  
Accept: application/json               //將返回json格式數據

2.使用擴展名

/user/123.xml  將返回xml格式數據  
/user/123.json 將返回json格式數據  
/user/123.html 將返回html格式數據

3.使用參數

/user/123?format=xml //將返回xml數據 /user/123?format=json //將返回json數據 

而以上三種各有優缺點:

1.使用Accept header:

   這一種爲教科書中一般描述的一種,理想中這種方式也是最好的,但若是你的資源要給用戶直接經過瀏覽器訪問(即html展示),那麼因爲瀏覽器的差別,發送上來的Accept Header頭將是不同的. 將致使服務器不知要返回什麼格式的數據給你. 下面是瀏覽器的Accept Header

Html代碼 

1. chrome:  
2. Accept:application/xml,application/xhtml+xml,textml;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5  
3.   
4. firefox:  
5. Accept:text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8  
6.   
7. IE8:  
8. Accept:image/gif, image/jpeg, image/pjpeg, image/pjpeg, application/x-shockwave-flash, application/x-silverlight, application/x-ms-application, application/x-ms-xbap, application/vnd.ms-xpsdocument, application/xaml+xml, */*  

 

2.使用擴展名

  喪失了同一url多種展示的方式,但如今這種在實際環境中是使用最多的.由於更加符合程序員的審美觀.

3.使用參數

  如今不少open API是使用這種方式,但可能因爲要編寫的字符較多,因此較少使用.

帶着上面的選擇: 使用擴展名,咱們來看一下spring中如何配置這部分.

二.spring配置

如今spring完成內容協商( content negotiation)的工做是由ContentNegotiatingViewResolver來完成的.它的工做模式支持我上面講的三種, ContentNegotiatingViewResolver是根據客戶提交的MimeType(如 text/html,application/xml)來跟服務端的一組viewResover的MimeType相比較,若是符合,即返回viewResover的數據. 而 /user/123.xml, ContentNegotiatingViewResolver會首先將 .xml 根據mediaTypes屬性將其轉換成 application/xml,而後完成前面所說的比較.

下面是ContentNegotiatingViewResolver的徹底配置.

<bean
		class="org.springframework.web.servlet.view.ContentNegotiatingViewResolver">
		<!-- 設置爲true以忽略對Accept Header的支持 -->
		<property name="ignoreAcceptHeader" value="true" />
		<!-- 在沒有擴展名時即: "/user/1" 時的默認展示形式 -->
		<property name="defaultContentType" value="text/html" />

		<!-- 擴展名至mimeType的映射,即 /user.json => application/json -->
		<property name="mediaTypes">
			<map>
				<entry key="json" value="application/json" />
				<entry key="xml" value="application/xml" />
			</map>
		</property>
		<!-- 用於開啓 /userinfo/123?format=json 的支持 -->
		<property name="favorParameter" value="false" />
		<property name="viewResolvers">
			<list>
				<bean class="org.springframework.web.servlet.view.BeanNameViewResolver" />
				<bean
					class="org.springframework.web.servlet.view.InternalResourceViewResolver">
					<property name="viewClass"
						value="org.springframework.web.servlet.view.JstlView" />
					<property name="prefix" value="/pages" />
					<property name="suffix" value=".jsp"></property>
				</bean>
			</list>
		</property>
		<property name="defaultViews">
			<list>
				<!-- for application/json -->
				<bean
					class="org.springframework.web.servlet.view.json.MappingJacksonJsonView" />
				<!-- for application/xml -->
				<!-- <bean class="org.springframework.web.servlet.view.xml.MarshallingView" 
					> <property name="marshaller"> <bean class="org.springframework.oxm.xstream.XStreamMarshaller"/> 
					</property> </bean> -->
			</list>
		</property>
	</bean>