Vert.x Web Client

中英对照表

  • Pump：泵（平滑流式数据读入内存的机制，防止一次性将大量数据读入内存导致内存溢出）
  • Response Codec：响应编解码器（编码及解码工具）
  • Body Codec：响应体编解码器

组件介绍

Vert.x Web Client（Web客户端）是一个异步的 HTTP 和 HTTP/2 客户端。

Web Client使得发送 HTTP 请求以及从 Web 服务器接收 HTTP 响应变得更加便捷，同时提供了额外的高级功能，例如：

  • JSON体的编码和解码

  • 请求和响应泵

  • 请求参数的处理

  • 统一的错误处理

  • 提交表单

制作Web Client的目的并非为了替换Vert.x Core中的 HttpClient，而是基于该客户端，扩展并保留其便利的设置和特性，例如请求连接池（Pooling），HTTP/2的支持，流水线／管线的支持等。当您需要对 HTTP 请求和响应做细微粒度控制时，您应当使用 HttpClient。

另外Web Client并未提供 WebSocket API，此时您应当使用 HttpClient。

使用Web Client

如需使用Vert.x Web Client，请先加入以下依赖：

  • Maven（在 pom.xml文件中）：

    1. <dependency>
    2.   <groupId>io.vertx</groupId>
    3.   <artifactId>vertx-web-client</artifactId>
    4.   <version>3.4.2</version>
    5. </dependency>

  • Gradle（在build.gradle文件中）：

    1. dependencies {
    2.   compile 'io.vertx:vertx-web-client:3.4.2'
    3. }

对Vert.x Core HTTP Client的回顾

Vert.x Web Client使用Vert.x Core的API，如您对此还不熟悉，请先熟悉 HttpClient 的一些基本概念。

创建Web Client

您可使用缺省设置创建一个 WebClient：

  1. WebClient client = WebClient.create(vertx);

您亦可使用配置选项来创建客户端：

  1. WebClientOptions options = new WebClientOptions()
  2.   .setUserAgent("My-App/1.2.3");
  3. options.setKeepAlive(false);
  4. WebClient client = WebClient.create(vertx, options);

Web Client配置选项继承自 HttpClient 配置选项，使用时可根据实际情况选择。

如已在程序中创建 HttpClient，可用以下方式复用：

  1. WebClient client = WebClient.wrap(httpClient);

发送请求

无请求体的简单请求

一般情况下，HTTP GET，OPTIONS以及HEAD请求没有请求体，可用以下方式发送无请求体的HTTP Requests（HTTP请求）：

  1. WebClient client = WebClient.create(vertx);
  3. // 发送GET请求
  4. client
  5.   .get(8080, "myserver.mycompany.com", "/some-uri")
  6.   .send(ar -> {
  7.     if (ar.succeeded()) {
  8.       // 获取响应
  9.       HttpResponse<Buffer> response = ar.result();
  11.       System.out.println("Received response with status code" + response.statusCode());
  12.     } else {
  13.       System.out.println("Something went wrong " + ar.cause().getMessage());
  14.     }
  15.   });
  17. //发送HEAD请求
  18. client
  19.   .head(8080, "myserver.mycompany.com", "/some-uri")
  20.   .send(ar -> {
  21.     if (ar.succeeded()) {
  22.       // 获取响应
  23.       HttpResponse<Buffer> response = ar.result();
  25.       System.out.println("Received response with status code" + response.statusCode());
  26.     } else {
  27.       System.out.println("Something went wrong " + ar.cause().getMessage());
  28.     }
  29.   });

您可用以下链式方式向请求URI添加查询参数

  1. client
  2.   .get(8080, "myserver.mycompany.com", "/some-uri")
  3.   .addQueryParam("param", "param_value")
  4.   .send(ar -> {});

在请求URI中的参数将会被预填充

  1. HttpRequest<Buffer> request = client.get(8080, "myserver.mycompany.com", "/some-uri?param1=param1_value&param2=param2_value");
  3. // 添加param3（参数3）
  4. request.addQueryParam("param3", "param3_value");
  6. // 覆盖param2（参数2）
  7. request.setQueryParam("param2", "another_param2_value");

设置请求URI将会自动清除已有的查询参数

  1. HttpRequest<Buffer> request = client.get(8080, "myserver.mycompany.com", "/some-uri");
  3. // 添加param1（参数1）
  4. request.addQueryParam("param1", "param1_value");
  6. // 覆盖param1（参数1）同时新增param2（参数2）
  7. request.uri("/some-uri?param1=param1_value&param2=param2_value");

填充请求体

如需要发送请求体，可使用相同的API并在最后加上 sendXXX 方法发送相应的请求体。

例如用 sendBuffer 方法发送一个缓冲体：

  1. client
  2.   .post(8080, "myserver.mycompany.com", "/some-uri")
  3.   .sendBuffer(buffer, ar -> {
  4.     if (ar.succeeded()) {
  5.       // Ok
  6.     }
  7.   });

有时候我们并不希望将所有数据一次性全部读入内存，因为文件太大或希望同时处理多个请求，希望每个请求仅使用最小的内存。出于此目的，Web Client可用 sendStream 方法发送流式数据 ReadStream<Buffer>（例如 AsyncFile 便是一个 ReadStream<Buffer>）：

  1. client
  2.   .post(8080, "myserver.mycompany.com", "/some-uri")
  3.   .sendStream(stream, resp -> {});

Web Client会为您设置好传输泵以平滑传输流。如果流长度未知则使用分块传输（chunked transfer）。

如已知流的大小，可在HTTP协议头中设置 content-length 属性

  1. fs.open("content.txt", new OpenOptions(), fileRes -> {
  2.   if (fileRes.succeeded()) {
  3.     ReadStream<Buffer> fileStream = fileRes.result();
  5.     String fileLen = "1024";
  7.     // 用POST方法发送文件
  8.     client
  9.       .post(8080, "myserver.mycompany.com", "/some-uri")
  10.       .putHeader("content-length", fileLen)
  11.       .sendStream(fileStream, ar -> {
  12.         if (ar.succeeded()) {
  13.           // Ok
  14.         }
  15.       });
  16.   }
  17. });

此时POST方法不会使用分块传输。

JSON体

有时您需要在请求体中使用JSON格式，可使用 sendJsonObject 方法发送 JsonObject：

  1. client
  2.   .post(8080, "myserver.mycompany.com", "/some-uri")
  3.   .sendJsonObject(new JsonObject()
  4.     .put("firstName", "Dale")
  5.     .put("lastName", "Cooper"), ar -> {
  6.     if (ar.succeeded()) {
  7.       // Ok
  8.     }
  9.   });

在Java，Groovy以及Kotlin语言中，您亦可使用 sendJson 方法发送POJO（Plain Old Java Object），该方法会自动调用 Json.encode 方法将 POJO 映射为 JSON：

  1. client
  2.   .post(8080, "myserver.mycompany.com", "/some-uri")
  3.   .sendJson(new User("Dale", "Cooper"), ar -> {
  4.     if (ar.succeeded()) {
  5.       // Ok
  6.     }
  7.   });

请注意： Json.encode 方法使用Jackson的 mapper将 POJO 映射成 JSON。

表单提交

您可使用 sendForm 方法发送HTTP表单。

  1. MultiMap form = MultiMap.caseInsensitiveMultiMap();
  2. form.set("firstName", "Dale");
  3. form.set("lastName", "Cooper");
  5. // 用URL编码方式提交表单
  6. client
  7.   .post(8080, "myserver.mycompany.com", "/some-uri")
  8.   .sendForm(form, ar -> {
  9.     if (ar.succeeded()) {
  10.       // Ok
  11.     }
  12.   });

缺省情况下，提交表单的请求头中的 content-type 属性值为 application/x-www-form-urlencoded，您亦可将其设置为 multipart/form-data：

  1. MultiMap form = MultiMap.caseInsensitiveMultiMap();
  2. form.set("firstName", "Dale");
  3. form.set("lastName", "Cooper");
  5. // 用分块方式编码提交表单
  6. client
  7.   .post(8080, "myserver.mycompany.com", "/some-uri")
  8.   .putHeader("content-type", "multipart/form-data")
  9.   .sendForm(form, ar -> {
  10.     if (ar.succeeded()) {
  11.       // Ok
  12.     }
  13.   });

请注意：当前版本并不支持分块文件编码（multipart files，即文件上传），该功能可能在将来版本中予以支持。

填充请求头

您可使用以下方式填充请求头：

  1. HttpRequest<Buffer> request = client.get(8080, "myserver.mycompany.com", "/some-uri");
  2. MultiMap headers = request.headers();
  3. headers.set("content-type", "application/json");
  4. headers.set("other-header", "foo");

此处 Headers 是一个 MultiMap 对象，提供了增加、设置以及删除头属性操作的入口。HTTP头的某些特定属性允许设置多个值。

您亦可通过 putHeader 方法写入头属性：

  1. HttpRequest<Buffer> request = client.get(8080, "myserver.mycompany.com", "/some-uri");
  2. request.putHeader("content-type", "application/json");
  3. request.putHeader("other-header", "foo");

重用请求

send 方法可被重复多次调用，这使得配置以及重用 HttpRequest 对象变得更加便捷：

  1. HttpRequest<Buffer> get = client.get(8080, "myserver.mycompany.com", "/some-uri");
  2. get.send(ar -> {
  3.   if (ar.succeeded()) {
  4.     // Ok
  5.   }
  6. });
  8. // 再次发送同样的请求
  9. get.send(ar -> {
  10.   if (ar.succeeded()) {
  11.     // Ok
  12.   }
  13. });

请注意，HttpRequest 对象是可变的。 所以在修改缓存中的对象之前，您应当使用 copy 方法先复制一份拷贝：

  1. HttpRequest<Buffer> get = client.get(8080, "myserver.mycompany.com", "/some-uri");
  2. get.send(ar -> {
  3.   if (ar.succeeded()) {
  4.     // Ok
  5.   }
  6. });
  8. // 获取同样的请求
  9. get.copy()
  10.   .putHeader("an-header", "with-some-value")
  11.   .send(ar -> {
  12.   if (ar.succeeded()) {
  13.     // Ok
  14.   }

超时

您可通过 timeout 方法设置超时时间。

  1. client
  2.   .get(8080, "myserver.mycompany.com", "/some-uri")
  3.   .timeout(5000)
  4.   .send(ar -> {
  5.     if (ar.succeeded()) {
  6.       // Ok
  7.     } else {
  8.       // 此处可填入超时处理部分代码
  9.     }
  10.   });

若请求在设定时间内没返回任何数据，则一个超时异常将会传递给响应处理代码。

处理HTTP响应

Web Client请求发送之后，返回的结果将会被包装在异步结果 HttpResponse 中。

当响应被成功接收到之后，相应的回调函数将会被触发。

  1. client
  2.   .get(8080, "myserver.mycompany.com", "/some-uri")
  3.   .send(ar -> {
  4.     if (ar.succeeded()) {
  6.       HttpResponse<Buffer> response = ar.result();
  8.       System.out.println("Received response with status code" + response.statusCode());
  9.     } else {
  10.       System.out.println("Something went wrong " + ar.cause().getMessage());
  11.     }
  12.   });

警告：缺省状况下，响应会被完全缓冲读入内存，请用 BodyCodec.pipe 方法将响应写入流。

响应编解码器

缺省状况下，响应以缓冲形式提供，并不提供任何形式的解码。

可用 BodyCodec 将响应定制成以下类型：

  • 普通字符串
  • JSON对象
  • 将JSON映射成POJO
  • WriteStream

响应体编解码器对二进制数据流解码，以节省您在响应处理中的代码。

使用 BodyCodec.jsonObject 将结果解码为JSON对象：

  1. client
  2.   .get(8080, "myserver.mycompany.com", "/some-uri")
  3.   .as(BodyCodec.jsonObject())
  4.   .send(ar -> {
  5.     if (ar.succeeded()) {
  6.       HttpResponse<JsonObject> response = ar.result();
  8.       JsonObject body = response.body();
  10.       System.out.println("Received response with status code" + response.statusCode() + " with body " + body);
  11.     } else {
  12.       System.out.println("Something went wrong " + ar.cause().getMessage());
  13.     }
  14.   });

在Java，Groovy以及Kotlin语言中，JSON对象可被解码映射成POJO：

  1. client
  2.   .get(8080, "myserver.mycompany.com", "/some-uri")
  3.   .as(BodyCodec.json(User.class))
  4.   .send(ar -> {
  5.     if (ar.succeeded()) {
  6.       HttpResponse<User> response = ar.result();
  8.       User user = response.body();
  10.       System.out.println("Received response with status code" + response.statusCode() + " with body " +
  11.         user.getFirstName() + " " + user.getLastName());
  12.     } else {
  13.       System.out.println("Something went wrong " + ar.cause().getMessage());
  14.     }
  15.   });

当响应结果较大时，请使用 BodyCodec.pipe 方法。响应体编解码器将响应结果压入 WriteStream 并在最后发出成功或失败的信号。

  1. client
  2.   .get(8080, "myserver.mycompany.com", "/some-uri")
  3.   .as(BodyCodec.pipe(writeStream))
  4.   .send(ar -> {
  5.     if (ar.succeeded()) {
  7.       HttpResponse<Void> response = ar.result();
  9.       System.out.println("Received response with status code" + response.statusCode());
  10.     } else {
  11.       System.out.println("Something went wrong " + ar.cause().getMessage());
  12.     }
  13.   });

最后，如您对响应结果不感兴趣，可用 BodyCodec.none 废弃响应体。

  1. client
  2.   .get(8080, "myserver.mycompany.com", "/some-uri")
  3.   .as(BodyCodec.none())
  4.   .send(ar -> {
  5.     if (ar.succeeded()) {
  7.       HttpResponse<Void> response = ar.result();
  9.       System.out.println("Received response with status code" + response.statusCode());
  10.     } else {
  11.       System.out.println("Something went wrong " + ar.cause().getMessage());
  12.     }
  13.   });

若无法预知响应内容类型，您依旧可以在获取结果之后，用 bodyAsXXX() 方法将其转换成特定的类型

  1. client
  2.   .get(8080, "myserver.mycompany.com", "/some-uri")
  3.   .send(ar -> {
  4.     if (ar.succeeded()) {
  6.       HttpResponse<Buffer> response = ar.result();
  8.       // 将结果解码为Json对象
  9.       JsonObject body = response.bodyAsJsonObject();
  11.       System.out.println("Received response with status code" + response.statusCode() + " with body " + body);
  12.     } else {
  13.       System.out.println("Something went wrong " + ar.cause().getMessage());
  14.     }
  15.   });

警告：这种方式仅对响应结果为缓冲体有效。

处理30x重定向

缺省状况下，客户端将会依照30x状态码自动重定向，您可使用 WebClientOptions 予以配置：

  1. WebClient client = WebClient.create(vertx, new WebClientOptions().setFollowRedirects(false));

客户端将会执行最多达16次重定向，该参数亦可在 WebClientOptions 配置：

  1. WebClient client = WebClient.create(vertx, new WebClientOptions().setMaxRedirects(5));

使用HTTPS

Vert.x Web Client可用与 HttpClient 相同方式配置HTTPS协议。

您可对每个请求单独设置：

  1. client
  2.   .get(443, "myserver.mycompany.com", "/some-uri")
  3.   .ssl(true)
  4.   .send(ar -> {
  5.     if (ar.succeeded()) {
  6.       // 获取响应
  7.       HttpResponse<Buffer> response = ar.result();
  9.       System.out.println("Received response with status code" + response.statusCode());
  10.     } else {
  11.       System.out.println("Something went wrong " + ar.cause().getMessage());
  12.     }
  13.   });

或使用绝对路径：

  1. client
  2.   .getAbs("https://myserver.mycompany.com:4043/some-uri")
  3.   .send(ar -> {
  4.     if (ar.succeeded()) {
  5.       // 获取响应
  6.       HttpResponse<Buffer> response = ar.result();
  8.       System.out.println("Received response with status code" + response.statusCode());
  9.     } else {
  10.       System.out.println("Something went wrong " + ar.cause().getMessage());
  11.     }
  12.   });

RxJava API

RxJava的 HttpRequest 提供了原版API的响应式版本，rxSend 方法返回一个可被订阅的 Single<HttpResponse<Buffer>>，故单个 Single 可被多次订阅。

  1. Single<HttpResponse<Buffer>> single = client
  2.   .get(8080, "myserver.mycompany.com", "/some-uri")
  3.   .rxSend();
  5. // 发送一次请求，并处理其响应，rx通常通过订阅触发各种响应
  6. single.subscribe(response -> {
  7.   System.out.println("Received 1st response with status code" + response.statusCode());
  8. }, error -> {
  9.   System.out.println("Something went wrong " + error.getMessage());
  10. });
  12. // 再次发送请求
  13. single.subscribe(response -> {
  14.   System.out.println("Received 2nd response with status code" + response.statusCode());
  15. }, error -> {
  16.   System.out.println("Something went wrong " + error.getMessage());
  17. });

获取到的 Single 可与其它RxJava API自然组合成链式处理

  1. Single<String> url = client
  2.   .get(8080, "myserver.mycompany.com", "/some-uri")
  3.   .rxSend()
  4.   .map(HttpResponse::bodyAsString);
  6. // 用flatMap将返回值内的链接作为参数传入lambda，在lambda中将其设置成发送请求，并返回Single，在下一步订阅中予以触发
  7. url
  8.   .flatMap(u -> client.getAbs(u).rxSend())
  9.   .subscribe(response -> {
  10.     System.out.println("Received response with status code" + response.statusCode());
  11.   }, error -> {
  12.     System.out.println("Something went wrong " + error.getMessage());
  13.   });

之前的例子可写成

  1. Single<HttpResponse<JsonObject>> single = client
  2.   .get(8080, "myserver.mycompany.com", "/some-uri")
  3.   .putHeader("some-header", "header-value")
  4.   .addQueryParam("some-param", "param value")
  5.   .as(BodyCodec.jsonObject())
  6.   .rxSend();
  7. single.subscribe(resp -> {
  8.   System.out.println(resp.statusCode());
  9.   System.out.println(resp.body());
  10. });

当发送请求体为 Observable<Buffer> 时，应使用 sendStream：

  1. Observable<Buffer> body = getPayload();
  3. Single<HttpResponse<Buffer>> single = client
  4.   .post(8080, "myserver.mycompany.com", "/some-uri")
  5.   .rxSendStream(body);
  6. single.subscribe(resp -> {
  7.   System.out.println(resp.statusCode());
  8.   System.out.println(resp.body());
  9. });

当订阅时，body 将会被订阅，其内容将会被用于请求中。

原文上次编辑于2017-03-15 15:54:14 欧洲中部时间