0

0

Laravel开发:如何使用Laravel Echo实现WebSockets通信?

PHPz

PHPz

发布时间:2023-06-13 13:34:45

|

1634人浏览过

|

来源于php中文网

原创

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文件中定义广播频道。广播频道将决定哪些用户可以接收到广播消息。

Invoice Ninja
Invoice Ninja

Invoice Ninja是一个免费且开源的发票、费用和时间跟踪应用,使用Laravel和Flutter构建。它提供了众多出色的功能,包括自定义品牌发票设计、定期发票和自动向客户收费、实时报价创建和自定义提案、费用报告等等!Invoice Ninja还能够处理来自40多个支付网关的在线支付,包括Stripe、PayPal和WePay。它还接受使用信用卡、ACH、比特币等进行支付。通过Invoice Ninja,您可以在线收款、使用看板板进行项目工作流程组织,并通过Webapp帐户在线跟踪时间。

下载
// routes/channels.php

use IlluminateSupportFacadesBroadcast;

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

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

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

// app/Events/ChatMessageSent.php

message = $message;
    }

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

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

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

// app/Http/Controllers/ChatController.php

 $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”事件时打印出事件数据。

结论

通过使用Laravel Echo和pusher PHP SDK,我们可以轻松地建立WebSockets服务器,并使用广播频道来实现WebSockets通信。在客户端,我们可以使用JavaScript和Laravel Echo实时地监听消息,从而实现实时通信。

此外,Laravel Echo还提供了许多其他可用的广播频道和事件,我们可以使用它们来构建复杂的Web应用程序。如果你正在寻找一种现代化的实时通信解决方案,Laravel Echo和pusher PHP SDK是一个不错的选择。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

320

2024.04.09

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

278

2024.04.09

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

373

2024.04.09

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

374

2024.04.10

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

86

2025.08.05

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

65

2025.08.05

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

68

2025.08.05

composer是什么插件
composer是什么插件

Composer是一个PHP的依赖管理工具,它可以帮助开发者在PHP项目中管理和安装依赖的库文件。Composer通过一个中央化的存储库来管理所有的依赖库文件,这个存储库包含了各种可用的依赖库的信息和版本信息。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

154

2023.12.25

C++ 设计模式与软件架构
C++ 设计模式与软件架构

本专题深入讲解 C++ 中的常见设计模式与架构优化,包括单例模式、工厂模式、观察者模式、策略模式、命令模式等,结合实际案例展示如何在 C++ 项目中应用这些模式提升代码可维护性与扩展性。通过案例分析,帮助开发者掌握 如何运用设计模式构建高质量的软件架构,提升系统的灵活性与可扩展性。

9

2026.01.30

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

相关下载

更多

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Laravel---API接口
Laravel---API接口

共7课时 | 0.6万人学习

PHP自制框架
PHP自制框架

共8课时 | 0.6万人学习

PHP面向对象基础课程(更新中)
PHP面向对象基础课程(更新中)

共12课时 | 0.7万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号