PHP 中使用 cURL 实现流式响应并返回给客户端

2024-05-21 11:16:55 浏览数 (1)

标题: PHP 中使用 cURL 实现流式响应并返回给客户端

内容:

在 Web 开发中,流式响应(Streaming Response)是一种高效的数据传输方式,它允许服务器在数据完全生成之前就开始向客户端发送数据。这在处理大文件、实时数据或其他需要快速响应的场景中特别有用。结合 cURL 库,我们可以在 PHP 中实现流式响应,并通过 Server-Sent Events (SSE) 将数据实时推送给客户端。

以下是一个示例函数,该函数使用 cURL 发起流式请求,并通过回调函数处理接收到的数据,然后将这些数据流式地返回给客户端。

PHP 代码示例:

代码语言:php复制
<?php

/**
 * 通过 cURL 发起流式请求并处理响应
 *
 * @param string $url 请求的 URL
 * @param array $headers 请求头数组
 * @param array|string|null $postData POST 数据
 * @param callable $callback 处理响应数据的回调函数
 * @throws Exception 如果回调函数不是有效的 Callable
 */
function curlStreamRequest(string $url, array $headers = [], $postData = null, callable $callback) {
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, false); // 不将响应保存为字符串,直接处理
    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); // 注意:在生产环境中应启用 SSL 验证
    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); // 注意:同上
    curl_setopt($ch, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);
    curl_setopt($ch, CURLOPT_POST, is_array($postData) || !empty($postData));
    curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);
    curl_setopt($ch, CURLOPT_WRITEFUNCTION, function ($ch, $data) use ($callback) {
        // 调用回调函数处理数据
        $callback($data);
        return strlen($data); // 返回接收到的数据长度
    });

    // 执行请求并获取响应
    curl_exec($ch);

    // 检查是否有错误发生
    if (curl_errno($ch)) {
        throw new Exception(curl_error($ch));
    }

    // 关闭 cURL 句柄
    curl_close($ch);
}

/**
 * 示例回调函数,用于处理接收到的数据并返回给客户端
 *
 * @param string $data 接收到的数据片段
 */
function handleResponseData($data) {
    // 在这里,你可以将数据写入输出缓冲区或直接发送给客户端
    // 例如,使用 echo 或 SSE 发送数据
    echo $data; // 假设这里直接将数据发送给客户端
    flush(); // 刷新输出缓冲区
}

// 使用示例
curlStreamRequest(
    'https://example.com/api/stream', // 替换为实际的 API URL
    ['Content-Type: application/json'], // 替换为实际的请求头
    json_encode(['key' => 'value']), // 替换为实际的 POST 数据(如果需要)
    'handleResponseData' // 传递回调函数名作为字符串(如果回调函数在全局作用域中)
    // 或者直接传递闭包函数
    // function($data) {
    //     handleResponseData($data);
    // }
);

// 注意:如果回调函数是闭包,请确保它在 curlStreamRequest 函数的外部定义

?>

注意事项:

  1. 在生产环境中,请确保启用 SSL 验证(CURLOPT_SSL_VERIFYPEERCURLOPT_SSL_VERIFYHOST 应设置为 true),并配置有效的 CA 证书。
  2. 如果使用 Server-Sent Events (SSE),请确保在 handleResponseData 函数中发送正确的 SSE 数据格式(例如,以 data: 开头的数据行)。
  3. 在发送数据给客户端时,使用 flush() 函数可以确保数据立即发送到客户端,而不是等待缓冲区满或脚本结束。
php

0 人点赞