欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Spring mvc实现Restful返回xml格式数据实例详解

程序员文章站 2023-11-29 20:11:55
spring mvc实现restful返回xml格式数据 最近,想在自己的小项目中搭建一个restful风格的服务接口api,项目用的spring mvc 3,听说spr...

spring mvc实现restful返回xml格式数据

最近,想在自己的小项目中搭建一个restful风格的服务接口api,项目用的spring mvc 3,听说spring mvc本身就能十分方便的支持restful的实现,于是查询了下资料,果然非常强大。

在一次偶然的#墙#外#(你懂的)状态下浏览到了一个老外的博客,举了几个入门例子十分经典,原文是e文+被墙状态,觉得有必要扒过来收藏学习下。

在本示例中,我们将向您展示如何将对象转换成xml格式并通过spring mvc框架返回给用户。

技术及环境:

spring 3.0.5.release
jdk 1.6
eclipse 3.6
maven 3

1、添加项目依赖

不需要更多,你只要添加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、实体类javabean

一个简单的javabean,添加了jaxb 注解,稍后将会被转换成xml。

jaxb已经包含在jdk1.6中,你不需要添加额外的依赖库,只需要使用注解,spring会自动将其转换为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文档中没有太多的细节,它会自动处理转换。

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处理转换,使用这种方法,你可以不用在方法中使用@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、示例结果

访问url:http://localhost:8080/springmvc/rest/coffee/arabica

Spring mvc实现Restful返回xml格式数据实例详解

感谢阅读,希望能帮助到大家,谢谢大家对本站的支持!