Laravel开发:如何使用Laravel Broadcasting实现事件广播?

发布时间 - 2023-06-13 00:00:00    点击率:

在实时web应用中,事件广播是非常重要的功能之一。laravel框架提供了开箱即用的事件广播功能,通过laravel broadcasting可以轻松实现事件的广播和监听。本文将介绍如何使用laravel broadcasting实现事件广播。

一、理解事件广播

在Web应用中,当某个事件发生时,比如用户注册成功、文章发布等,我们希望其他用户能够及时收到相关信息。此时,如果使用传统的刷新页面或者Ajax轮询的方式,会消耗大量的带宽和服务器资源,也无法满足实时性的需求。事件广播则可以解决这样的问题。

事件广播是将某个事件发射到特定的频道或者广播组中,然后监听特定频道或广播组的用户就能够即时收到相关信息。通过事件广播,可以大幅减少服务器和客户端之间的通信次数,降低网络延迟和带宽消耗,提升Web应用的性能和用户体验。

二、安装Laravel Broadcasting

在使用Laravel Broadcasting之前,需要安装Laravel Echo和相关的广播驱动。Laravel Echo是Laravel框架自带的Socket.io客户端库,用于与广播服务进行实时通信。广播驱动提供了与不同广播服务进行交互的API,比如Redis和Pusher。在本文中,我们将使用Pusher作为广播服务。

  1. 安装Laravel Echo和Pusher SDK

通过npm安装Laravel Echo和Pusher SDK:

npm install --save laravel-echo pusher-js
  1. 修改配置文件

打开config/app.php文件,取消以下代码的注释:

AppProvidersBroadcastServiceProvider::class,

接着,在.env文件中添加Pusher的相关配置:

BROADCAST_DRIVER=pusher

PUSHER_APP_ID=your-app-id
PUSHER_APP_KEY=your-app-key
PUSHER_APP_SECRET=your-app-secret

其中,your-app-id、your-app-key和your-app-secret需要根据实际情况进行修改。

三、创建事件和频道

在Laravel中,事件是通过Event类实现的。我们可以为每个需要广播的事件创建一个相应的Event类。在本文中,我们以用户注册成功为例来创建一个UserRegistered事件。首先,在终端中执行以下命令创建UserRegistered事件类:

php artisan make:event UserRegistered

接着,打开app/Events/UserRegistered.php文件,将代码修改为:

namespace AppEvents;

use AppUser;
use IlluminateQueueSerializesModels;
use IlluminateFoundationEventsDispatchable;

class UserRegistered
{
    use Dispatchable, SerializesModels;

    public $user;

    /**
     * Create a new event instance.
     *
     * @param  AppUser  $user
     * @return void
     */
    public function __construct(User $user)
    {
        $this->user = $user;
    }

    /**
     * Get the channels the event should broadcast on.
     *
     * @return IlluminateBroadcastingChannel|array
     */
    public function broadcastOn()
    {
        return new Channel('user.'.$this->user->id);
    }
}

在上面的代码中,我们创建了一个UserRegistered事件类,并在构造方法中注入了User模型。然后,在broadcastOn()方法中,我们定义了事件需要广播到的频道,这里以'user.{user_id}'的形式指定了一个私有频道。

接着,我们需要创建一个UserChannel频道,用于监听'user.{user_id}'频道的用户。创建UserChannel频道有两种方式:手动注册和自动发现。

手动注册方式:

在app/Providers/BroadcastServiceProvider.php文件中注册UserChannel频道:

use IlluminateSupportFacadesBroadcast;
use AppBroadcastingUserChannel;

Broadcast::channel('user.{userId}', UserChannel::class);

自动发现方式:

在app/Broadcasting目录下创建一个UserChannel.php文件,将代码修改为:

namespace AppBroadcasting;

use AppUser;

class UserChannel
{
    /**
     * Create a new channel instance.
     *
     * @param  AppUser  $user
     * @return void
     */
    public function __construct(User $user)
    {
        $this->user = $user;
    }

    /**
     * Authenticate the user's access to the channel.
     *
     * @return array|bool
     */
    public function join(User $user, $userId)
    {
        return $user->id === (int) $userId;
    }
}

在上面的代码中,我们创建了一个UserChannel频道类,并在构造方法中注入了User模型。然后,通过join()方法验证用户是否有权访问该频道。

四、广播事件

在创建好事件和频道之后,我们可以使用broadcast()函数广播事件到指定的频道。在本文中,我们将在UserController类中实现用户注册成功后广播UserRegistered事件:

namespace AppHttpControllers;

use AppUser;
use AppEventsUserRegistered;
use IlluminateHttpRequest;

class UserController extends Controller
{
    /**
     * Register a new user.
     *
     * @param  IlluminateHttpRequest  $request
     * @return IlluminateHttpResponse
     */
    public function register(Request $request)
    {
        $user = new User([
            'name' => $request->input('name'),
            'email' => $request->input('email'),
            'password' => bcrypt($request->input('password')),
        ]);
        $user->save();

        event(new UserRegistered($user));

        return response()->json([
            'message' => 'User registered successfully!',
            'user' => $user,
        ]);
    }
}

在上面的代码中,我们首先创建了一个用户,并进行了保存操作。接着,使用event()函数广播UserRegistered事件,以通知其他用户有新用户注册成功了。

五、监听事件

在创建好事件和频道后,其他用户就可以通过监听相应的频道来接收事件。接下来,我们将通过Laravel Echo监听UserRegistered事件。

  1. 修改配置文件

首先,在resources/assets/js/bootstrap.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
});

在上述代码中,我们使用Laravel Echo和Pusher SDK来连接Pusher广播服务。可以在.env文件中设置PUSHER_APP_KEY和PUSHER_APP_CLUSTER。

  1. 创建监听器

打开resources/assets/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('user.' + userId)
    .listen('UserRegistered', (e) => {
        console.log(e);
    });

在上述代码中,我们通过window.Echo.channel()方法监听'user.{user_id}'频道,并指定了事件类型为'UserRegistered'。该代码将在用户登录后执行,以确保每个用户只是监听自己的频道。

六、测试

在应用中注册一个新用户,然后在控制台中查看是否收到了新的用户注册事件。

通过以上步骤,我们完成了使用Laravel Broadcasting实现事件广播的过程。事件广播是实时Web应用的重要功能之一,可以大幅提升Web应用的性能和用户体验。


# laravel  # php  # ajax  # bootstrap  # npm  # echo  # Event  # channel  # JS  # 事件  # redis  # 创建一个  # 注册成功  # 在上面  # 将在  # 并在  # 相关信息  # 配置文件  # 自己的  # 客户端  # 我们可以 


相关栏目: 【 网站优化151355 】 【 网络推广146373 】 【 网络技术251813 】 【 AI营销90571


相关推荐: iOS中将个别页面强制横屏其他页面竖屏  网站设计制作书签怎么做,怎样将网页添加到书签/主页书签/桌面?  中山网站推广排名,中山信息港登录入口?  高配服务器限时抢购:企业级配置与回收服务一站式优惠方案  Laravel怎么实现支付功能_Laravel集成支付宝微信支付  猪八戒网站制作视频,开发一个猪八戒网站,大约需要多少?或者自己请程序员,需要什么程序员,多少程序员能完成?  Laravel怎么在Blade中安全地输出原始HTML内容  如何快速生成高效建站系统源代码?  Android实现代码画虚线边框背景效果  Laravel如何创建自定义Facades?(详细步骤)  简单实现Android文件上传  Android GridView 滑动条设置一直显示状态(推荐)  如何在自有机房高效搭建专业网站?  javascript读取文本节点方法小结  手机网站制作与建设方案,手机网站如何建设?  活动邀请函制作网站有哪些,活动邀请函文案?  js实现获取鼠标当前的位置  Laravel如何实现全文搜索_Laravel Scout集成Algolia或Meilisearch教程  Laravel怎么在Controller之外的地方验证数据  php后缀怎么变mp4格式错误_修改扩展名提示格式不对怎么办【技巧】  🚀拖拽式CMS建站能否实现高效与个性化并存?  如何注册花生壳免费域名并搭建个人网站?  如何用5美元大硬盘VPS安全高效搭建个人网站?  猎豹浏览器开发者工具怎么打开 猎豹浏览器F12调试工具使用【前端必备】  Laravel怎么连接多个数据库_Laravel多数据库连接配置  Laravel如何升级到最新的版本_Laravel版本升级流程与兼容性处理  悟空识字怎么关闭自动续费_悟空识字取消会员自动扣费步骤  EditPlus中的正则表达式 实战(2)  JavaScript如何实现路由_前端路由原理是什么  Laravel Debugbar怎么安装_Laravel调试工具栏配置指南  大学网站设计制作软件有哪些,如何将网站制作成自己app?  如何在建站主机中优化服务器配置?  郑州企业网站制作公司,郑州招聘网站有哪些?  HTML5段落标签p和br怎么选_文本排版常用标签对比【解答】  如何在云主机上快速搭建多站点网站?  Laravel的Blade指令怎么自定义_创建你自己的Laravel Blade Directives  微信小程序 HTTPS报错整理常见问题及解决方案  如何快速搭建自助建站会员专属系统?  WEB开发之注册页面验证码倒计时代码的实现  网页制作模板网站推荐,网页设计海报之类的素材哪里好?  Laravel如何使用Livewire构建动态组件?(入门代码)  Laravel的HTTP客户端怎么用_Laravel HTTP Client发起API请求教程  高防服务器租用指南:配置选择与快速部署攻略  laravel怎么通过契约(Contracts)编程_laravel契约(Contracts)编程方法  Java垃圾回收器的方法和原理总结  深圳网站制作平台,深圳市做网站好的公司有哪些?  mc皮肤壁纸制作器,苹果平板怎么设置自己想要的壁纸我的世界?  常州企业网站制作公司,全国继续教育网怎么登录?  Laravel如何配置任务调度?(Cron Job示例)  JS经典正则表达式笔试题汇总