使用Artisan命令生成UserRegistered事件和SendWelcomeEmail监听器;2. 在事件类中定义用户属性并通过构造函数注入;3. 监听器中通过handle方法发送欢迎邮件;4. 在EventServiceProvider中注册事件与监听器映射关系;5. 在注册逻辑中触发事件;6. 为监听器添加ShouldQueue接口实现异步队列处理,提升性能。

在 laravel 中,事件(Event)和监听器(Listener)是实现解耦、提升代码可维护性的重要机制。通过事件系统,你可以在应用中某个动作发生时触发一个事件,然后由一个或多个监听器来响应它。比如用户注册后发送欢迎邮件、记录日志等场景非常适用。
1. 创建 Event 和 Listener
Laravel 提供了 Artisan 命令快速生成事件和监听器。
假设我们要实现“用户注册成功后触发欢迎事件”:
生成事件:
php artisan make:event UserRegistered
生成监听器:
php artisan make:listener SendWelcomeEmail --event=UserRegistered
执行后会在 app/Events/UserRegistered.php 和 app/Listeners/SendWelcomeEmail.php 生成对应文件。
2. 定义事件类
打开 UserRegistered 事件类,将需要传递的数据作为属性注入:
<?php namespace AppEvents; use IlluminateBroadcastingChannel; use IlluminateBroadcastingInteractsWithSockets; use IlluminateBroadcastingPresenceChannel; use IlluminateBroadcastingPrivateChannel; use IlluminateContractsBroadcastingShouldBroadcast; use IlluminateFoundationEventsDispatchable; use IlluminateQueueSerializesModels; use AppModelsUser; class UserRegistered { use Dispatchable, InteractsWithSockets, SerializesModels; public $user; public function __construct(User $user) { $this->user = $user; } }
3. 编写监听器逻辑
在 SendWelcomeEmail 监听器中处理具体业务,例如发送邮件:
<?php namespace AppListeners; use AppEventsUserRegistered; use IlluminateSupportFacadesMail; class SendWelcomeEmail { public function handle(UserRegistered $event) { // 发送欢迎邮件 Mail::raw("欢迎注册我们的网站!", function ($message) use ($event) { $message->to($event->user->email)->subject('欢迎加入'); }); } }
当然,你也可以调用 Mailable 类进行更复杂的邮件构造。
4. 注册事件与监听器
打开 app/Providers/EventServiceProvider.php,在 $listen 数组中注册事件与监听器的映射关系:
protected $listen = [ 'AppEventsUserRegistered' => [ 'AppListenersSendWelcomeEmail', ], ];
如果有多个监听器需要响应同一个事件,可以继续添加。
5. 触发事件
在控制器或服务中使用 event() 辅助函数或 dispatch() 方法触发事件:
use AppEventsUserRegistered; use AppModelsUser; // 比如在注册逻辑中 $user = User::create([ 'name' => '张三', 'email' => 'zhangsan@example.com', 'password' => bcrypt('123456') ]); UserRegistered::dispatch($user); // 或者 event(new UserRegistered($user));
一旦事件被触发,所有注册的监听器都会按顺序执行。
6. 使用队列异步处理
如果监听器操作较耗时(如发送邮件),建议异步处理。只需让监听器实现 ShouldQueue 接口:
use IlluminateContractsQueueShouldQueue; class SendWelcomeEmail implements ShouldQueue { use Queueable; public function handle(UserRegistered $event) { // 异步发送邮件 } }
确保配置了队列驱动(如 database、redis、sqs 等),并运行队列进程:php artisan queue:work。
基本上就这些。Laravel 的事件系统结构清晰,配合队列能有效提升性能和用户体验。实际项目中合理使用,能让代码更优雅、职责更分明。
以上就是Laravel事件监听器怎么写_Laravel Event和Listener使用教程的详细内容,更多请关注php中文网其它相关文章!