Java 11引入了一个新的包java.net.http
,用于发出HTTP请求。对于一般用途,它非常简单。
我的问题是:当客户端收到每个块时,如何使用java.net.http
处理分块响应?
java.http.net
包含一个看起来像我想要的反应性BodySubscriber
,但我找不到它如何使用的例子。
下面是一个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)
为了完整起见,这是一个使用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());
}
}
这是制作非阻塞/异步请求的示例:
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 chunk。它只是向应用程序提供少量数据,从而减少了应用程序级别消耗的内存量(可以在堆栈中缓冲得更低)。 Java 11 HTTP客户端支持通过其中一个流体处理程序HttpResponse.BodyHandlers
:ofInputStream
,ofByteArrayConsumer
,asLines
等进行流式传输。
或者编写自己的处理程序/订阅者,如下所示:https://www.youtube.com/watch?v=qiaC0QMLz5Y
您可以打印ByteBuffer
s,但不能保证ByteBuffer
对应一个块。块由堆栈处理。将为每个块推送一个ByteBuffer
切片 - 但如果缓冲区中没有足够的空间,则将推送部分块。所有消费者看到的是包含数据的ByteBuffer
s流。所以你可以做的就是打印那些ByteBuffer
s,但你无法保证它们与服务器发送的每个块完全一致。
注意:如果您的请求正文是基于文本的,那么您可以将BodyHandlers.fromLineSubscriber(Subscriber<? super String> subscriber)
与自定义Subscriber<String>
一起使用,它将打印每一行。 BodyHandlers.fromLineSubscriber
使用响应头中指示的字符串将字节解码为字符,如果需要则缓冲字节直到它们可以被解码(如果文本包含在多个字节上编码的字符,则ByteBuffer可能在编码序列的中间结束) ),并将它们分割在线边界处。对于文本中的每一行,将调用Subscriber :: 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方法,它基本上返回一个最终会产生HTTP请求主体的java CompletableFuture。一旦掌握了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 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
运行CustomSubscriber.java代码