目前做着的项目中有一个向服务器获取树控件数据的模块,结合了之前受到RESTful架构思想的影响,我打算用RESTful的方式来发布资源服务。因为我对RESTful的理解就是一个面向资源的服务架构(我管它叫ROA),那用在这里是挺合适的,至少还能学一种新技术。
我突击了解了几种主流的RESTful框架,比如Restlet, cetia4等等,最终感觉还是Jersey最容易上手,其号称是JAX-RS的参考实现,应该挺专业的。这篇博客将记录我使用Jersey完成的一个测试程序,实现Get方式的多级资源查询。
环境准备:JDK1.6,Tomcat 6.16,Eclipse Galileo JEE版,和jersey-archive-1.1.5
开发过程:首先是在Eclipse中新建一个Dynamic Web Project。因为它自动生成了WEB-INF和META-INF文件,并且提供打包成war文件的选项(其它项目类型可能也行,我就偷懒用它了)。
接着先做点铺垫工作。因为我要求使用XML来响应客户端的请求,那可以用JAXB来把Java类映射成XML文件,Jersey是支持JAXB的,于是先建几个带有JAXB标签的JavaBean,这样后面操作的时候只要直接return我定义的类,框架会自动转成XML格式。例如:
@XmlRootElement(name = "category")
public class CategoryBean {
private String id;
private String name;
public CategoryBean() {
}
public CategoryBean(String id, String name) {
this.id = id;
this.name = name;
}
@XmlAttribute
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
@XmlAttribute
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
}
相应的XML格式为:
<category name="" id=""/>
还要建个类来模拟数据库,供资源类(这是实现RESTful服务的关键类,下面会说)来获取数据。这里建了一个DB类,具体代码就不贴了,看附件吧。实现的功能就是根据id号来获取相应的数据资源。
接着便是写资源类了。资源类负责执行相应URI的响应行为,你不必关心URI地址的捕获问题,这些由框架提供的Servlet实现了。资源类不需要继承任何框架提供的类或接口,只要适当的加一些标签。贴段代码来说明吧:
@Path("/class")
public class ClassResource {
@Context
UriInfo uriInfo;
@Context
Request request;
@GET
@Produces(MediaType.APPLICATION_XML)
public List<ClassBean> getClassList() {
List<ClassBean> classList = new ArrayList<ClassBean>();
classList.addAll(DB.getClassMap().values());
return classList;
}
@Path("{classId}")
public CategoryResource getCategoryList(@PathParam("classId") String id) {
return new CategoryResource(uriInfo, request, id);
}
}
类定义前的@Path("/class")说明这个资源类处理URI的“/class”后的内容。
@Context:使用注释来注入相关上下文对象。
@GET:说明响应GET方式的请求
@Produces:设定响应数据的格式,这里是XML格式。被注释的方法可以直接返回list或是带JAXB标签的自定义类,框架会自动转成XML数据。相对还有个@consumer标签用来定义请求数据的格式,当然这里的Get方法是用不到了。
@Path("{classId}"):在方法定义前加path标签用来实现多级URI的解析。如果参数是在{}中的,说明将作为参数获取其值的,与方法的参数定义中的标签对应。
如果方法的返回类型是一个资源类,则意味着对该URI段之后的内容(含该段)会由这个成员资源类来负责,当然当前资源类会将相应参数传递进成员资源类。以下是成员资源类的代码段:
// 这个类定义前就没有Path标签了。
public class CategoryResource {
@Context
UriInfo uriInfo;
@Context
Request request;
private String id;
public CategoryResource(UriInfo uri, Request req, String id) {
this.id = id;
this.uriInfo = uri;
this.request = req;
}
@GET
@Produces(MediaType.APPLICATION_XML)
public List<CategoryBean> getCategoryList() {
List<CategoryBean> list = new ArrayList<CategoryBean>();
list.addAll(DB.getCategoryMap(id).values());
return list;
}
@Path("{categoryId}")
public ServiceResource getServiceList(@PathParam("categoryId") String id) {
return new ServiceResource(uriInfo, request, id);
}
}
如果需要,可以继续一级级添加下去。当然我这里没有符合RESTful的实践指导来设计URI,只是一个示例说明。
然后要做的就是编辑web.xml了。我的文件内容如下:
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" id="WebApp_ID" version="2.5">
<display-name>TestSample</display-name>
<welcome-file-list>
<welcome-file>index.html</welcome-file>
<welcome-file>index.htm</welcome-file>
<welcome-file>index.jsp</welcome-file>
<welcome-file>default.html</welcome-file>
<welcome-file>default.htm</welcome-file>
<welcome-file>default.jsp</welcome-file>
</welcome-file-list>
<servlet>
<servlet-name>Jersey REST Service</servlet-name>
<servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class>
<init-param>
<param-name>com.sun.jersey.config.property.packages</param-name>
<param-value>cn.edu.njupt.restSample.resources</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>Jersey REST Service</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
</web-app>
资源类类定义前Path标签里的“/”是和部署文件的映射路径有关的,在本例中如果部署文件映射的是"/*",则完整URI应该为http://<host>:<port>/<appctx>/class;如果映射"/test/*",则URI为http://<host>:<port>/<appctx>/test/class,熟悉servlet的应该一看就懂了。
最后要做的就是打包放Tomcat里了。运行Tomcat,因为这个实验中响应的都是Get请求,直接用浏览器就可以测试,输入相应的地址试试吧。
分享到:
相关推荐
jersey构建简单的Restful服务!
Jersey RESTful 框架是开源的RESTful框架, 实现了JAX-RS (JSR 311 & JSR 339) 规范。它扩展了JAX-RS 参考实现, 提供了更多的特性和工具, 可以进一步地简化 RESTful service 和 client 开发。
使用Jersey框架搭建Rest服务
这是一个restful风格的webservice框架,使用官方的jersey 整合mybatis和spring,需要用tomcat8才能运行,
Java使用Jersey框架构建 RESTful Web服务返回json数据所需的jar包。Jackson-core-asl.jar / Jackson-jaxrs.jar / Jackson-mapper-asl.jar / Jackson-xc.jar / jersey-media-json-Jackson.jar
Spring Hibernate, Jersey 创建restful 服务的例子 图文并茂,step by step
python开发,基于flask-restful 的中小型项目,restful风格API接口开发实例,以mongodb作为数据库python开发,基于flask-restful 的中小型项目,restful风格API接口开发实例,以mongodb作为数据库python开发,基于...
基于jersey的restful请求的demo代码,可执行
使用Eclipse开发基于SpringBoot+JAX-RS的Restful服务.docx使用Eclipse开发基于SpringBoot+JAX-RS的Restful服务.docx使用Eclipse开发基于SpringBoot+JAX-RS的Restful服务.docx使用Eclipse开发基于SpringBoot+JAX-RS的...
不过可能因此降低了一些灵活性,但是本框架的定位决定 其使用场景,Rabbit.js比较适合于中小型项目或者个人项目,得益于其快速开发的特点,可以快速搭建restfull的网络服务。 特色 清晰的应用分层,可以帮助您构建...
使用SpringBoot整合jersey 实现Restful web service.同时整合springmvc。
此代码通过c c++实现一个简单的http服务,可以用此实现一个restful api 服务器.
java jersey spring 集成 开发 restful API ,并将restful 返回的数据以JSON的格式返回,开发非常简单,易懂。欢迎小伙伴们 下载资源。
基于Laravel框架的RESTful API构建.pdf
NULL 博文链接:https://liangyingying1117.iteye.com/blog/2155855
RESTful最佳实践之基于 jersey 的增删改查
jersey的使用简单实例
jersey RESTful service 源代码 jersey RESTful service 源代码