通过 Jersey 客户端 API 调用 REST 风格的 Web 服务

通过 Jersey 客户端 API 调用 REST 风格的 Web 服务



http://www.yeeyan.com/articles/view/ohdarling/32471



Jersey 1.0 是一个开源的、可以用于生产环境的 JAX-RS（RESTful Web Services 的 Java API 规范，JSR-311）实现。通过 Jersey 可以很方便的使用 Java 来创建一个 RESTful Web Services。

一篇早期的技术文章——《在 Java 中实现 RESTful Web Services》，介绍了 RESTful，JAX-RS 以及 Jersey。它同样向你展示了怎样使用 Java 来写一个遵循 JAX-RS 标准的 RESTful Web Services。另一篇文章《在 Jersey 1.0 中为 RESTful Web Services 配置 JSON》说明了怎么通过 Jersey 1.0 来配置数据格式为 JSON（JavaScript 对象符号）。

在这篇文章中，你将学到怎么使用 Jersey 1.0.2 客户端 API 来创建基于 HTTP 的 RESTful Web Services。Jersey 1.0.2 客户端 API 是一个易于使用的，高层的的 Java API，可以帮助你编写任何基于 HTTP 的 RESTful Web Services。这个 API 构建于一个统一的接口规范，其中的一个关键就是 REST 原则。这个统一的接口规范意味着一个基于 REST 的应用程序不管它访问任何 URL，那些 URL 的接口都必须是一样的。


Jersey 客户端 API 基础
要开始使用 Jersey 客户端 API，你首先需要创建一个 com.sun.jersey.api.client.Client 类的实例。下面是最简单的方法：

import com.sun.jersey.api.client.Client;
Client client = Client.create();
Client 类是创建一个 RESTful Web Service 客户端的主要配置点。你可以使用它来配置不同的客户端属性和功能，并且指出使用哪个资源提供者。创建一个 Client 类的实例是一个比较昂贵的操作，所以尽量避免创建一些不需要的客户端实例。比较好的方式是尽可能地复用已经存在的实例。


当你创建完一个 Client 类的实例后，你可以开始使用它。无论如何，在发出请求前，你需要创建一个 WebResource 对象来封装客户端所需要的 Web 资源。例如，以下代码为一个完整地址为 http://example.com/base 的 Web 资源创建了一个 WebResponse 对象：

import com.sun.jersey.api.client.WebResource;
WebResource webResource = c.resource("http://example.com/base");
通过使用 WebResource 对象来创建要发送到 Web 资源的请求，以及处理从 Web 资源返回的响应。例如，你可以使用 WebResource 对象来发送 HTTP GET、PUT、POST 以及 DELETE 请求。

GET 请求：使用 WebResource 类的 get() 方法来提交一个 HTTP GET请求到 Web 资源：

String s = webResource.get(String.class);
这表示如果 WebResource 对象的 URL 是 http://example.com/base，那么一个 HTTP GET 请求将会发送到地址为 http://example.com/base 的资源。如果你熟悉命令行下的 HTTP 工具 curl，那么你可以知道：

String s = webResource.get(String.class);
相应的 curl 命令如下：

curl http://example.com/base
你还可以指定 get() 请求时的查询参数。例如，下面的代码在 get() 请求中指定了两个查询参数：
MultivaluedMap queryParams = new MultivaluedMapImpl();
queryParams.add("param1", "val1");
queryParams.add("param2", "val2");
String s = webResouce.queryParams(queryParams).get(String.class);
相应的 curl 命令如下：

curl http://example.com/base?param1=val1&param2=val2
你还可以指定响应所能接受的 MIME 类型。例如，下面的代码指定了响应的 MIME 类型只能为文本：

String s = webResource.accept("text/plain").get(String.class);
相应的 curl 命令如下：

curl -HAccept:text/plain http://example.com/base
另外，你还可以获取对应请求的 HTTP 状态码，例如下面这个例子展示获取一个请求所返回的文本实体与状态码：

ClientResponse response = webResource.accept("text/plain") .get(ClientResponse.class);int status = response.getStatus();String textEntity = response.getEntity(String.class); ClientResponse 对象代表了一个客户端收到的 HTTP 响应。



PUT 请求：使用 WebResource 类的 put() 方法来提交一个 HTTP PUT 请求到 Web 资源。例如下面的代码展示了请求发送一个文本实体 foo:bar 到指定的 Web 资源:

ClientResponse response = webResource.type("text/plain") .put(ClientResponse.class, "foo:bar"); 相应的 curl 命令如下：

curl -XPUT -HContent-type:text/plain --data "foo:bar" http://example.com/base
同样，你也可以在使用 put() 方法发送请求时指定查询参数，方法与使用 get() 方法时指定查询参数一样。在下面的例子中，把在之前 get() 方法示例中使用过的两个同样的查询参数指定到了一个 put() 请求中：

MultivaluedMap queryParams = new MultivaluedMapImpl();queryParams.add("param1", "val1");queryParams.add("param2", "val2");ClientResponse response = webResource.queryParams(queryParams) .put(ClientResponse.class, "foo:bar"); 相应的 curl 命令如下：

curl -XPUT -HContent-type:text/plain --data "foo:bar" http://example.com/base?param1=val1&param2=val2 POST 请求：一个 POST 请求相当于一个 GET 请求和一个 PUT 请求的综合，也就意味着，你可以使用 POST 请求来发送一个实体到指定的 Web 资源并且接收另一个实体。使用 WebResource 类的 post() 方法来发送一个 HTTP POST 请求到指定的 Web 资源。下面的例子展示了发送一个带有查询参数以及进行了 URL 编码的表单数据的 POST 请求：

MultivaluedMap formData = new MultivaluedMapImpl();formData.add("name1", "val1");formData.add("name2", "val2");ClientResponse response = webResource.type("application/x-www-form-urlencoded") .post(ClientResponse.class, formData); 相应的 curl 命令如下：

curl -d name1=val1 -d name2=val2 http://example.com/base DELETE 请求：使用 WebResource 类的 delete() 方法来发送珍上 HTTP DELETE 请求到指定的 Web 资源。例如，下面的例子展示删除一个 URI 为 http://example.com/base/user/123 资源：

ClientResponse response = webResource.path("user/123") .delete(ClientResponse.class); 相应的 curl 命令如下：

curl -XDELETE http://example.com/base/user/123 另外，WebResource.path() 方法可以在所有 HTTP 请求中使用，它可以让你给要请求的 Web 资源指定一个额外的路径。另一个 WebResouce 类的方法 header() 可以给你的请求添加 HTTP 头部信息。

配置 Jersey 客户端
在发送请求前，你还需要配置 Jersey 客户端，这涉及到注册提供程序。另外你也可以添加过滤器 ，这是可选的操作。你可以查阅 Jersey 1.0.2 客户端 API 来得到所有可选操作的概览。



注册提供程序：在 JAX-RS 中，提供程序是指一个 JAX-RS 扩展的实现。一个提供程序类被一个 @Provier 注解所标注。Jersey 服务器实现了提供程序的基础结构。在实现 JAX-RS 时，Jersey 包含了标准的提供程序类。Jersey 客户端 API 重用了与 Jersey 服务器同样的提供程序基础结构。无论如何，你都必须显式的注册所有非标准的提供程序，因为在客户端不会自动进行类库路径的搜索。



要注册一个提供程序，你需要将提供程序的类添加到 ClientConfig 对象用来创建 Client 类的实例。ClientConfig 类定义了通用的属性名称、功能、属性、提供程序类，以及可以被 Client 对象使用的单例提供程序实例。例如下面的代码注册了一个供 Client 对象使用的 JSON 提供程序：

ClientConfig config = new DefaultClientConfig();config.getClasses().add(JSONRootElementProvider.class);Client client = Client.create(config); 注意 DefaultClientConfig 类的使用，它定义了默认的 Client 配置。



添加过滤器：另外一个在配置 Client 过程中可选的操作是添加过滤器到 Client 实例。过滤器动态的拦截到一个资源类的请求和响应，并且可以修改请求或响应。Jersey 客户端 API 提供了一些工具类过滤器。其中之一是 LoggingFilter，它实现了一个日志记录过滤器。你可以使用一个日志记录过滤器来跟踪客户端与服务器之间的通信，这在调试的时候往往很有用。下面的代码展示了怎么添加一个日志记录过滤器到客户端：

import com.sun.jersey.api.client.filter.LoggingFilterclient.addFilter(new LoggingFilter()); 一个基于 Jersey 客户端的示例

跟随这个提示的是一个使用 Jersey 客户端 API 来存取目前流行的 Twitter 的 Web 服务的应用程序示例。这个示例演示了 Jersey 客户端 API 使用现实世界中基于 HTTP 的 Web 服务的能力。你可以下载这个示例程序 Twitter 客户端的压缩包。解开压缩包后你可以查阅这个客户端的源代码。或者你也可以下载一个可执行的 Twitter 客户端 JAR 文件来看看它是怎么工作的。注意你先需要安装有 Java SE Runtime Environment (JRE) 6 才能运行这个程序。