sts 创建webservice项目_使用eclipse创建restful webservice 工程

使用环境:jdk1.5+eclispe3.4+myeclispe7

File=>New=>Web Service Project。

project name: restblog,选择REST(JAX-RS) 下一步。

勾选core,jaxb,client,json然后下一步。

之所以创建servlet是因为会请求一些物理不存在的URI，事实上就是这个servlet在处理这些resource。

json就不多说了，这个包可以实现java class 转化成json。

点击finish完成工程创建。

这样创建的工程与通常的web工程的区别就是添加了servlet在web.xml，这里贴出servlet代码：后续的文章中也会提到他。

JAX-RS REST Servlet

JAX-RS REST Servlet

com.sun.jersey.spi.container.servlet.ServletContainer

1

JAX-RS REST Servlet

/services/*

在工程的classpath下会引用下列包：

首先创建一个简单的类Category

使用@XmlRootElement标注该类

点击 图标创建webservice,选择restblog工程，Framework选择REST(JAX-RS)

Java class : CategoryService

URL path: 资源路径 填写category ,这样所有与category相关的资源都使用http://yourpath/services/category访问

LIfecycle: Pre-request(JAX-RS default)每次请求时生成一个服务类实例(这里指CategoryService),singleton:单例，只存在一个实例

Consumes: 接受的contentType 包括application/xml ,application/json 通俗来说就是接受提交数据的格式。

Produces: 产生的数据格式选项同样为applicatin/xml,application/json 等。

注意这里的Consumes/Produces是指请求http://yourpath/services/category的数据格式。

点击 Add 按钮添加服务方法，界面如下：

这是一个构造服务方法的界面，下面有代码预览。在添加参数的时候，选择Param Type选项的意义：

Context: 这是一个标识该参数为请求上下文。可以直接获得request的参数。

QueryParam:uri?之后的参数

PathParam:uri中的参数如：/category/{id}中的id就是PathParam

FormParam:使用post提交的参数。

CookieParam: Cookie参数。

HeaderParam: 请求的头部信息。

也许你已经注意到没有session参数，是的，所谓的"无状态stateless"多少就体现在这里，web服务不保存请求相关的信息。

综合上面的用法，下面的例子涵盖了常用的服务方法的写法，之中的处理过程暂时用硬编码。后面的文章会介绍HIbernate,Spring的应用。

packagecom.dawnpro.restblog;importjava.util.ArrayList;importjava.util.List;importjavax.ws.rs.Consumes;importjavax.ws.rs.DELETE;importjavax.ws.rs.DefaultValue;importjavax.ws.rs.FormParam;importjavax.ws.rs.GET;importjavax.ws.rs.POST;importjavax.ws.rs.PUT;importjavax.ws.rs.Path;importjavax.ws.rs.PathParam;importjavax.ws.rs.Produces;importjavax.ws.rs.core.Context;importjavax.ws.rs.core.UriInfo;importorg.codehaus.jettison.json.JSONException;importorg.codehaus.jettison.json.JSONObject;

@Path("category")publicclassCategoryService {

@GET

@Produces( {"application/json","application/xml"})/*** getCategories 产生json,xml两种数据格式，具体那种格式取决于contentType*/publicListgetCategories() {

Listresult=newArrayList();

result.add(newCategory(1,"第一个分类"));

result.add(newCategory(2,"第二个分类"));returnresult;

}

@GET

@Path("{id}")publicCategory getCategory(@PathParam("id")intid) {returnnewCategory(id,"id为"+id+"的类别");

}

@GET

@Path("json/{id}")

@Produces("application/json")publicJSONObject getCategoryJson(@PathParam("id")intid){//产生jsonJSONObject o=newJSONObject();try{

o.put("id", id);

o.put("name","id为"+id+"的category");

}catch(JSONException e) {

e.printStackTrace();

}returno;

}

@PUT

@Path("add")

@Produces("text/html")

@Consumes( {"application/xml","application/json"})publicString addCategory(Category category) {

System.out.println("处理添加类别逻辑，接受的数据为id:"+category.getId()+",name:"+category.getName());return"ok";

}

@POST

@Path("addbyname")publicString addCategory(@FormParam("categoryname") @DefaultValue("[未命名]") String cateogryname) {

System.out.println("处理添加类别逻辑，接受的数据为name:"+cateogryname);return"添加类别"+cateogryname+"成功";

}

@POST

@Produces("text/html")

@Path("updatecategory")

@Consumes( {"application/xml","application/json"})publicString updateCategory(Category category) {

System.out.println("处理更新类别逻辑，接受的数据为id:"+category.getId()+",name:"+category.getName());return"ok";

}

@DELETE

@Path("delete/{id}")publicString deleteCategory(@PathParam("id")intid) {

System.out.println("处理删除类别逻辑，接受的数据为id:"+id);return"ok";

}

@GET

@Path("commonProcess")publicString commonProcess(@Context UriInfo info){//@Context 参数标识UriInfoStringBuilder buf=newStringBuilder();for(String param: info.getQueryParameters().keySet()) {

buf.append(param+":"+info.getQueryParameters().get(param));

buf.append("\n");

}

System.out.println(buf.toString());return"ok";

}

}

你可以在CategoryService.java编辑中 右键菜单=>MyEclipse=>Add REST Method添加服务方法。

右键工程根目录restblog选择MyEclipse=>Test with RESTful WebServices Explorer 将会打开测试窗口。

浏览中的地址为:http://localhost:8080/restblog/services/application.wadl 首先/services是由servlet拦截。

如果在浏览器中浏览该地址，将得到一个xml文件。这个文件叫web service application description language。顾名思义他是一个服务描述文件。

需要说明的是当调用方法的参数为Category类型，调用时传递的是xml同时contentType设置为application/xml这样jersey会将xml转化为Category类型的对象。如果转化出错则服务调用失败，会返回错误信息。

总结

本节主要介绍在Myeclipse中创建RESTful web service project 以及测试。到目前为止，只写了两个类就轻松的实现了RESTful Web service。

参考资料：

分享到：

2010-08-24 11:52

浏览 4622

评论