当块到达时,如何使用java.net.http读取和打印分块的HTTP响应?



Java 11引入了一个新的包,java.net.http,用于发出HTTP请求。对于一般用途,它非常简单。

我的问题是:当客户端收到每个块时,如何使用java.net.http来处理分块响应?

java.http.net包含一个反应式BodySubscriber这似乎是我想要的,但我找不到如何使用它的示例。

http_get_demo.py

下面是一个python实现,它在块到达时打印它们,我想用java.net.http做同样的事情:

import argparse
import requests

def main(url: str):
with requests.get(url, stream=True) as r:
for c in r.iter_content(chunk_size=1):
print(c.decode("UTF-8"), end="")

if __name__ == "__main__":
parser = argparse.ArgumentParser(
description="Read from a URL and print as text as chunks arrive")
parser.add_argument('url', type=str, help="A URL to read from")
args = parser.parse_args()
main(args.url)

HttpGetDemo.java

为了完整起见,这里有一个使用 java.net.http 发出阻塞请求的简单示例:

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpResponse;
import java.net.http.HttpRequest;
public class HttpGetDemo {
public static void main(String[] args) throws Exception {
var request = HttpRequest.newBuilder()
.uri(URI.create(args[0]))
.build();
var bodyHandler = HttpResponse.BodyHandlers
.ofString();
var client = HttpClient.newHttpClient();
var response = client.send(request, bodyHandler);
System.out.println(response.body());
}
}

HttpAsyncGetDemo.java

下面是发出非阻塞/异步请求的示例:

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpResponse;
import java.net.http.HttpRequest;
/**
* ReadChunked
*/
public class HttpAsyncGetDemo {
public static void main(String[] args) throws Exception {
var request = HttpRequest.newBuilder()
.uri(URI.create(args[0]))
.build();
var bodyHandler = HttpResponse.BodyHandlers
.ofString();
var client = HttpClient.newHttpClient();
client.sendAsync(request, bodyHandler)
.thenApply(HttpResponse::body)
.thenAccept(System.out::println)
.join();
}
}

python 代码不能确保响应正文数据一次提供一个 HTTP 块。它只是向应用程序提供少量数据,从而减少了应用程序级别消耗的内存量(它可以在堆栈中缓冲较低(。Java 11 HTTP 客户端支持通过一个流体处理程序进行流化,HttpResponse.BodyHandlersofInputStreamofByteArrayConsumerofLines等。

或者编写您自己的处理程序/订阅者,如下所示: https://www.youtube.com/watch?v=qiaC0QMLz5Y

您可以在ByteBuffer打印时打印它们,但不能保证ByteBuffer对应于块。块由堆栈处理。将为每个块推送一个ByteBuffer片 - 但如果缓冲区中没有足够的剩余空间,则将推送部分块。使用者看到的只是包含数据的ByteBuffer流。 因此,您可以做的是在它们出现时打印这些ByteBuffer,但您不能保证它们与服务器发送的每个块正好对应一个块。

注意:如果您的请求正文是基于文本的,则可以使用BodyHandlers.fromLineSubscriber(Subscriber<? super String> subscriber)带有自定义Subscriber<String>,该将打印每一行。BodyHandlers.fromLineSubscriber使用响应标头中指示的字符集将字节解码为字符,根据需要缓冲字节,直到可以解码(如果文本包含跨多个字节编码的字符,则 ByteBuffer 可能会在编码序列的中间结束(,并在行边界处拆分它们。将为文本中的每一行调用一次订阅者::onNext 方法。有关更多信息,请参阅 https://download.java.net/java/early_access/jdk11/docs/api/java.net.http/java/net/http/HttpResponse.BodyHandlers.html#fromLineSubscriber(java.util.concurrent.Flow.Subscriber(。

感谢@pavel和@chegar999的部分回答。他们引导我找到了解决方案。

概述

我想出的解决方案如下。基本上,解决方案是使用 自定义java.net.http.HttpResponse.BodySubscriber.BodySubscriber 包含反应式方法(onSubscribe、onNext、onError 和 onComplete(和一个 getBody 方法,该方法基本上返回一个 java CompletableFuture,最终将生成 HTTP 请求的正文。一旦你有了你的BodySubscriber,你可以像这样使用它:

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(uri))
.build();
return client.sendAsync(request, responseInfo -> new StringSubscriber())
.whenComplete((r, t) -> System.out.println("--- Status code " + r.statusCode()))
.thenApply(HttpResponse::body);

请注意以下行:

client.sendAsync(request, responseInfo -> new StringSubscriber())

这就是我们注册自定义 BodySubscriber 的地方;在本例中,我的自定义类名为StringSubscriber

自定义订阅者.java

这是一个完整的工作示例。使用 Java 11,您可以在不编译的情况下运行它。只需将其粘贴到名为CustomSubscriber.java的文件中,然后运行命令java CustomSubscriber <some url>。它会在到达时打印每个块的内容。它还收集它们,并在响应完成后将它们作为正文返回。

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.net.http.HttpResponse.BodySubscriber;
import java.net.URI;
import java.nio.ByteBuffer;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CompletionStage;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.concurrent.Flow;
import java.util.stream.Collectors;
import java.util.List;
public class CustomSubscriber {
public static void main(String[] args) {
CustomSubscriber cs = new CustomSubscriber();
String body = cs.get(args[0]).join();
System.out.println("--- Response body:n: ..." + body + "...");
}
public CompletableFuture<String> get(String uri) {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(uri))
.build();
return client.sendAsync(request, responseInfo -> new StringSubscriber())
.whenComplete((r, t) -> System.out.println("--- Status code " + r.statusCode()))
.thenApply(HttpResponse::body);
}
static class StringSubscriber implements BodySubscriber<String> {
final CompletableFuture<String> bodyCF = new CompletableFuture<>();
Flow.Subscription subscription;
List<ByteBuffer> responseData = new CopyOnWriteArrayList<>();
@Override
public CompletionStage<String> getBody() {
return bodyCF;
}
@Override
public void onSubscribe(Flow.Subscription subscription) {
this.subscription = subscription;
subscription.request(1); // Request first item
}
@Override
public void onNext(List<ByteBuffer> buffers) {
System.out.println("-- onNext " + buffers);
try {
System.out.println("tBuffer Content:n" + asString(buffers));
} 
catch (Exception e) {
System.out.println("tUnable to print buffer content");
}
buffers.forEach(ByteBuffer::rewind); // Rewind after reading
responseData.addAll(buffers);
subscription.request(1); // Request next item
}
@Override
public void onError(Throwable throwable) {
bodyCF.completeExceptionally(throwable);
}
@Override
public void onComplete() {
bodyCF.complete(asString(responseData));
}
private String asString(List<ByteBuffer> buffers) {
return new String(toBytes(buffers), StandardCharsets.UTF_8);
}
private byte[] toBytes(List<ByteBuffer> buffers) {
int size = buffers.stream()
.mapToInt(ByteBuffer::remaining)
.sum();
byte[] bs = new byte[size];
int offset = 0;
for (ByteBuffer buffer : buffers) {
int remaining = buffer.remaining();
buffer.get(bs, offset, remaining);
offset += remaining;
}
return bs;
}
}
}

尝试一下

若要测试此解决方案,您需要一个服务器来发送使用Transfer-encoding: chunked的响应,并且发送速度足够慢,以便观察块到达。我已经在 https://github.com/hohonuuli/demo-chunk-server 创建了一个,但您可以使用 Docker 像这样启动它:

docker run -p 8080:8080 hohonuuli/demo-chunk-server

然后使用java CustomSubscriber.java http://localhost:8080/chunk/10运行自定义订阅者.java代码

现在有一个新的Java库来满足这种需求 RxSON:https://github.com/rxson/rxson 它利用 JsonPath 机智的 RxJava 在 JSON 流块到达时立即从响应中读取它们,并将它们解析为 java 对象。

例:

String serviceURL = "https://think.cs.vt.edu/corgis/datasets/json/airlines/airlines.json";
HttpRequest req = HttpRequest.newBuilder(URI.create(serviceURL)).GET().build();
RxSON rxson = new RxSON.Builder().build();
String jsonPath = "$[*].Airport.Name";
Flowable<String> airportStream = rxson.create(String.class, req, jsonPath);
airportStream
.doOnNext(it -> System.out.println("Received new item: " + it))
//Just for test
.toList()
.blockingGet();

这是一个基于 chegar999 答案的简单解决方案:

httpClient.send(httpRequest, HttpResponse.BodyHandlers.ofByteArrayConsumer((final Optional<byte[]> receivedBytesOptional) -> {
if (receivedBytesOptional.isEmpty()) {
System.out.println("Done");
} else {
final byte[] receivedBytes = receivedBytesOptional.get();
final String received = new String(receivedBytes, StandardCharsets.UTF_8);
System.out.println("Received: " + received);
}
}));

只要您的多字节字符不分为两个块,它就可以工作(否则,使用java.nio.charset.CharsetDecoder#decode()(。

以我的拙见,它比使用自定义订阅者更容易且更不容易出错,这更适合需要更大灵活性的情况。

相关内容

最新更新