在Laravel中创建一个事件流功能流程步骤

2023-06-01 00:00:00 步骤 流程 创建一个

介绍：事件流为您提供了一种无需重新加载页面即可将事件发送到客户端的方法。这对于实时更新用户界面等对数据库进行更改非常有用。

与使用 AJAX 请求的传统 Long-polling 不同，将多个请求发送到服务器并每次建立一个新连接，事件流在单个请求中实时发送到客户端。

在本文中，我将向您展示如何在 Laravel 中创建一个简单的事件流。

先决条件

在开始之前，你需要在你的机器上安装 Laravel。

我将为此演示使用 DigitalOcean Ubuntu Droplet。如果您愿意，您可以使用我的会员代码免费获得 100 美元的 DigitalOcean 积分来启动您自己的服务器！

如果您还没有，您可以按照本教程中的步骤进行操作：如何一键在 DigitalOcean 上安装 Laravel

或者您可以使用这个很棒的脚本进行安装：拉拉帆

创建控制器

让我们从创建一个处理事件流的控制器开始。

为此，我们将使用以下命令：

php artisan make:controller EventStreamController

App\Http\Controllers这将在目录中创建一个新控制器。

添加事件流方法

创建控制器后，我们需要向其中添加stream方法。该方法将用于发送事件流。

打开EventStreamController.php文件并添加以下代码：

<?phpnamespace App\Http\Controllers;use Carbon\Carbon;use App\Models\Trade;class StreamsController extends Controller{    /**
     * The stream source.
     *
     * @return \Illuminate\Http\Response
     */
    public function stream(){        return response()->stream(function () {            while (true) {                echo "event: ping\n";
                $curDate = date(DATE_ISO8601);                echo 'data: {"time": "' . $curDate . '"}';                echo "\n\n";

                $trades = Trade::latest()->get();                echo 'data: {"total_trades":' . $trades->count() . '}' . "\n\n";

                $latestTrades = Trade::with('user', 'stock')->latest()->first();                if ($latestTrades) {                    echo 'data: {"latest_trade_user":"' . $latestTrades->user->name . '", "latest_trade_stock":"' . $latestTrades->stock->symbol . '", "latest_trade_volume":"' . $latestTrades->volume . '", "latest_trade_price":"' . $latestTrades->stock->price . '", "latest_trade_type":"' . $latestTrades->type . '"}' . "\n\n";
                }

                ob_flush();
                flush();                // Break the loop if the client aborted the connection (closed the page)
                if (connection_aborted()) {break;}
                usleep(50000); // 50ms
            }
        }, 200, [            'Cache-Control' => 'no-cache',            'Content-Type' => 'text/event-stream',
        ]);
    }
}

这里需要注意的主要事项是：

  • 我们正在使用该response()->stream()方法来创建事件流。

  • 然后我们有一个无限循环，每 50 毫秒发送一次事件流。

  • 我们使用ob_flush()andflush()方法来发送事件流。

  • 我们正在使用该sleep()方法在发送下一个事件之前等待 50 毫秒。

  • 如果客户端中止连接，我们将使用该connection_aborted()方法中断循环。

  • 我们正在使用Carbon\Carbon该类来获取当前日期。

  • 我们正在使用该App\Models\Trade模型来获取最新的交易。这只是为了演示，你可以使用任何你想要的模型。

  • 标Content-Type头设置为text/event-stream告诉浏览器响应是事件流。

启用输出缓冲

为了使上述代码正常工作，我们需要在您的 PHP.ini 文件中启用输出缓冲。这是通过将以下行添加到php.ini文件中来完成的：

output_buffering = On

进行此更改后，您可能需要重新加载 PHP-FPM 服务。或者，如果您使用的是 Apache，则可以重新启动 Apache。

添加路线

我们想在请求路由stream时调用该方法。/stream

该路线将被添加到routes/web.php文件中，如下所示：

use App\Http\Controllers\StreamsController;Route::get('/stream', [StreamsController::class, 'stream']);

在前端处理事件流

您可以使用像Vue.js这样的前端框架来处理事件流。但是对于这个演示，我将使用纯 Javascript。

我将添加到刀片模板中的 JavaScript 片段如下所示：

const eventSource = new EventSource('/stream');eventSource.onmessage = function(event) {    const data = JSON.parse(event.data);    if (data.time) {        document.getElementById('time').innerHTML = data.time;
    }
    const newElement = document.createElement("li");    const eventList = document.getElementById("list");
    newElement.textContent = "message: " + event.data;
    eventList.appendChild(newElement);}

要查看此操作，您可以尝试以下演示！

演示项目

如果你想了解事件流是如何工作的，可以查看我创建的演示项目：

Laravel EventStream：使用 Laravel 和 Materialise 的实时股票交易仪表板

演示项目不仅显示了事件流，而且还有一个简单的前端仪表板，并使用Materialize作为流式数据库。

Laravel 事件流

SSE 与 WebSockets

事件流很棒且易于使用，但与其他流协议（如WebSockets ）相比，也有一些优点和缺点。

例如，SSE 是单向的，这意味着一旦建立连接，服务器只会向客户端发送数据，而客户端不能将数据发送回服务器。

与长轮询不同，使用 WebSockets，您只有一个与服务器的连接，类似于 SSE（服务器发送事件）。连接是双工的，这意味着您可以从服务器发送和接收数据。

如果您想了解有关 SSE 和 WebSockets 之间差异的更多信息，请观看 Martin Chaov 的精彩视频：

结论

有关事件流的更多信息，请在此处查看 Mozilla 的此文档：Web 平台中的事件流

在那里，您会找到对事件流及其工作方式的更深入的解释。

有关 Materialise 的更多信息，请在此处观看此视频：

希望你喜欢这个教程！

转：

https://devdojo.com/bobbyiliev/how-to-create-a-simple-event-streaming-in-laravel

相关文章