如何在Laravel中使用事件和监听器-Laravel-PHP中文网

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

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

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

解决方案

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

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

<?php

namespace App\Events;

use App\Models\User;
use Illuminate\Broadcasting\InteractsWithSockets;
use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;

class UserRegistered
{
    use Dispatchable, InteractsWithSockets, SerializesModels;

    public $user;

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

登录后复制

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

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

<?php

namespace App\Listeners;

use App\Events\UserRegistered;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Support\Facades\Mail;
use App\Mail\WelcomeEmail;

class SendWelcomeEmail implements ShouldQueue
{
    use InteractsWithQueue;

    /**
     * Create the event listener.
     *
     * @return void
     */
    public function __construct()
    {
        //
    }

    /**
     * Handle the event.
     *
     * @param  \App\Events\UserRegistered  $event
     * @return void
     */
    public function handle(UserRegistered $event)
    {
        Mail::to($event->user->email)->send(new WelcomeEmail($event->user));
    }
}

登录后复制

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

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

<?php

namespace App\Providers;

use App\Events\UserRegistered;
use App\Listeners\SendWelcomeEmail;
use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
use Illuminate\Support\Facades\Event;

class EventServiceProvider extends ServiceProvider
{
    /**
     * The event listener mappings for the application.
     *
     * @var array
     */
    protected $listen = [
        UserRegistered::class => [
            SendWelcomeEmail::class,
            // 其他监听器
        ],
    ];

    /**
     * Register any events for your application.
     *
     * @return void
     */
    public function boot()
    {
        parent::boot();

        //
    }
}

登录后复制

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

触发事件: 在需要的地方触发事件。例如，在用户注册成功后：
```
use App\Events\UserRegistered;

// ... 用户注册逻辑

$user = User::create($request->validated());

event(new UserRegistered($user));

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

如何使用事件订阅者（Event Subscribers）来组织事件监听？

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

创建一个事件订阅者类：

<?php

namespace App\Listeners;

use App\Events\UserRegistered;
use Illuminate\Events\Dispatcher;

class UserEventSubscriber
{
    /**
     * Handle user registered events.
     */
    public function handleUserRegistered(UserRegistered $event) {
        // 发送欢迎邮件
        // ...
    }

    /**
     * Register the listeners for the subscriber.
     *
     * @param  \Illuminate\Events\Dispatcher  $events
     */
    public function subscribe(Dispatcher $events)
    {
        $events->listen(
            UserRegistered::class,
            [UserEventSubscriber::class, 'handleUserRegistered']
        );
    }
}

登录后复制

然后，在 EventServiceProvider 中注册订阅者：

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

登录后复制

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

事件广播（Event Broadcasting）是什么，以及如何使用它来实现实时功能？

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

配置广播驱动: 在 .env 文件中配置广播驱动。常用的驱动有 redis 和 pusher。
```
BROADCAST_DRIVER=redis
```
登录后复制
安装必要的包: 根据你选择的广播驱动，安装相应的 PHP 和 JavaScript 包。

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

0

查看详情

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

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

<?php

namespace App\Events;

use App\Models\Post;
use Illuminate\Broadcasting\Channel;
use Illuminate\Broadcasting\InteractsWithSockets;
use Illuminate\Broadcasting\PresenceChannel;
use Illuminate\Broadcasting\PrivateChannel;
use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;

class PostCreated implements ShouldBroadcast
{
    use Dispatchable, InteractsWithSockets, SerializesModels;

    public $post;

    /**
     * Create a new event instance.
     *
     * @param  \App\Models\Post  $post
     * @return void
     */
    public function __construct(Post $post)
    {
        $this->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)。

在客户端监听事件: 使用 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 事件时，客户端就能收到事件数据，并更新界面。

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

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

确保监听器实现了 ShouldQueue 接口: 如上面的 SendWelcomeEmail 监听器示例所示。
配置队列连接: 在 .env 文件中配置队列连接。常用的连接有 redis、database、beanstalkd 等。
```
QUEUE_CONNECTION=redis
```
登录后复制
运行队列worker: 使用 php artisan queue:work 命令运行队列worker。也可以使用 php artisan queue:listen 命令，该命令会在队列为空时暂停，并在有新任务时自动恢复。
```
php artisan queue:work redis --sleep=3 --tries=3
```
登录后复制
--sleep 选项指定worker在队列为空时休眠的秒数。 --tries 选项指定worker尝试处理任务的最大次数。

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

如何测试事件和监听器？

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

使用 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() 方法断言指定的事件是否被触发。

使用 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() 方法断言指定的任务是否被推送到队列中。

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

以上就是如何在Laravel中使用事件和监听器的详细内容，更多请关注php中文网其它相关文章！