如果没有数据传输，PHP 流超时

Question

我目前正在实现一个 PHP 类，它可以获取图像文件并将它们缓存在本地。这些图像可能来自其他本地源，通过 HTTP 或使用 Guzzle 客户端的 HTTP。使用 PHP 流包装器，我应该能够以相同的方式处理所有源。

我现在要做的是在没有数据通过流传输时实现超时。这应该处理以下情况:

1. 首先无法建立流。这可能应该在 fopen 调用时处理，而不是超时。
2. 流已建立但没有数据传输。
3. 流已建立，数据已传输，但在传输过程中停止了一段时间。

我想我可以用 stream_set_timeout 来做这一切但我不太清楚这到底是做什么的。如果流上的任何操作花费的时间超过允许的时间，超时是否适用，即我可以做一些需要 0.5 秒两次且超时为 0.75 秒的事情？还是仅当没有数据通过流传输的时间超过允许的时间时才适用？

我试图用这个简短的脚本测试行为:

<?php

$in = fopen('https://reqres.in/api/users?delay=5', 'r');
$out = fopen('out', 'w');

stream_set_timeout($in, 1);
stream_copy_to_stream($in, $out);

var_dump(stream_get_meta_data($in)['timed_out']);

尽管 reqres.in 的响应延迟了 5 秒，但我总是得到 false，超时时间为 1 秒。请问有人可以解释一下吗？

Answer 1

我建议您使用 file_get_contents 和 file_put_contents 而不是流，它们支持所有包装器，您可以将上下文传递给它们，就像传递给 fopen。它们通常更易于使用，因为它们返回并接受字符串而不是流。话虽这么说，我不知道您的缓存机制的性质，如果流更适合您的用例，那么您的功能会更强大:)

问题

这里的问题似乎是对 fopen 如何与 http 流包装器一起工作的误解(在我尝试之前我也没有完全理解)阻塞模式。对于 GET(the default)，fopen 似乎在调用时执行 HTTP 请求，不在读取流时执行。这可以解释为什么 stream_set_timeout 没有按预期运行，因为它会在调用 fopen 之后修改流上下文。

解决方案

值得庆幸的是，有一种方法可以在调用 fopen 之前修改超时；您可以使用上下文调用 fopen。将 stream_context_create 返回的上下文(如 Sammitch 链接)传递给 fopen 超时对于您的所有三种情况都是正确的。作为引用，这是您的脚本的修改方式:

<?php

$ctx = stream_context_create(['http' => [
        'timeout' => 1.0,
]]);

$in = fopen('https://reqres.in/api/users?delay=5', 'r', false, $ctx);
$out = STDOUT;

stream_copy_to_stream($in, $out);
var_dump(stream_get_meta_data($in)['timed_out']);
fclose($in);

注意:我假设您打算将流复制到 stdout 而不是“out”，这在我的平台 (Darwin) 上不是有效流。我还在脚本末尾关闭了输入流，这始终是一个好习惯。

这将创建一个超时为 1 的流，从调用 fopen 时开始。现在来测试你的三个条件。

验证行为

1. The stream cannot be established in the first place. This should probably be handled at the fopen call and not with a timeout.

这按原样正常工作——如果无法建立连接(服务器离线等)，fopen 调用会立即触发警告。只需将脚本指向本地主机上没有任何监听的任意端口。 请注意，如果连接未成功建立，fopen 将返回 false。您必须在代码中检查这一点，以避免将 false 用作流。

2. The stream is established but no data is transferred.

这种情况也适用，只需使用您的普通 URL 运行脚本即可。这也会使 fopen 返回 false 并触发警告(不同的警告)。

3. The stream is established, data is transferred but it stops some time during transfer.

这是一个有趣的案例。要对此进行测试，您可以编写一个脚本来发送 Content-Length 和一些其他 header 以及一些部分数据，然后等到超时，即:

<?php
header('Content-Type: text/plain');
header('Content-Length: 10');
echo "hi";
ob_flush();
sleep(10);

ob_flush 是使 PHP 在 sleep 和脚本退出之前写入输出(不关闭连接)所必需的。您可以使用 php -S localhost:port 提供此服务，然后将另一个脚本指向 localhost:port。在这种情况下，客户端脚本不会抛出警告，fopen 实际上会返回元数据中的 timed_out 设置为 true 的流。

结论

stream_set_timeout 不适用于 HTTP GET 请求和 fopen 阻塞模式 因为 fopen 执行请求时它被调用而不是等待读取来这样做。您可以通过超时将上下文传递给 fopen 来解决此问题。