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

look_w

RESTful Web 服务简介REST 在 2000 年由 Roy Fielding 在博士论文中提出，他是 HTTP 规范 1.0 和 1.1 版的首席作者之一。
REST 中最重要的概念是资源（resources），使用全球 ID（通常使用 URI）标识。客户端应用程序使用 HTTP 方法（GET/ POST/ PUT/ DELETE）操作资源或资源集。RESTful Web 服务是使用 HTTP 和 REST 原理实现的 Web 服务。通常，RESTful            Web 服务应该定义以下方面：

• Web 服务的基/根 URI，比如 http://host/<appcontext>/resources。
• 支持 MIME 类型的响应数据，包括 JSON/XML/ATOM 等等。
• 服务支持的操作集合（例如 POST、GET、PUT 或               DELETE）。

表 1 演示了典型 RESTful Web 服务中使用的资源 URI 和 HTTP 方法。（ 提供了有关 RESTful Web 服务的更多介绍和设计考虑事项。）
表 1. RESTful Web 服务示例方法/资源 资源集合，                  URI 如：
http://host/<appctx>/resources  成员资源，URI                  如：
http://host/<appctx>/resources/1234 GET                 列出资源集合的所有成员。                  检索标识为 1234 的资源的表示形式。               PUT                  使用一个集合更新（替换）另一个集合。                  更新标记为 1234 的数字资源。POST                  在集合中创建数字资源，其 ID 是自动分配的。                  在下面创建一个子资源。DELETE                  删除整个资源集合。                  删除标记为 1234 的数字资源。
JSR 311 (JAX-RS) 和 JerseyJSR 311            或 JAX-RS（用于 RESTful Web Services 的 Java API）的提议开始于 2007 年，1.0 版本到 2008 年 10 月定稿。目前，JSR 311 版本 1.1 还处于草案阶段。该 JSR 的目的是提供一组 API 以简化 REST 样式的 Web 服务的开发。            
在 JAX-RS 规范之前，已经有 Restlet 和 RestEasy 之类的框架，可以帮助您实现 RESTful Web 服务，但是它们不够直观。Jersey 是 JAX-RS 的参考实现，它包含三个主要部分。

•                核心服务器（Core Server）：通过提供 JSR 311 中标准化的注释和 API 标准化，您可以用直观的方式开发 RESTful Web 服务。
•                核心客户端（Core Client）：Jersey 客户端 API 帮助您与 REST 服务轻松通信。
•                集成（Integration）：Jersey 还提供可以轻松集成 Spring、Guice、Apache Abdera 的库。

在本文的以下部分，我介绍了所有这些组件，但是更关注核心服务器。
构建 RESTful Web 服务我将从可以集成到 Tomcat 的 “hello world” 应用程序开始。该应用程序将带领您完成设置环境的过程，并涉及 Jersey 和 JAX-RS 的基础知识。
然后，我将介绍更加复杂的应用程序，深入探讨 JAX-RS 的本质和特性，比如多个 MIME 类型表示形式支持、JAXB 支持等。我将从样例中摘取一些代码片段来介绍重要的概念。
Hello World：第一个 Jersey Web 项目要设置开发环境，您需要以下内容（见  中的下载）：

• IDE：Eclipse IDE for JEE (v3.4+) 或 IBM Rational Application Developer 7.5
• Java SE5 或更高版本
• Web 容器：Apache Tomcat 6.0（Jetty 和其他也可以）
• Jersey 库：Jersey 1.0.3 归档，包含所有必需的库

设置 Jersey 的环境首先，为 Eclipse 上的 Tomcat 6.0 创建服务器运行时。这是用于 RESTful Web 应用程序的 Web 容器。然后创建一个名为 “Jersey” 应用程序，并将目标运行时指定为 Tomcat            6.0。
最后，从 Jersey 开发包中将以下库复制到 WEB-INF 下的库目录：

• 核心服务器：jersey-core.jar，jersey-server.jar，jsr311-api.jar，asm.jar
• 核心客户端：（用于测试）jersey-client.jar
• JAXB 支持：（在高级样例中使用）jaxb-impl.jar，jaxb-api.jar，activation.jar，stax-api.jar，wstx-asl.jar
• JSON 支持：（在高级样例中使用）jersey-json.jar

开发 REST 服务现在，您已经设置好了开发第一个 REST 服务的环境，该服务对客户端发出 “Hello”。
要做到这一点，您需要将所有的 REST 请求发送到 Jersey 容器 —— 在应用程序的 web.xml 文件中定义 servlet 调度程序（参见清单 1）。除了声明 Jersey servlet 外，它还定义一个初始化参数，指示包含资源的 Java 包。
清单 1. 在 web.xml 文件中定义 Jersey servlet 调度程度

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

<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”。
清单 2. sample.hello.resources 包中的 HelloResource

1 2 3 4 5 6 7 8

@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 类型。

测试 Hello 应用程序要测试应用程序，可以打开您的浏览器并输入 URL            http://<host>:<port>/<appctx>/rest/hello。您将看到响应 “Hello Jersey”。这非常简单，使用注释处理请求、响应和方法。
以下部分将涉及 JAX-RS 规范的必要部分，使用 Contacts 示例应用程序中的代码片段进行介绍。您可以在源代码包中找到这个高级样例的所有代码（参见 ）。