快捷導(dǎo)航

Spring mvc實(shí)現(xiàn)Restful返回xml格式數(shù)據(jù)實(shí)例詳解

更新時(shí)間：2017年03月21日 11:16:32 作者：舒運(yùn)

這篇文章主要介紹了spring mvc實(shí)現(xiàn)Restful返回xml格式數(shù)據(jù)的相關(guān)資料,需要的朋友可以參考下

spring mvc實(shí)現(xiàn)Restful返回xml格式數(shù)據(jù)

最近，想在自己的小項(xiàng)目中搭建一個(gè)Restful風(fēng)格的服務(wù)接口api，項(xiàng)目用的spring mvc 3，聽說(shuō)spring mvc本身就能十分方便的支持restful的實(shí)現(xiàn)，于是查詢了下資料，果然非常強(qiáng)大。

在一次偶然的#墻#外#(你懂的)狀態(tài)下瀏覽到了一個(gè)老外的博客，舉了幾個(gè)入門例子十分經(jīng)典，原文是E文+被墻狀態(tài)，覺得有必要扒過(guò)來(lái)收藏學(xué)習(xí)下。

在本示例中，我們將向您展示如何將對(duì)象轉(zhuǎn)換成xml格式并通過(guò)spring mvc框架返回給用戶。

技術(shù)及環(huán)境：

Spring 3.0.5.RELEASE
JDK 1.6
Eclipse 3.6
Maven 3

1、添加項(xiàng)目依賴

不需要更多，你只要添加spring mvc的依賴即可：

<properties>
 <spring.version>3.0.5.RELEASE</spring.version>
</properties>
<dependencies>
 <!-- Spring 3 dependencies -->
 <dependency>
 <groupId>org.springframework</groupId>
 <artifactId>spring-core</artifactId>
 <version>${spring.version}</version>
 </dependency>
 <dependency>
 <groupId>org.springframework</groupId>
 <artifactId>spring-web</artifactId>
 <version>${spring.version}</version>
 </dependency>
 <dependency>
 <groupId>org.springframework</groupId>
 <artifactId>spring-webmvc</artifactId>
 <version>${spring.version}</version>
 </dependency>
</dependencies>

2、實(shí)體類JavaBean

一個(gè)簡(jiǎn)單的JavaBean，添加了JAXB 注解，稍后將會(huì)被轉(zhuǎn)換成xml。

JAXB已經(jīng)包含在JDK1.6中，你不需要添加額外的依賴庫(kù)，只需要使用注解，spring會(huì)自動(dòng)將其轉(zhuǎn)換為xml格式。

import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
@XmlRootElement(name = "coffee")
public class Coffee {
 String name;
 int quanlity;
 public String getName() {
 return name;
 }
 @XmlElement
 public void setName(String name) {
 this.name = name;
 }
 public int getQuanlity() {
 return quanlity;
 }
 @XmlElement
 public void setQuanlity(int quanlity) {
 this.quanlity = quanlity;
 }
 public Coffee(String name, int quanlity) {
 this.name = name;
 this.quanlity = quanlity;
 }
 public Coffee() {
 }
}

3、Controller

添加@ResponseBody注解到你的方法返回值，在spring文檔中沒有太多的細(xì)節(jié)，它會(huì)自動(dòng)處理轉(zhuǎn)換。

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;
import com.mkyong.common.model.Coffee;
@Controller
@RequestMapping("/coffee")
public class XMLController {
 @RequestMapping(value="{name}", method = RequestMethod.GET)
 public @ResponseBody Coffee getCoffeeInXML(@PathVariable String name) {
 Coffee coffee = new Coffee(name, 100);
 return coffee;
 }
}

4、mvc:annotation-driven

在你的spring配置文件中，啟用mvc:annotation-driven注解。

<beans xmlns="http://www.springframework.org/schema/beans"
 xmlns:context="http://www.springframework.org/schema/context"
 xmlns:mvc="http://www.springframework.org/schema/mvc" 
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="
  http://www.springframework.org/schema/beans  
  http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
  http://www.springframework.org/schema/context 
  http://www.springframework.org/schema/context/spring-context-3.0.xsd
  http://www.springframework.org/schema/mvc
  http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd">
 <context:component-scan base-package="com.mkyong.common.controller" />
 <mvc:annotation-driven />
</beans>

或者，你也可以添加spring-oxm.jar依賴，并用以下的MarshallingView處理轉(zhuǎn)換，使用這種方法，你可以不用在方法中使用@ResponseBody注解。

<beans ...>
 <bean class="org.springframework.web.servlet.view.BeanNameViewResolver" />
 <bean id="xmlViewer" 
 class="org.springframework.web.servlet.view.xml.MarshallingView">
 <constructor-arg>
 <bean class="org.springframework.oxm.jaxb.Jaxb2Marshaller">
 <property name="classesToBeBound">
 <list>
  <value>com.mkyong.common.model.Coffee</value>
 </list>
 </property>
 </bean>
 </constructor-arg>
 </bean>
</beans>

5、示例結(jié)果

訪問(wèn)URL:http://localhost:8080/SpringMVC/rest/coffee/arabica