Laravel开发：如何使用Laravel Echo实现WebSockets通信？

PHPz 原创: 2023-06-13 13:34:45 1032浏览

Laravel是一种流行的PHP框架，它有许多有用的工具和扩展库，可以让开发者轻松构建高质量的Web应用程序。其中，Laravel Echo是一款强大的WebSockets通信工具，可以帮助开发者在Web应用程序中实现实时通信。

在本篇文章中，我们将介绍如何使用Laravel Echo并建立WebSockets服务器来实现实时通信。我们将首先简述什么是WebSockets和Laravel Echo，接着我们将讲解如何安装和配置Laravel Echo，最后演示如何使用Laravel Echo与JavaScript客户端通信。

什么是WebSockets？

WebSockets是一种协议，它允许Web应用程序和Web服务器之间建立实时通信连接。这种连接可以保持长时间开启，并且是双向的，可以同时进行读取和写入。

与HTTP请求不同，WebSockets连接的持续开启可以使服务端实时地推送数据到客户端，而不需要通过轮询或长轮询来实现。这使得Web应用程序能够实现快速、高效、实时的通信。

什么是Laravel Echo？

Laravel Echo是Laravel框架的一款官方扩展库，可以帮助开发者在Web应用程序中实现WebSockets通信。它提供了一个简单的API，可以使用JavaScript轻松订阅广播频道，并在客户端和服务端之间传递消息。

使用Laravel Echo和Laravel推送器可以轻松地建立WebSockets服务器，并使用广播频道来组织WebSockets通信。在客户端，我们可以使用JavaScript和Laravel Echo实时地监听消息，以便在Web应用程序中实现实时通信。

安装和配置Laravel Echo

在开始使用Laravel Echo之前，我们需要安装和配置所需的软件：Laravel和pusher PHP SDK。Laravel Echo和pusher PHP SDK可以通过Composer包管理器来安装。

首先需要安装Laravel：

composer create-project laravel/laravel your-project-name

接着，我们需要安装pusher PHP SDK。可以通过运行以下命令来完成pusher PHP SDK的安装：

composer require pusher/pusher-php-server

为了集成Laravel Echo和pusher PHP SDK，我们需要在config/app.php文件中添加服务提供程序和别名：

// config/app.php

'providers' => [
    // ...
    LaravelBroadcastingBroadcastServiceProvider::class,
],

'aliases' => [
    // ...
    'Broadcast' => LaravelBroadcastingBroadcastFacade::class,
],

接下来，让我们做一些配置工作，以确保Laravel Echo和pusher PHP SDK能够正常工作。我们需要在.env文件中添加Laravel Echo和pusher PHP SDK所需的所有配置：

BROADCAST_DRIVER=pusher
PUSHER_APP_ID=your-pusher-app-id
PUSHER_APP_KEY=your-pusher-app-key
PUSHER_APP_SECRET=your-pusher-app-secret
PUSHER_APP_CLUSTER=your-pusher-app-cluster

创建WebSockets服务器

接下来，我们将使用Laravel Echo和pusher PHP SDK来建立WebSockets服务器。我们需要在routes/channels.php文件中定义广播频道。广播频道将决定哪些用户可以接收到广播消息。

// routes/channels.php

use IlluminateSupportFacadesBroadcast;

Broadcast::channel('chat.{roomId}', function ($user, $roomId) {
    // ...
});

在上面的例子中，我们定义了一个名为“chat”的广播频道，并给它传递了一个参数“roomId”。只有拥有“chat.roomId”权限的用户才能接收到该广播频道的消息。

接下来，我们需要定义广播事件和推送其消息。在app/Events目录下创建一个新的事件类，例如：

// app/Events/ChatMessageSent.php

<?php

namespace AppEvents;

use IlluminateBroadcastingPrivateChannel;
use IlluminateContractsBroadcastingShouldBroadcast;
use IlluminateFoundationEventsDispatchable;
use IlluminateQueueSerializesModels;

class ChatMessageSent implements ShouldBroadcast
{
    use Dispatchable, SerializesModels;

    public $message;

    public function __construct($message)
    {
        $this->message = $message;
    }

    public function broadcastOn()
    {
        return new PrivateChannel('chat.' . $this->message['room_id']);
    }
}

这个事件类包含了广播事件的逻辑，并且需要实现ShouldBroadcast接口才能被广播出去。

现在，我们可以在应用程序中实例化该事件，然后发送广播消息。例如，在app/Http/Controllers/ChatController.php文件中添加以下消息发送方法：

// app/Http/Controllers/ChatController.php

<?php

namespace AppHttpControllers;

use AppEventsChatMessageSent;
use IlluminateHttpRequest;

class ChatController extends Controller
{
    public function sendMessage(Request $request)
    {
        $message = [
            'user_id' => $request->user()->id,
            'room_id' => $request->get('room_id'),
            'message' => $request->get('message'),
        ];

        event(new ChatMessageSent($message));

        return response()->json(['status' => 'Message Sent!']);
    }
}

请注意，上面的代码中，event(new ChatMessageSent($message))触发了事件，并发送了一个包含消息数据的广播事件。

建立实时通信

最后，我们需要在JavaScript客户端中使用Laravel Echo监听广播事件，以获取实时的WebSockets通信。在JavaScript中，我们可以使用两种方式来监听广播事件：

Echo.channel(channelName).listen(eventName, callback)：订阅广播事件，并注册回调函数，以便在接收到事件时执行。
Echo.private(channelName).listen(eventName, callback)：订阅私有广播事件，并注册回调函数，以便在接收到事件时执行。

例如，在我们的聊天应用程序中，我们可以使用以下代码来监听新消息的事件：

// resources/js/app.js

import Echo from 'laravel-echo';
window.Pusher = require('pusher-js');

window.Echo = new Echo({
    broadcaster: 'pusher',
    key: process.env.MIX_PUSHER_APP_KEY,
    cluster: process.env.MIX_PUSHER_APP_CLUSTER,
    encrypted: true,
});

window.Echo.channel(`chat.${roomId}`)
    .listen('ChatMessageSent', (e) => {
        console.log(e);
    });

在上述代码中，我们使用Laravel Echo客户端订阅“chat.roomId”频道，并在接收到“ChatMessageSent”事件时打印出事件数据。