发布于 由admin

WordPress wp_remote_request函数如何在流式HTTP传输中处理异常超时

WordPress wp_remote_request 函数与流式HTTP传输中的超时处理

大家好，今天我们来深入探讨 WordPress 中 wp_remote_request 函数在处理流式 HTTP 传输时，如何应对各种超时场景。wp_remote_request 是 WordPress 提供的一个强大的 HTTP 请求工具，它不仅可以发送简单的请求，还能处理更复杂的场景，比如流式传输。而流式传输，顾名思义，数据不是一次性全部接收，而是像水流一样，一点一点地传输过来。这种方式特别适合处理大型文件或者实时数据，但也引入了新的超时风险，我们需要仔细研究。

一、wp_remote_request 函数基础回顾

首先，让我们快速回顾一下 wp_remote_request 函数的基本用法。它的基本语法如下：

$response = wp_remote_request( $url, $args = array() );
  • $url: 目标 URL，即你要请求的地址。
  • $args: 一个数组，包含了各种请求参数，比如请求方法（GET, POST 等）、头部信息、body 数据、超时设置等等。

$args 参数是关键，它允许我们配置请求的各种行为。常用的参数包括：

| 参数 | 描述 |
|——————|—————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————-0
| method | 请求方法，如 'GET', 'POST', 'PUT', 'DELETE' 等。默认为 'GET'。

1. 基本超时 (Connection Timeout)

最基本的超时类型是连接超时。当你的代码尝试连接到服务器，但服务器在指定时间内没有响应，就会触发连接超时。在 wp_remote_request 中，你可以使用 timeout 参数来设置连接超时时间，单位是秒。

$url = 'https://example.com/api/slow-endpoint';
$args = array(
    'timeout' => 5, // 设置超时时间为 5 秒
);

$response = wp_remote_request( $url, $args );

if ( is_wp_error( $response ) ) {
    $error_message = $response->get_error_message();
    echo "Something went wrong: $error_message";
} else {
    echo "Response: " . wp_remote_retrieve_body( $response );
}

这段代码尝试连接到 https://example.com/api/slow-endpoint，如果 5 秒内没有建立连接，wp_remote_request 将返回一个 WP_Error 对象，你可以通过 is_wp_error() 函数来检查是否发生了错误，并使用 $response->get_error_message() 获取错误信息。

2. 读取超时 (Read Timeout)

除了连接超时，还有读取超时。这意味着连接已经建立，但是服务器在指定的时间内没有发送任何数据。在流式传输中，读取超时尤为重要，因为服务器可能需要一段时间才能生成并发送数据块。不幸的是，wp_remote_request 本身并没有直接提供读取超时的选项。timeout 参数同时控制连接和总的请求时间，而不是单独的读取超时。

二、流式HTTP传输与超时问题

流式 HTTP 传输，也被称为分块传输编码 (Chunked Transfer Encoding)，允许服务器将数据分成多个块 (chunks) 发送，而无需提前知道内容的长度。这对于动态生成内容或传输大型文件非常有用。

在 WordPress 中实现流式传输，通常需要用到 stream 参数，并结合 fopen 和 fwrite 等函数来处理数据流。stream 参数指示 wp_remote_request 返回一个资源句柄，而不是直接返回响应内容。

$url = 'https://example.com/api/large-file';
$args = array(
    'stream'   => true,
    'filename' => '/tmp/large-file.dat', // 保存文件的路径
    'timeout'  => 60, // 总超时时间 60 秒
);

$response = wp_remote_request( $url, $args );

if ( is_wp_error( $response ) ) {
    $error_message = $response->get_error_message();
    echo "Something went wrong: $error_message";
} else {
    echo "File downloaded successfully!";
}

这段代码会将 https://example.com/api/large-file 下载到 /tmp/large-file.dat。但是，这里仍然没有解决读取超时的问题。timeout 参数仅仅是总超时，如果连接很快建立，但服务器发送数据非常慢，超过了总超时时间，请求就会失败。

三、模拟读取超时：自定义解决方案

由于 wp_remote_request 缺乏直接的读取超时支持，我们需要自定义解决方案。一种常见的方法是使用 stream_get_meta_data 函数来监控数据流的状态，并手动设置超时。

$url = 'https://example.com/api/streaming-data';
$read_timeout = 10; // 读取超时时间，单位秒
$total_timeout = 60; // 总超时时间，单位秒
$start_time = time();

$args = array(
    'stream' => true,
    'timeout' => $total_timeout,
);

$response = wp_remote_request( $url, $args );

if ( is_wp_error( $response ) ) {
    $error_message = $response->get_error_message();
    echo "Something went wrong: $error_message";
    exit;
}

$stream = @fopen( wp_remote_retrieve_header( $response, 'location' ) ? wp_remote_retrieve_header( $response, 'location' ) : $url, 'r' );

if ( ! $stream ) {
    echo "Failed to open stream!";
    exit;
}

$content = '';
while ( ! feof( $stream ) ) {
    $data = fread( $stream, 8192 ); // 每次读取 8KB
    if ( $data === false ) {
        echo "Error reading stream!";
        break;
    }

    $content .= $data;

    $info = stream_get_meta_data( $stream );
    if ( $info['timed_out'] ) {
        echo "Read timeout!";
        break;
    }

    // 检查是否超过总超时时间
    if ( ( time() - $start_time ) > $total_timeout ) {
        echo "Total timeout!";
        break;
    }

    // 模拟读取超时
    $last_read_time = time();
    while ( ( time() - $last_read_time ) < $read_timeout ) {
        // 模拟等待，避免 CPU 占用过高
        usleep(100000); // 等待 100 毫秒
        $info = stream_get_meta_data( $stream );
        if($info['unread_bytes'] > 0){
            break;
        }

        if ( ( time() - $start_time ) > $total_timeout ) {
            echo "Total timeout!";
            break 2;
        }
    }
    if((time() - $last_read_time) >= $read_timeout && $info['unread_bytes'] == 0){
        echo "Read timeout!";
        break;
    }

}

fclose( $stream );

echo "Received data: " . strlen( $content ) . " bytes";

这段代码做了以下几件事：

  1. 设置超时时间： $read_timeout 定义了读取超时的秒数，$total_timeout 定义了总超时时间。
  2. 打开数据流： 使用 fopen 打开 wp_remote_request 返回的资源句柄。
  3. 循环读取数据： 使用 fread 循环读取数据块。
  4. 监控数据流状态： 使用 stream_get_meta_data 获取数据流的元数据，特别是 timed_out 属性，它可以告诉你是否发生了读取超时。
  5. 模拟读取超时： 如果 stream_get_meta_data 没有及时提供读取超时信息，我们可以手动模拟。在每次读取数据后，记录当前时间，然后在一段时间内（$read_timeout），不断检查是否有新的数据到达。如果没有，则认为发生了读取超时。
  6. 检查总超时： 在循环中，始终检查是否超过了总超时时间，以避免无限等待。

四、更高级的超时处理：使用 curl 扩展

如果你的服务器安装了 curl 扩展，你可以利用它来更精细地控制超时。curl 提供了 CURLOPT_CONNECTTIMEOUT 和 CURLOPT_TIMEOUT 选项，分别用于设置连接超时和总超时。此外，CURLOPT_LOW_SPEED_TIME 和 CURLOPT_LOW_SPEED_LIMIT 选项可以用来模拟读取超时。

$url = 'https://example.com/api/streaming-data';
$connect_timeout = 5;  // 连接超时，单位秒
$total_timeout = 60; // 总超时，单位秒
$low_speed_time = 10;  // 低速超时时间，单位秒
$low_speed_limit = 10; // 最低速度，单位字节/秒

$ch = curl_init( $url );

curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true ); // 返回数据，而不是直接输出
curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT, $connect_timeout ); // 设置连接超时
curl_setopt( $ch, CURLOPT_TIMEOUT, $total_timeout ); // 设置总超时
curl_setopt( $ch, CURLOPT_LOW_SPEED_TIME, $low_speed_time ); // 设置低速超时时间
curl_setopt( $ch, CURLOPT_LOW_SPEED_LIMIT, $low_speed_limit ); // 设置最低速度
curl_setopt( $ch, CURLOPT_HEADER, 0); //设置不输出header信息
curl_setopt( $ch, CURLOPT_BUFFERSIZE, 8192);

$response = curl_exec( $ch );

if ( curl_errno( $ch ) ) {
    $error_message = curl_error( $ch );
    echo "cURL error: $error_message";
} else {
    echo "Response: $response";
}

curl_close( $ch );

这段代码使用了 curl 扩展来发送 HTTP 请求，并设置了连接超时、总超时和低速超时。CURLOPT_LOW_SPEED_TIME 和 CURLOPT_LOW_SPEED_LIMIT 的组合意味着，如果在 $low_speed_time 秒内，传输速度低于 $low_speed_limit 字节/秒，curl 将认为发生了读取超时。

五、处理大型文件下载的超时问题

在下载大型文件时，超时问题尤为突出。除了上述的连接超时和读取超时，还需要考虑服务器的负载和网络状况。以下是一些处理大型文件下载超时的建议：

  1. 增加超时时间： 根据文件大小和网络状况，适当增加总超时时间。
  2. 使用分块下载： 将大型文件分成多个小块下载，可以降低单次请求的超时风险。你可以使用 HTTP 的 Range 头部来实现分块下载。
  3. 断点续传： 如果下载中断，可以从上次中断的位置继续下载，避免重新下载整个文件。同样，可以使用 Range 头部来实现断点续传。
  4. 使用专门的下载库： 有一些专门用于下载文件的 PHP 库，它们提供了更强大的超时控制和错误处理功能。
  5. 考虑服务器端支持： 确保你的服务器支持大文件下载，并且配置了合适的超时设置。

以下是一个使用 Range 头部实现分块下载的示例：


$url = 'https://example.com/api/large-file.zip';
$file_path = '/tmp/large-file.zip';
$chunk_size = 1024 * 1024; // 1MB
$start = 0;

$file = fopen( $file_path, 'wb' );

if ( ! $file ) {
    echo "Failed to open file for writing!";
    exit;
}

while ( true ) {
    $end = $start + $chunk_size - 1;

    $args = array(
        'headers' => array(
            'Range' => 'bytes=' . $start . '-' . $end,
        ),
        'stream'  => true,
        'timeout' => 30,
    );

    $response = wp_remote_request( $url, $args );

    if ( is_wp_error( $response ) ) {
        $error_message = $response->get_error_message();
        echo "Something went wrong: $error_message";
        break;
    }

    $body = wp_remote_retrieve_body( $response );

    if ( empty( $body ) ) {
        // 下载完成或发生错误
        break;
    }

    fwrite( $file, $body );

    $start = $end + 1;

    // 检查是否下载完成
    $content_length = wp_remote_retrieve_header( $response, 'content-length' );
    if ( empty( $content_length ) || intval( $content_length ) < $chunk_size )

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注