【原创文章,转载请注明原文章地址,谢谢!】
本小节简单介绍Jersey提供的客户端API(Client API)。Jersey的客户端API能够让我们非常方便的创建出REST的Web服务客户端,不管是客户端应用,还是用于测试的代码,都是非常容易和舒服的。比较原生的使用HTTPUrlConnection或者Apache HttpClient,都更加的方便和强大。本小节的大部分示例代码来源于Jersey的文档(https://jersey.github.io/documentation/latest/client.html)。
依赖
首先我们要了解到,在JAX-RS中,提供了一系列的标准的Client API,而Jersey为了更好的实现和扩展这套API,提供了一种扩展机制,即实现了org.glassfish.jersey.client.spi.Connector接口,就可以提供不同具体实现的Client API实现。比如默认使用JDK的Http(s)URLConnection,也可以使用HttpClient的实现,还可以使用Jetty的实现,grizzly的实现等等。所以,在引入依赖的时候需要注意这点:
<dependency>
<groupId>org.glassfish.jersey.core</groupId>
<artifactId>jersey-client</artifactId>
<version>2.26</version>
</dependency>
默认的实现,使用JDK的实现;可以选择对应其他的实现方式:
<dependency>
<groupId>org.glassfish.jersey.connectors</groupId>
<artifactId>jersey-grizzly-connector</artifactId>
<version>2.26</version>
</dependency>
<dependency>
<groupId>org.glassfish.jersey.connectors</groupId>
<artifactId>jersey-apache-connector</artifactId>
<version>2.26</version>
</dependency>
<dependency>
<groupId>org.glassfish.jersey.connectors</groupId>
<artifactId>jersey-jetty-connector</artifactId>
<version>2.26</version>
</dependency>
比如选择使用grizzly就引入对应的jersey-grizzly-connector,选择使用apache的Httpclient,引入jersey-apache-connector即可。一般情况下,比如针对普通测试,使用默认的JDK实现即可。
Client API快速入门
既然是一种非常方便的代码,我们直接使用一段DEMO来看看Client API的基本使用方式,有一个直观的了解:
Client client = ClientBuilder.newClient();
WebTarget target = client.target("http://localhost:9998").path("resource");
Form form = new Form();
form.param("x", "foo");
form.param("y", "bar");
MyJAXBBean bean =
target.request(MediaType.APPLICATION_JSON_TYPE)
.post(Entity.entity(form,MediaType.APPLICATION_FORM_URLENCODED_TYPE),
MyJAXBBean.class);
非常直观的理解:
1,首先使用ClientBuilder的工厂方法newClient创建一个Client对象,可以理解为一个浏览器(客户端);
2,使用client对象的target方法,创建一个WebTarget,这里注意链式调用,首先使用target方法,接着再使用path方法,即WebTarget对象对应的实际资源地址为http://localhost:9998/resource;
3,创建一个Form对象,代表(或者说模拟一个表单),并为表单创建了两个值域:x,y,对应的值为foo和bar;
4,使用WebTarget对象的request方法创建一个请求,注意请求的期望响应类型为application/json;然后接着使用链式方法post,发起一个POST请求,并且在请求的过程中,传入一个实体(Entity),而这个实体就是我们上面构造的Form表单对象,并且采用的是x-www-form-urlencoded编码格式,post方法的第二个参数,就是接受的响应类型,我们需要把json响应直接转成MyJAXBBean对象。
通过这个例子,我们可以很简单的看到使用Jesey的ClientAPI创建相对复杂的请求的例子。不过,在这个例子中,其实隐藏了很多细节的代码和对象,方法,下面来更进一步的了解。
Client API简介
在上一节中我们通过一个直观的代码对Jersey的Client API有了一个了解,我相信其中的链式代码方式,应该有比较深刻的影响。我已经说到,其实在这段代码之下,隐藏了很多API细节,下面就来通过拆分代码,看看这些细节。