menu
more_vert
使用 Jersey 和 Apache Tomcat 构建 RESTful Web 服务

作者:dayu

方法/资源 资源集合。 URI 如:
http://host/<appctx>/resources 成员资源,URI 如:
http://host/<appctx>/resources/1234 GET 列出资源集合的全部成员。

检索标识为 1234 的资源的表示形式。 PUT 使用一个集合更新(替换)还有一个集合。 更新标记为 1234 的数字资源。 POST 在集合中创建数字资源,其 ID 是自己主动分配的。

在以下创建一个子资源。 DELETE 删除整个资源集合。 删除标记为 1234 的数字资源。

<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>sample.hello.resources</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>Jersey REST Service</servlet-name> <url-pattern>/rest/*</url-pattern> </servlet-mapping>

如今您将编写一个名为 HelloResource 的资源,它接受 HTTP GET 并响应 “Hello Jersey”。

@Path("/hello") public class HelloResource { @GET @Produces(MediaType.TEXT_PLAIN) public String sayHello() { return "Hello Jersey"; } }

该代码中有几个地方须要强调:

  • 资源类(Resource Class):注意,资源类是一个简单的 Java 对象 (POJO)。能够实现不论什么接口。这添加了很多优点,比方可重用性和简单。
  • 凝视(Annotation):在 javax.ws.rs.* 中定义,是 JAX-RS (JSR 311) 规范的一部分。
  • @Path:定义资源基 URI。由上下文根和主机名组成,资源标识符类似于 http://localhost:8080/Jersey/rest/hello。
  • @GET:这意味着下面方法能够响应 HTTP GET 方法。

  • @Produces:以纯文本方式定义响应内容 MIME 类型。

@Path("/contacts") public class ContactsResource { @Context UriInfo uriInfo; @Context Request request; @GET @Produces({MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON}) public List<Contact> getContacts() { List<Contact> contacts = >new ArrayList<Contact>(); contacts.addAll( ContactStore.getStore().values() ); return contacts; } @Path("{contact}") public ContactResource getContact( @PathParam("contact") String contact) { return new ContactResource(uriInfo, request, contact); } }

有几个有趣的地方须要注意。

  • @Context: 使用该凝视注入上下文对象,比方 Request、Response、UriInfo、ServletContext 等。
  • @Path("{contact}"):这是 @Path 凝视。与根路径 “/contacts” 结合形成子资源的 URI。
  • @PathParam("contact"):该凝视将參数注入方法參数的路径,在本例中就是联系人 id。其它可用的凝视有 @FormParam@QueryParam 等。
  • @Produces:响应支持多个 MIME 类型。在本例和上一个演示样例中。APPLICATION/XML 将是默认的 MIME 类型。

您或许还注意到了。GET 方法返回定制 Java 对象而不是 String(纯文本)。正如上一个 Hello World 演示样例所看到的。

JAX-RS 规范要求实现支持多个表示形式类型。比方 InputStream、byte[]、JAXB 元素、JAXB 元素集合等等,以及将其序列化为 XML、JSON 或纯文本作为响应的能力。下文我将提供很多其它有关表示形式技术的信息,尤其是 JAXB 元素表示形式。

public class ContactResource { @Context UriInfo uriInfo; @Context Request request; String contact; public ContactResource(UriInfo uriInfo, Request request, String contact) { this.uriInfo = uriInfo; this.request = request; this.contact = contact; } @GET @Produces({MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON}) public Contact getContact() { Contact cont = ContactStore.getStore().get(contact); if(cont==null) throw new NotFoundException("No such Contact."); return cont; } }

ContactResource 的代码简单明了。注意下面内容:

  • Representation Type Contact:Contact 是一个简单的 JavaBean,由 @XmlRootElement 凝视,这使它能够表示为 XML 或 JSON。
  • ContactStore:这是基于 HashMap 的内存数据存储库,事实上现对于本文不重要。
@POST @Produces(MediaType.TEXT_HTML) @Consumes(MediaType.APPLICATION_FORM_URLENCODED) public void newContact( @FormParam("id") String id, @FormParam("name") String name, @Context HttpServletResponse servletResponse ) throws IOException { Contact c = new Contact(id,name,new ArrayList<Address>()); ContactStore.getStore().put(id, c); URI uri = uriInfo.getAbsolutePathBuilder().path(id).build(); Response.created(uri).build(); servletResponse.sendRedirect("../pages/new_contact.html"); }

注意该演示样例的下面部分:

  • @Consumes:声明该方法使用 HTML FORM。

  • @FormParam:注入该方法的 HTML 属性确定的表单输入。
  • @Response.created(uri).build(): 构建新的 URI 用于新创建的联系人(/contacts/{id})并设置响应代码(201/created)。您能够使用 http://localhost:8080/Jersey/rest/contacts/<id> 訪问新联系人。

@PUT @Consumes(MediaType.APPLICATION_XML) public Response putContact(JAXBElement<Contact> jaxbContact) { Contact c = jaxbContact.getValue(); return putAndGetResponse(c); } private Response putAndGetResponse(Contact c) { Response res; if(ContactStore.getStore().containsKey(c.getId())) { res = Response.noContent().build(); } else { res = Response.created(uriInfo.getAbsolutePath()).build(); } ContactStore.getStore().put(c.getId(), c); return res; }

我还在本演示样例中包括了很多不同的概念,重点强调下面概念:

  • Consume XML:putContact() 方法接受 APPLICATION/XML 请求类型,而这样的输入 XML 将使用 JAXB 绑定到 Contact 对象。

    您将在下一节中找到client代码。

  • 空响应带有不同的状态码:PUT 请求的响应没有不论什么内容,可是有不同的状态码。假设数据存储库中存在联系人,我将更新该联系人并返回 204/no content。假设没有新联系人。我将创建一个并返回 201/created
@DELETE public void deleteContact() { Contact c = ContactStore.getStore().remove(contact); if(c==null) throw new NotFoundException("No such Contact."); }

@XmlRootElement public class Contact { private String id; private String name; private List<Address> addresses; public Contact() {} public Contact(String id, String name, List<Address> addresses) { this.id = id; this.name = name; this.addresses = addresses; } @XmlElement(name="address") public List<Address> getAddresses() { return addresses; } public void setAddresses(List<Address> addresses) { this.addresses = addresses; } // Omit other getters and setters }

XML representation: <contact> <address> <city>Shanghai</city> <street>Long Hua Street</street> </address> <address> <city>Shanghai</city> <street>Dong Quan Street</street> </address> <id>huangyim</id> <name>Huang Yi Ming</name> </contact> JSON representation: {"contact":[{"address":[{"city":"Shanghai","street":"Long Hua Street"},{"city":"Shanghai","street":"Dong Quan Street"}],"id":"huangyim","name":"Huang Yi Ming"}]}

curl -X PUT -HContent-type:application/xml --data "<contact><id>foo</id> <name>bar</name></contact>" http://localhost:8080/Jersey/rest/contacts/foo

一个通过 “foo” 识别的新联系人将加入到联系人存储库。

您能够使用 URI /contacts 或 /contacts/foo 验证联系人集合或单个联系人。

Client c = Client.create(); WebResource r=c.resource("http://localhost:8080/Jersey/rest/contacts");

第一个 Jersey client演示样例将发送 GET 请求获取全部联系人并打印响应状态码和响应内容,參见清单 11。

ClientResponse response = r.get(ClientResponse.class); System.out.println( response.getStatus() ); System.out.println( response.getHeaders().get("Content-Type") ); String entity = response.getEntity(String.class); System.out.println(entity);

清单 12 展示了还有一个创建通过 “foo” 识别的新联系人的演示样例。

Address[] addrs = { new Address("Shanghai", "Ke Yuan Street") }; Contact c = new Contact("foo", "Foo Bar", Arrays.asList(addrs)); ClientResponse response = r .path(c.getId()) .accept(MediaType.APPLICATION_XML) .put(ClientResponse.class, c); System.out.println(response.getStatus());

注意 WebResource 实例的 API。它构建 URI。设置请求头,并在一行代码中调用请求。内容(Contact 对象)将自己主动绑定到 XML。

清单 13 展示了检索通过 “foo” 识别的联系人(已上一个演示样例中创建)的最后一个演示样例然后删除该联系人。

GenericType<JAXBElement<Contact>> generic = new GenericType<JAXBElement<Contact>>() {}; JAXBElement<Contact> jaxbContact = r .path("foo") .type(MediaType.APPLICATION_XML) .get(generic); Contact contact = jaxbContact.getValue(); System.out.println(contact.getId() + ": " + contact.getName()); ClientResponse response = r.path("foo").delete(ClientResponse.class); System.out.println(response.getStatus());

注意。当您想获取 JAXB bean 响应时,您须要使用 Java 2 Platform, Standard Edition (J2SE) 中引入的范型特性。

使用 Jersey client练习这些演示例子。

您能够在资源包中找到很多其它例子代码。

还能够參考 Jersey 站点查看很多其它信息。

描写叙述 名字 大小 源码 Jersey.Sample.Contact.Src.zip

10KB


使用 Jersey 和 Apache Tomcat 构建 RESTful Web 服务

原文地址:http://www.cnblogs.com/zhchoutai/p/7193634.html