最近,想在自己的小项目中搭建一个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的依赖即可:
3.0.5.RELEASE
org.springframework
spring-core
${spring.version}
org.springframework
spring-web
${spring.version}
org.springframework
spring-webmvc
${spring.version}
2、实体类JavaBean
一个简单的JavaBean,添加了JAXB 注解,稍后将会被转换成xml。
JAXB已经包含在JDK1.6中,你不需要添加额外的依赖库,只需要使用注解,spring会自动将其转换为xml格式。
importjavax.xml.bind.annotation.XmlElement;
importjavax.xml.bind.annotation.XmlRootElement;
@XmlRootElement(name ="coffee")
publicclassCoffee{
Stringname;
intquanlity;
publicStringgetName(){
returnname;
}
@XmlElement
publicvoidsetName(Stringname){
this.name =name;
}
publicintgetQuanlity(){
returnquanlity;
}
@XmlElement
publicvoidsetQuanlity(intquanlity){
this.quanlity =quanlity;
}
publicCoffee(Stringname,intquanlity){
this.name =name;
this.quanlity =quanlity;
}
publicCoffee(){
}
}
3、Controller
添加@ResponseBody注解到你的方法返回值,在spring文档中没有太多的细节,它会自动处理转换。
importorg.springframework.stereotype.Controller;
importorg.springframework.web.bind.annotation.PathVariable;
importorg.springframework.web.bind.annotation.RequestMapping;
importorg.springframework.web.bind.annotation.RequestMethod;
importorg.springframework.web.bind.annotation.ResponseBody;
importcom.mkyong.common.model.Coffee;
@Controller
@RequestMapping("/coffee")
publicclassXMLController{
@RequestMapping(value="{name}",method =RequestMethod.GET)
public@ResponseBodyCoffeegetCoffeeInXML(@PathVariableStringname){
Coffeecoffee =newCoffee(name,100);
returncoffee;
}
}
4、mvc:annotation-driven
在你的spring配置文件中,启用mvc:annotation-driven注解。
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">
或者,你也可以添加spring-oxm.jar依赖,并用以下的MarshallingView处理转换,使用这种方法,你可以不用在方法中使用@ResponseBody注解。
class="org.springframework.web.servlet.view.xml.MarshallingView">
com.mkyong.common.model.Coffee
5、示例结果