WordPress中wp_remote_get函数的HTTP请求抽象与流式传输逻辑研究 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

WordPress `wp_remote_get` 函数的 HTTP 请求抽象与流式传输逻辑

大家好！今天我们来深入探讨 WordPress 中 wp_remote_get 函数的实现，以及它如何抽象 HTTP 请求，并处理流式传输。wp_remote_get 是 WordPress HTTP API 的核心函数之一，它简化了开发者从外部资源获取数据的过程，并提供了强大的配置选项和错误处理机制。理解它的内部工作原理，有助于我们更高效地利用它，并解决可能遇到的问题。

1. HTTP API 抽象层：WP_Http 类

wp_remote_get 并非直接进行底层的 socket 操作。它依赖于 WordPress HTTP API 的抽象层，这个抽象层的核心是 WP_Http 类。WP_Http 类负责：

请求构建: 将传入的参数（URL，headers，body 等）转换为标准的 HTTP 请求格式。
传输适配: 根据服务器环境选择合适的传输方式 (cURL, streams, fsockopen)。
响应解析: 解析服务器返回的 HTTP 响应，提取 headers, body, status code 等信息。
错误处理: 封装和处理 HTTP 请求过程中可能出现的错误。

WP_Http 类通过插件化的方式允许开发者注册自定义的传输适配器，从而扩展 WordPress HTTP API 的功能。

2. wp_remote_get 函数的工作流程

wp_remote_get 函数的本质是对 WP_Http::request() 方法的一个简化调用。我们来看一下 wp_remote_get 函数的源码：

function wp_remote_get( $url, $args = array() ) {
    $args['method'] = 'GET';

    return wp_remote_request( $url, $args );
}

可以看到，wp_remote_get 实际上只是预设了 method 参数为 ‘GET’，然后调用了更通用的 wp_remote_request 函数。因此，要理解 wp_remote_get，我们需要深入 wp_remote_request 函数。

wp_remote_request 函数的流程如下：

参数处理: 接收 URL 和参数数组。参数数组可以包含：
- method: HTTP 方法 (GET, POST, PUT, DELETE, HEAD, OPTIONS, TRACE, CONNECT)。
- timeout: 请求超时时间 (秒)。
- redirection: 最大重定向次数。
- httpversion: HTTP 协议版本 (1.0, 1.1)。
- user-agent: User-Agent 字符串。
- reject_unsafe_urls: 是否拒绝不安全的 URL (默认 true)。
- blocking: 是否阻塞请求 (默认 true)。如果设置为 false，则发起异步请求。
- headers: HTTP 请求头。
- body: HTTP 请求体。
- cookies: HTTP cookies。
- filename: 文件名，用于流式传输到文件。
- stream: 是否流式传输，默认 false，如果filename存在时则自动设置为true。
URL 验证: 使用 wp_http_validate_url 函数验证 URL 的安全性。
实例化 WP_Http 类: 创建 WP_Http 类的实例。
调用 WP_Http::request(): 调用 WP_Http 类的 request() 方法，传入 URL 和参数数组。
返回结果: WP_Http::request() 方法返回一个 WP_Error 对象 (如果发生错误) 或一个数组，包含以下键：
- headers: HTTP 响应头 (数组)。
- body: HTTP 响应体 (字符串或资源流)。
- response: 包含 code (HTTP 状态码) 和 message (状态消息) 的数组。
- cookies: HTTP cookies (数组)。
- filename: 如果启用了流式传输，则为保存的文件名。

3. WP_Http::request() 方法的内部实现

WP_Http::request() 方法是整个 HTTP 请求的核心。它负责：

过滤参数: 应用各种过滤器，允许开发者修改请求参数。
选择传输适配器: 根据服务器环境和参数选择合适的传输适配器。WordPress 默认的传输适配器包括：
- WP_Http_Curl: 使用 cURL 扩展。
- WP_Http_Streams: 使用 PHP streams。
- WP_Http_Fsockopen: 使用 fsockopen 函数。

WordPress 会按照这个顺序尝试使用这些适配器，直到找到一个可用的。开发者可以通过 http_api_transports 过滤器修改适配器的优先级。

调用适配器的 request() 方法: 调用选定的适配器的 request() 方法，执行实际的 HTTP 请求。
返回结果: 返回一个 WP_Error 对象 (如果发生错误) 或一个数组，包含 HTTP 响应的各种信息。

4. 流式传输的实现

wp_remote_get 函数支持流式传输，可以将 HTTP 响应直接写入文件，而无需将整个响应加载到内存中。这对于处理大型文件非常有用。

流式传输的实现依赖于以下参数：

filename: 指定要保存的文件名。
stream: 显式指定是否使用流式传输。如果 filename 存在，则自动启用流式传输。

当启用流式传输时，WP_Http::request() 方法会：

打开文件: 使用 fopen 函数以写入模式打开指定的文件。
将响应体写入文件: 适配器的 request() 方法会将 HTTP 响应体逐步写入打开的文件，而不是将其存储在内存中。
关闭文件: 在请求完成后，使用 fclose 函数关闭文件。

不同传输适配器实现流式传输的方式略有不同。例如，WP_Http_Curl 类使用 CURLOPT_FILE 选项将 cURL 的输出直接写入文件。WP_Http_Streams 和 WP_Http_Fsockopen 类则通过循环读取响应数据，并使用 fwrite 函数将其写入文件。

5. 传输适配器：WP_Http_Curl、WP_Http_Streams、WP_Http_Fsockopen

我们来分别看一下这三个传输适配器的关键实现细节。

5.1 WP_Http_Curl

WP_Http_Curl 使用 cURL 扩展来执行 HTTP 请求。它具有以下特点：

性能优越: cURL 扩展通常比 PHP streams 和 fsockopen 更快。
功能强大: cURL 扩展支持各种 HTTP 特性，如 SSL/TLS, cookies, authentication 等。
依赖 cURL 扩展: 需要服务器安装 cURL 扩展。

关键代码片段：

// 设置 cURL 选项
curl_setopt( $ch, CURLOPT_URL, $url );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true ); // 不直接输出，而是返回字符串
curl_setopt( $ch, CURLOPT_HEADER, true ); // 返回 header
curl_setopt( $ch, CURLOPT_NOBODY, ( 'HEAD' === $r['method'] ) ); // HEAD 请求
curl_setopt( $ch, CURLOPT_CUSTOMREQUEST, $r['method'] ); // 设置请求方法

// 如果启用了流式传输
if ( $stream ) {
    $fh = fopen( $r['filename'], 'w' );
    if ( $fh ) {
        curl_setopt( $ch, CURLOPT_FILE, $fh ); // 将输出写入文件
    } else {
        return new WP_Error( 'http_request_failed', sprintf( __( 'Could not open file for writing: %s' ), $r['filename'] ) );
    }
}

// 执行请求
$response = curl_exec( $ch );

// 如果启用了流式传输，关闭文件句柄
if ( $stream && isset( $fh ) ) {
    fclose( $fh );
}

5.2 WP_Http_Streams

WP_Http_Streams 使用 PHP streams 来执行 HTTP 请求。它具有以下特点：

无需额外扩展: 不需要安装任何额外的 PHP 扩展。
依赖 PHP streams: 依赖 PHP streams 的配置和功能。
性能相对较差: 相比 cURL，性能可能稍逊。

关键代码片段：

// 创建 stream 上下文
$context = stream_context_create( $options );

// 发起请求
$stream = @fopen( $url, 'r', false, $context );

// 读取 header
$headers = stream_get_meta_data( $stream );

// 如果启用了流式传输
if ( $stream_fopen ) {
    $remote_file_fh = fopen( $r['filename'], 'wb' );
    if ( ! is_resource( $remote_file_fh ) ) {
        return new WP_Error( 'http_request_failed', sprintf( __( 'Could not open file for writing: %s' ), $r['filename'] ) );
    }
    while ( ! feof( $stream ) ) {
        fwrite( $remote_file_fh, fread( $stream, 1024 * 8 ) );
    }
    fclose( $remote_file_fh );
    fclose( $stream );
} else {
  // 非流式传输
  $body = stream_get_contents( $stream );
  fclose( $stream );
}

5.3 WP_Http_Fsockopen

WP_Http_Fsockopen 使用 fsockopen 函数来执行 HTTP 请求。它具有以下特点：

最基本的 HTTP 请求方式: 几乎所有 PHP 环境都支持。
功能有限: 不支持某些高级 HTTP 特性。
性能最差: 相比 cURL 和 PHP streams，性能最差。

关键代码片段：

// 创建 socket 连接
$socket = @fsockopen( $host, $port, $errno, $errstr, $timeout );

// 发送 HTTP 请求
fwrite( $socket, $request );

// 读取 header
$headers = '';
while ( ! feof( $socket ) ) {
    $line = fgets( $socket, 128 );
    if ( "rn" == $line ) {
        break;
    }
    $headers .= $line;
}

// 如果启用了流式传输
if ( $stream ) {
    $fh = fopen( $r['filename'], 'wb' );
    if ( ! $fh ) {
        return new WP_Error( 'http_request_failed', sprintf( __( 'Could not open file for writing: %s' ), $r['filename'] ) );
    }
    while ( ! feof( $socket ) ) {
        $block = fread( $socket, 4096 );
        fwrite( $fh, $block );
    }
    fclose( $fh );
    fclose( $socket );
} else {
  // 非流式传输
  $body = '';
  while ( ! feof( $socket ) ) {
      $body .= fread( $socket, 4096 );
  }
  fclose( $socket );
}

6. 错误处理

wp_remote_get 和 wp_remote_request 函数使用 WP_Error 类来处理错误。如果请求过程中发生任何错误（例如，URL 验证失败，连接超时，服务器返回错误状态码等），函数会返回一个 WP_Error 对象，其中包含错误代码和错误消息。

开发者应该始终检查 wp_remote_get 或 wp_remote_request 函数的返回值是否为 WP_Error 对象，并在发生错误时进行适当的处理。

$response = wp_remote_get( 'https://example.com/nonexistent-page' );

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

7. 异步请求

wp_remote_request 函数支持异步请求，可以通过将 blocking 参数设置为 false 来实现。异步请求不会阻塞 PHP 进程，允许 WordPress 在后台执行 HTTP 请求，而无需等待响应。

$args = array(
    'blocking' => false,
);

wp_remote_get( 'https://example.com', $args );

需要注意的是，异步请求不会返回响应数据。如果需要处理响应数据，可以使用 WordPress 的 Cron API 或其他异步任务处理机制。

8. 代码示例

下面是一些使用 wp_remote_get 函数的示例：

获取 JSON 数据:

$response = wp_remote_get( 'https://api.example.com/data' );

if ( is_wp_error( $response ) ) {
    // Handle error
} else {
    $body = wp_remote_retrieve_body( $response );
    $data = json_decode( $body );

    if ( $data ) {
        // Process the data
    } else {
        // Handle JSON decode error
    }
}

下载文件:

$url = 'https://example.com/large-file.zip';
$file_path = ABSPATH . 'wp-content/uploads/large-file.zip';

$response = wp_remote_get( $url, array( 'filename' => $file_path ) );

if ( is_wp_error( $response ) ) {
    // Handle error
} else {
    echo 'File downloaded successfully to ' . $file_path;
}

自定义请求头:

$args = array(
    'headers' => array(
        'X-Custom-Header' => 'Custom Value',
    ),
);

$response = wp_remote_get( 'https://example.com', $args );

9. 请求参数，返回值与错误处理

参数名称	类型	描述
`$url`	string	请求的 URL。
`$args`	array	一个关联数组，包含请求的配置选项。详细参数请参考上文的参数处理部分。

返回值类型	描述
array	成功时，返回一个关联数组，包含响应的头信息 (`headers`)、响应体 (`body`)、响应状态码 (`response` 数组) 以及其他信息。
WP_Error	如果请求失败，返回一个 `WP_Error` 对象，其中包含错误代码和错误消息。

10. 总结

wp_remote_get 提供了一个方便且强大的方式来执行 HTTP GET 请求。它依赖于 WP_Http 类及其传输适配器来处理底层的 HTTP 通信。流式传输功能允许高效地处理大型文件。理解这些底层机制，可以帮助开发者更好地使用 wp_remote_get 函数，并解决可能遇到的问题。

WordPress wp_remote_get 函数的 HTTP 请求抽象与流式传输逻辑

发表回复 取消回复

WordPress `wp_remote_get` 函数的 HTTP 请求抽象与流式传输逻辑

发表回复取消回复