0

0

如何在Laravel中使用事件和监听器

幻夢星雲

幻夢星雲

发布时间:2025-07-08 16:32:02

|

610人浏览过

|

来源于php中文网

原创

事件和监听器是laravel中实现松耦合的关键机制。1. 定义事件类如userregistered,封装发生的“事情”;2. 创建监听器如sendwelcomeemail,处理事件触发后的操作,并可异步执行;3. 在eventserviceprovider中注册事件与监听器的映射关系;4. 使用event()函数触发事件,自动执行所有关联监听器;5. 可通过事件订阅者组织多个监听器,集中管理相关事件逻辑;6. 事件广播允许将事件推送到客户端,实现实时功能;7. 监听器可使用队列异步处理,提升性能;8. 使用event::fake()和queue::fake()进行事件和监听器的测试,确保其正常运行。

如何在Laravel中使用事件和监听器

事件和监听器是Laravel中实现松耦合的关键机制。它们允许你在应用程序的不同部分之间发送和接收通知,而无需它们直接了解彼此。简单来说,就是当某件事发生时(事件),让其他部分知道并执行相应的操作(监听器)。

解决方案

Laravel 的事件和监听器机制,核心就是解耦。想象一下,用户注册成功后,你需要发送欢迎邮件、记录用户行为、更新用户积分,甚至触发其他更复杂的流程。如果这些逻辑都直接写在注册控制器里,代码会变得臃肿不堪,而且难以维护和扩展。事件和监听器就能很好地解决这个问题。

  1. 定义事件: 事件就是一个简单的 PHP 类,用于封装发生的“事情”。例如,UserRegistered 事件。

    user = $user;
        }
    }

    这个事件类很简单,它接收一个 User 对象作为参数,并将其存储在 $user 属性中。

  2. 创建监听器: 监听器负责监听特定的事件,并在事件发生时执行相应的操作。 例如,SendWelcomeEmail 监听器。

    user->email)->send(new WelcomeEmail($event->user));
        }
    }

    注意 ShouldQueue 接口。 实现这个接口会让监听器异步执行,避免阻塞主线程。 邮件发送这类耗时操作,就应该异步处理。

  3. 注册事件和监听器:EventServiceProvider 中注册事件和监听器的对应关系。

     [
                SendWelcomeEmail::class,
                // 其他监听器
            ],
        ];
    
        /**
         * Register any events for your application.
         *
         * @return void
         */
        public function boot()
        {
            parent::boot();
    
            //
        }
    }

    这样,当 UserRegistered 事件发生时,SendWelcomeEmail 监听器就会被触发。你可以在一个事件上注册多个监听器,实现更复杂的功能。

  4. 触发事件: 在需要的地方触发事件。 例如,在用户注册成功后:

    use App\Events\UserRegistered;
    
    // ... 用户注册逻辑
    
    $user = User::create($request->validated());
    
    event(new UserRegistered($user));
    
    // ...

    调用 event() 函数,传入一个事件对象,就可以触发该事件。 Laravel 会自动找到所有注册的监听器,并依次执行它们。

如何使用事件订阅者(Event Subscribers)来组织事件监听?

事件订阅者提供了一种更灵活的方式来组织事件监听。它们允许你在一个类中定义多个事件监听器,而无需在 EventServiceProvider 中显式注册每个监听器。

创建一个事件订阅者类:

listen(
            UserRegistered::class,
            [UserEventSubscriber::class, 'handleUserRegistered']
        );
    }
}

然后,在 EventServiceProvider 中注册订阅者:

protected $subscribe = [
    'App\Listeners\UserEventSubscriber',
];

事件订阅者通过 subscribe() 方法来注册监听器。 这种方式更适合组织与特定模型或功能相关的多个事件监听器。

事件广播(Event Broadcasting)是什么,以及如何使用它来实现实时功能?

事件广播允许你在服务器端触发事件,并将这些事件推送到客户端(通常是浏览器),从而实现实时功能。 例如,当用户发布新帖子时,你可以广播一个 PostCreated 事件,让所有订阅该事件的客户端立即更新界面。

  1. 配置广播驱动:.env 文件中配置广播驱动。 常用的驱动有 redispusher

    BROADCAST_DRIVER=redis
  2. 安装必要的包: 根据你选择的广播驱动,安装相应的 PHP 和 JavaScript 包。

    易森网络企业版
    易森网络企业版

    如果您是新用户,请直接将本程序的所有文件上传在任一文件夹下,Rewrite 目录下放置了伪静态规则和筛选器,可将规则添加进IIS,即可正常使用,不用进行任何设置;(可修改图片等)默认的管理员用户名、密码和验证码都是:yeesen系统默认关闭,请上传后登陆后台点击“核心管理”里操作如下:进入“配置管理”中的&ld

    下载

    例如,如果使用 redis,你需要安装 predis/predis PHP 包,以及 laravel-echo JavaScript 包。

  3. 实现 ShouldBroadcast 接口: 让事件类实现 ShouldBroadcast 接口。

    post = $post;
        }
    
        /**
         * Get the channels the event should broadcast on.
         *
         * @return \Illuminate\Broadcasting\Channel|array
         */
        public function broadcastOn()
        {
            return new Channel('posts');
        }
    }

    broadcastOn() 方法定义了事件广播的频道。 可以是公共频道 (Channel)、私有频道 (PrivateChannel) 或存在频道 (PresenceChannel)。

  4. 在客户端监听事件: 使用 laravel-echo 在客户端监听事件。

    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,
        forceTLS: true
    });
    
    Echo.channel('posts')
        .listen('PostCreated', (event) => {
            console.log(event.post);
            // 更新界面
        });

    这样,当服务器端触发 PostCreated 事件时,客户端就能收到事件数据,并更新界面。

如何使用队列来处理事件监听器,以提高应用程序的性能?

将事件监听器放入队列中异步执行,可以显著提高应用程序的性能,特别是对于耗时的操作,例如发送邮件、处理图像等。

  1. 确保监听器实现了 ShouldQueue 接口: 如上面的 SendWelcomeEmail 监听器示例所示。

  2. 配置队列连接:.env 文件中配置队列连接。 常用的连接有 redisdatabasebeanstalkd 等。

    QUEUE_CONNECTION=redis
  3. 运行队列worker: 使用 php artisan queue:work 命令运行队列worker。 也可以使用 php artisan queue:listen 命令,该命令会在队列为空时暂停,并在有新任务时自动恢复。

    php artisan queue:work redis --sleep=3 --tries=3

    --sleep 选项指定worker在队列为空时休眠的秒数。 --tries 选项指定worker尝试处理任务的最大次数。

通过将事件监听器放入队列中,你可以将耗时的操作从主线程中分离出来,从而提高应用程序的响应速度和整体性能。

如何测试事件和监听器?

测试事件和监听器可以确保你的应用程序能够正确地响应事件,并执行相应的操作。

  1. 使用 Event::fake() 方法: 在测试用例中使用 Event::fake() 方法来阻止事件的实际触发。

    use App\Events\UserRegistered;
    use Illuminate\Support\Facades\Event;
    use Tests\TestCase;
    
    class UserRegistrationTest extends TestCase
    {
        public function test_user_registered_event_is_dispatched()
        {
            Event::fake();
    
            // ... 用户注册逻辑
    
            Event::assertDispatched(UserRegistered::class);
        }
    }

    Event::assertDispatched() 方法断言指定的事件是否被触发。

  2. 使用 Queue::fake() 方法: 如果你的监听器是队列化的,可以使用 Queue::fake() 方法来阻止任务的实际入队。

    use App\Events\UserRegistered;
    use App\Listeners\SendWelcomeEmail;
    use Illuminate\Support\Facades\Queue;
    use Tests\TestCase;
    
    class UserRegistrationTest extends TestCase
    {
        public function test_welcome_email_is_queued_when_user_registers()
        {
            Queue::fake();
    
            // ... 用户注册逻辑
    
            Queue::assertPushed(SendWelcomeEmail::class, function ($listener) {
                return $listener->event instanceof UserRegistered;
            });
        }
    }

    Queue::assertPushed() 方法断言指定的任务是否被推送到队列中。

通过使用这些测试工具,你可以确保你的事件和监听器能够正常工作,并提高应用程序的可靠性。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2528

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1604

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1496

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

952

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1416

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1234

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1445

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1306

2023.11.13

公务员递补名单公布时间 公务员递补要求
公务员递补名单公布时间 公务员递补要求

公务员递补名单公布时间不固定,通常在面试前,由招录单位(如国家知识产权局、海关等)发布,依据是原入围考生放弃资格,会按笔试成绩从高到低递补,递补考生需按公告要求限时确认并提交材料,及时参加面试/体检等后续环节。要求核心是按招录单位公告及时响应、提交材料(确认书、资格复审材料)并准时参加面试。

1

2026.01.15

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
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号